Package Exports
- timeout-abort-controller
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (timeout-abort-controller) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
timeout-abort-controller
An AbortController that aborts after a specified timeout.
timeout-abort-controller uses retimer internally to help reduce the impact of having numerous timers running.
Install
npm install timeout-abort-controllerUsage
const AbortController = require('abort-controller')
const TimeoutController = require('timeout-abort-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 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-controllerany-signalCombines an array of AbortSignals into a single signal.
LICENSE
MIT © Jacob Heun