Update code

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

Author: Richienb

README.md

@@ -1,41 +1,38 @@
-# the-module [![Travis CI Build Status](https://img.shields.io/travis/com/Richienb/the-module/master.svg?style=for-the-badge)](https://travis-ci.com/Richienb/the-module)
+# timeout-signal [![Travis CI Build Status](https://img.shields.io/travis/com/Richienb/timeout-signal/master.svg?style=for-the-badge)](https://travis-ci.com/Richienb/timeout-signal)
 
-My awesome module.
+Create an AbortSignal that aborts after a delay.
 
-[![NPM Badge](https://nodei.co/npm/the-module.png)](https://npmjs.com/package/the-module)
+[![NPM Badge](https://nodei.co/npm/timeout-signal.png)](https://npmjs.com/package/timeout-signal)
 
 ## Install
 
 ```sh
-npm install the-module
+npm install timeout-signal
 ```
 
 ## Usage
 
 ```js
-const theModule = require("the-module");
-
-theModule("unicorns");
-//=> 'unicorns & rainbows'
+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
+		}
+	})
 ```
 
 ## API
 
-### theModule(input, options?)
-
-#### input
-
-Type: `string`
-
-Lorem ipsum.
-
-#### options
-
-Type: `object`
+### timeoutSignal(timeout)
 
-##### postfix
+#### timeout
 
-Type: `string`\
-Default: `rainbows`
+Type: `integer`
 
-Lorem ipsum.
+The milliseconds to wait.

index.d.ts

@@ -1,15 +1,24 @@
+import { AbortSignal } from "abort-controller"
+
 /**
-My awesome module.
-@param input Lorem ipsum.
-@param postfix Lorem ipsum.
+Create an AbortSignal that aborts after a delay.
+@param timeout The milliseconds to wait.
 @example
 ```
-const theModule = require("the-module");
+const timeoutSignal = require("timeout-signal");
+const fetch = require("cross-fetch");
 
-theModule("unicorns");
-//=> 'unicorns & rainbows'
+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 theModule(input: string, { postfix }: { postfix?: string }): string
+declare function timeoutSignal(timeout: number): AbortSignal
 
-export = theModule
+export = timeoutSignal

index.js

@@ -1,9 +1,17 @@
 "use strict"
 
-module.exports = (input, { postfix = "rainbows" } = {}) => {
-	if (typeof input !== "string") {
-		throw new TypeError(`Expected a string, got ${typeof input}`)
+const { AbortController } = require("abort-controller")
+
+module.exports = timeout => {
+	if (!Number.isInteger(timeout)) {
+		throw new TypeError(`Expected an integer, got ${typeof timeout}`)
 	}
 
-	return `${input} & ${postfix}`
+	const controller = new AbortController()
+
+	setTimeout(() => {
+		controller.abort()
+	}, timeout)
+
+	return controller.signal
 }

package.json

@@ -1,8 +1,8 @@
 {
-	"name": "the-module",
+	"name": "timeout-signal",
 	"version": "0.0.0",
-	"description": "My awesome module.",
-	"repository": "https://github.com/Richienb/the-module.git",
+	"description": "Create an AbortSignal that aborts after a delay.",
+	"repository": "https://github.com/Richienb/timeout-signal.git",
 	"author": "Richie Bendall <[email protected]>",
 	"license": "MIT",
 	"main": "index.js",
@@ -17,11 +17,18 @@
 		"lint": "xo",
 		"test": "xo && ava"
 	},
-	"keywords": [],
-	"dependencies": {},
+	"keywords": [
+		"timeout",
+		"signal",
+		"abort"
+	],
+	"dependencies": {
+		"abort-controller": "^3.0.0"
+	},
 	"devDependencies": {
 		"ava": "^3.8.1",
 		"eslint-config-richienb": "^0.4.2",
+		"p-event": "^4.1.0",
 		"xo": "^0.30.0"
 	},
 	"resolutions": {

test.js

@@ -1,13 +1,11 @@
 const test = require("ava")
-const theModule = require(".")
+const pEvent = require("p-event")
+const timeoutSignal = require(".")
 
-test("main", t => {
-	t.throws(() => {
-		theModule(123)
-	}, {
-		instanceOf: TypeError,
-		message: "Expected a string, got number"
-	})
+test("main", async t => {
+	const signal = timeoutSignal(0)
 
-	t.is(theModule("unicorns"), "unicorns & rainbows")
+	await pEvent(signal, "abort")
+
+	t.pass()
 })