feat: add timeout controller

Author: jacobheun

.gitignore

@@ -0,0 +1,61 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# next.js build output
+.next

.travis.yml

@@ -0,0 +1,3 @@
+language: node_js
+node_js:
+  - "stable"

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Jacob Heun
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,61 @@
+# timeout-controller
+
+[![Build Status](https://travis-ci.org/jacobheun/timeout-controller.svg?branch=master)](https://travis-ci.org/jacobheun/timeout-controller) [![dependencies Status](https://david-dm.org/jacobheun/timeout-controller/status.svg)](https://david-dm.org/jacobheun/timeout-controller) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
+
+> An AbortController that aborts after a specified timeout.
+
+`timeout-controller` uses [`retimer`](https://github.com/mcollina/retimer) internally to help reduce the impact of having numerous timers running.
+
+## Install
+
+```
+npm install timeout-controller
+```
+
+## Usage
+
+```js
+const AbortController = require('abort-controller')
+const TimeoutController = require('timeout-controller')
+const anySignal = require('any-signal')
+
+const userController = new AbortController()
+// Aborts after 1 second
+const timeoutController = new TimeoutController(1000)
+
+const combinedSignal = anySignal([userController.signal, timeoutController.signal])
+combinedSignal.addEventListener('abort', () => console.log('Abort!'))
+
+// The user or the timeout can now abort the action
+await performSomeAction({ signal: combinedSignal })
+timeoutController.clear()
+```
+
+## API
+
+### `new TimeoutController(ms)`
+
+Creates an [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController) compliant `TimeoutController`.
+
+#### Parameters
+
+| Name | Type | Description |
+|------|------|-------------|
+| ms | number | The time in milliseconds for when the TimeoutController should abort |
+
+### `timeoutController.clear()`
+
+Clears the internal timer.
+
+### `timeoutController.abort()`
+
+Aborts the controller and clears the internal timeout.
+
+## Related
+
+[`abort-controller`](https://github.com/mysticatea/abort-controller)
+[`any-signal`](https://github.com/jacobheun/any-signal) Combines an array of AbortSignals into a single signal.
+
+## LICENSE
+
+[MIT](LICENSE) © Jacob Heun

index.js

@@ -0,0 +1,31 @@
+const AbortController = require('abort-controller')
+const retimer = require('retimer')
+
+class TimeoutController extends AbortController {
+  /**
+   * @constructor
+   * @param {number} ms milliseconds
+   */
+  constructor (ms) {
+    super()
+    this._timer = retimer(() => this.abort(), ms)
+  }
+
+  /**
+   * Aborts the controller and clears the timer
+   */
+  abort () {
+    this._timer.clear()
+    return super.abort()
+  }
+
+  /**
+   * Clears the timer
+   */
+  clear () {
+    this._timer.clear()
+  }
+}
+
+module.exports = TimeoutController
+module.exports.TimeoutController = TimeoutController