0d073fa89e
- Add GETTING_STARTED.md with quick start guide and development modes - Add INSTALL.sh automated installation script - Add INSTALLATION_CHECKLIST.md, INSTALLATION_SUCCESS.md, and INSTALLATION_SUMMARY.md - Add QUICK_REFERENCE.md for common commands - Add SETUP_GUIDE.md with detailed setup instructions - Update README.md with improved project overview - Add did-wallet app dependencies and node_modules
69 lines
1.7 KiB
TypeScript
69 lines
1.7 KiB
TypeScript
/**
|
|
* @packageDocumentation
|
|
*
|
|
* Pass a promise and an abort signal and await the result.
|
|
*
|
|
* @example Basic usage
|
|
*
|
|
* ```ts
|
|
* import { raceSignal } from '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)
|
|
* ```
|
|
*
|
|
* @example Overriding errors
|
|
*
|
|
* By default the thrown error is the `.reason` property of the signal but it's
|
|
* possible to override this behaviour with the `translateError` option:
|
|
*
|
|
* ```ts
|
|
* import { raceSignal } from 'race-signal'
|
|
*
|
|
* const controller = new AbortController()
|
|
*
|
|
* const promise = new Promise((resolve, reject) => {
|
|
* setTimeout(() => {
|
|
* resolve('a value')
|
|
* }, 1000)
|
|
* })
|
|
*
|
|
* setTimeout(() => {
|
|
* controller.abort()
|
|
* }, 500)
|
|
*
|
|
* // throws `Error('Oh no!')`
|
|
* const resolve = await raceSignal(promise, controller.signal, {
|
|
* translateError: (signal) => {
|
|
* // use `signal`, or don't
|
|
* return new Error('Oh no!')
|
|
* }
|
|
* })
|
|
* ```
|
|
*/
|
|
export interface RaceSignalOptions {
|
|
/**
|
|
* By default the rejection reason will be taken from the `.reason` field of
|
|
* the aborted signal.
|
|
*
|
|
* Passing a function here allows overriding the default error.
|
|
*/
|
|
translateError?(signal: AbortSignal): Error;
|
|
}
|
|
/**
|
|
* Race a promise against an abort signal
|
|
*/
|
|
export declare function raceSignal<T>(promise: Promise<T>, signal?: AbortSignal, opts?: RaceSignalOptions): Promise<T>;
|
|
//# sourceMappingURL=index.d.ts.map
|