race-signal

Race a promise against an AbortSignal

Table of contents

• Install
  • Browser <script> tag
• Example
• API Docs
• License
• Contribution

Install

1$ 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.

1<script src="https://unpkg.com/race-signal/dist/index.min.js"></script>

Example

1const { raceSignal } = require('race-signal')
2
3const controller = new AbortController()
4
5const promise = new Promise((resolve, reject) => {
6  setTimeout(() => {
7    resolve('a value')
8  }, 1000)
9})
10
11setTimeout(() => {
12  controller.abort()
13}, 500)
14
15// throws an AbortError
16const resolve = await raceSignal(promise, controller.signal)

API Docs

• https://achingbrain.github.io/race-signal

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.