any-signal
![CI](https://img.shields.io/github/actions/workflow/status/jacobheun/any-signal/js-test-and-release.yml?branch=master&style=flat-square)
Combines an array of AbortSignals into a single signal that is aborted when any signal is
Table of contents
Install
$ npm i any-signal
Browser <script>
tag
Loading this module through a script tag will make it's exports available as AnySignal
in the global namespace.
<script src="https://unpkg.com/any-signal/dist/index.min.js"></script>
Usage
import { anySignal } from 'any-signal'
const userController = new AbortController()
const timeoutController = new AbortController()
const combinedSignal = anySignal([userController.signal, timeoutController.signal])
combinedSignal.addEventListener('abort', () => console.log('Abort!'))
const timeoutId = setTimeout(() => timeoutController.abort(), 1000)
await performSomeAction({ signal: combinedSignal })
clearTimeout(timeoutId)
combinedSignal.clear()
API
anySignal(signals)
Parameters
Name | Type | Description |
---|
signals | Array<AbortSignal > | The Signals that will be observed and mapped to the returned Signal |
Returns
Type | Description |
---|
ClearableSignal | A Signal that will be aborted as soon as any one of its parent signals are aborted. Extends AbortSignal with the clear function for cleanup |
The returned ClearableSignal
will only be aborted once, and as soon as one of its parent signals is aborted.
ClearableSignal.clear()
Removes all internal event handlers. This must be called after abort has been called, or the signals have successfully executed, otherwise there is a risk of leaking event handlers.
Acknowledgements
The anySignal function is taken from a comment by jakearchibald
API Docs
License
Licensed under either of
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.