Combines an array of AbortSignals into a single signal that is aborted when any signal is
npm install any-signal
> Combines an array of AbortSignals into a single signal that is aborted when any signal is
Similar to AbortSignal.any
except the returned promise has a .clear method that removes all event
listeners added to passed signals preventing memory leaks.
At the time of writing at least, AbortSignal.any leaks memory in Node.js
and Deno environments:
-
-
``js
import { anySignal } from 'any-signal'
const userController = new AbortController()
// Abort after 1 second
const timeoutSignal = AbortSignal.timeout(1000)
const combinedSignal = anySignal([userController.signal, timeoutSignal])
combinedSignal.addEventListener('abort', () => console.log('Abort!'))
try {
// The user or the timeout can now abort the action
await performSomeAction({ signal: combinedSignal })
} finally {
// Clear will clean up internal event handlers
combinedSignal.clear()
}
`
`console`
$ npm i any-signal
The anySignal function is taken from a comment by jakearchibald
-
Licensed under either of
- Apache 2.0, (LICENSE-APACHE /
- MIT (LICENSE-MIT /
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.