Add .clear() method

Fixes: #1
Signed-off-by: Richie Bendall <[email protected]>

Author: Richienb

README.md

@@ -36,3 +36,31 @@ fetch("https://www.google.com", { signal: timeoutSignal(5000) })
 Type: `integer`
 
 The milliseconds to wait.
+
+### timeoutSignal.clear(signal)
+
+Clear the timeout associated with a signal.
+
+#### signal
+
+Type: Return value from `timeoutSignal()`
+
+The signal to clear the timeout for.
+
+```js
+const timeoutSignal = require("timeout-signal");
+const fetch = require("cross-fetch");
+
+const signal = timeoutSignal(5000)
+
+fetch("https://www.google.com", { signal })
+	.then(response => {
+		timeoutSignal.clear(signal)
+		// Handle response
+	})
+	.catch(error => {
+		if (error.message === "The user aborted a request.") {
+			// Handle abortion
+		}
+	})
+```

index.d.ts

@@ -1,24 +1,50 @@
 import { AbortSignal } from "abort-controller"
 
-/**
-Create an AbortSignal that aborts after a delay.
-@param timeout The milliseconds to wait.
-@example
-```
-const timeoutSignal = require("timeout-signal");
-const fetch = require("cross-fetch");
+declare const timeoutSignal: {
+	/**
+	Create an AbortSignal that aborts after a delay.
+	@param timeout The milliseconds to wait.
+	@example
+	```
+	const timeoutSignal = require("timeout-signal");
+	const fetch = require("cross-fetch");
 
-fetch("https://www.google.com", { signal: timeoutSignal(5000) })
-	.then(response => {
-		// Handle response
-	})
-	.catch(error => {
-		if (error.message === "The user aborted a request.") {
-			// Handle abortion
-		}
-	})
-```
-*/
-declare function timeoutSignal(timeout: number): AbortSignal
+	fetch("https://www.google.com", { signal: timeoutSignal(5000) })
+		.then(response => {
+			// Handle response
+		})
+		.catch(error => {
+			if (error.message === "The user aborted a request.") {
+				// Handle abortion
+			}
+		})
+	```
+	*/
+	(timeout: number): AbortSignal
+
+	/**
+	The signal to clear the timeout for.
+	@param signal The signal to clear the timeout for.
+	@example
+	```
+	const timeoutSignal = require("timeout-signal");
+	const fetch = require("cross-fetch");
+
+	const signal = timeoutSignal(5000)
+
+	fetch("https://www.google.com", { signal })
+		.then(response => {
+			timeoutSignal.clear(signal)
+			// Handle response
+		})
+		.catch(error => {
+			if (error.message === "The user aborted a request.") {
+				// Handle abortion
+			}
+		})
+	```
+	*/
+	clear(signal: AbortSignal): void
+}
 
 export = timeoutSignal

index.js

@@ -2,16 +2,24 @@
 
 const { AbortController } = require("abort-controller")
 
+const signalMap = new WeakMap()
+
 module.exports = timeout => {
 	if (!Number.isInteger(timeout)) {
 		throw new TypeError(`Expected an integer, got ${typeof timeout}`)
 	}
 
 	const controller = new AbortController()
 
-	setTimeout(() => {
+	const timeoutId = setTimeout(() => {
 		controller.abort()
 	}, timeout)
 
+	signalMap.set(controller.signal, timeoutId)
+
 	return controller.signal
 }
+
+module.exports.clear = signal => {
+	clearTimeout(signalMap.get(signal))
+}

package.json

@@ -27,6 +27,7 @@
 	},
 	"devDependencies": {
 		"ava": "^3.8.1",
+		"delay": "^4.4.0",
 		"eslint-config-richienb": "^0.4.2",
 		"p-event": "^4.1.0",
 		"xo": "^0.30.0"

test.js

@@ -1,5 +1,6 @@
 const test = require("ava")
 const pEvent = require("p-event")
+const delay = require("delay")
 const timeoutSignal = require(".")
 
 test("main", async t => {
@@ -9,3 +10,19 @@ test("main", async t => {
 
 	t.pass()
 })
+
+test(".clear()", async t => {
+	const signal = timeoutSignal(250)
+
+	timeoutSignal.clear(signal)
+
+	let hasAborted = false
+
+	signal.addEventListener("abort", () => {
+		hasAborted = true
+	})
+
+	await delay(500)
+
+	t.false(hasAborted)
+})