achingbrainrace-signal
Race a promise against an AbortSignal
Table of contents
Install
$ npm i race-signal
Browser <script> tag
Loading this module through a script tag will make it's exports available as RaceSignal in the global namespace.
<script src="https://unpkg.com/race-signal/dist/index.min.js"></script>
Example
const { raceSignal } = require('race-signal')
const controller = new AbortController()
const promise = new Promise((resolve, reject) => {
setTimeout(() => {
resolve('a value')
}, 1000)
})
setTimeout(() => {
controller.abort()
}, 500)
// throws an AbortError
const resolve = await raceSignal(promise, controller.signal)
API Docs
License
Licensed under either of
- Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
- MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)
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.