Class AbortablePromise<T>

Extends Promise constructor to accept not just a (resolve, reject) => void function, but (resolve, reject) => cleanupOnAbortFn and AbortSignal

Helps to write promises that can be cancelled without leaking abort listeners on the signal, and without forgetting to write cleanup logic. See the example below

Semantics:

Adds abort listener on AbortSignal. After the promise settles, the listener is always removed (no leaks)
If abort fires before resolve or reject is called, calls cleanupOnAbort function is called and rejects with AbortedError
If resolve or reject is called before abort is fired, resolves/rejects as a regular promise
cleanupOnAbort is guaranteed to be called at most once, and only if resolve or reject has not been called yet
Race condition is possible where abort fires, than resolve or reject is performed before abort is handled. In such case resolve/reject always wins.
If passed AbortSignal is already aborted, does not call executor at all, and rejects with AbortedError

Example

Promisified setTimeout with cancellation that removes the timer

function sleep(ms: number, signal?: AbortSignal) {
     return new AbortablePromise((resolve, _reject) => {
         const handle = setTimeout(() => resolve(), ms)

         // Called only if `signal` is aborted before `setTimeout` callback 
         // is executed
         return () => clearTimeout(ms)
     }, signal)
}

Type Parameters

Hierarchy

Promise<T>
- AbortablePromise

Index

Constructors

constructor

new AbortablePromise<T>(
    executor: (
        resolve: (value: T) => void,
        reject: (exception: unknown) => void,
    ) => () => void,
    signal?: AbortSignal,
): AbortablePromise<T>
Type Parameters
- T
Parameters
- executor: (
  resolve: (value: T) => void,
  reject: (exception: unknown) => void,
  ) => () => void
- Optionalsignal: AbortSignal
Returns AbortablePromise<T>
Overrides Promise<T>.constructor
- Defined in src/AbortablePromise.ts:51

Properties

`Readonly`[toStringTag]

"[toStringTag]": string

`Static` `Readonly`[species]

"[species]": PromiseConstructor

Methods

catch

catch<TResult = never>(
onrejected?: null | ((reason: any) => TResult | PromiseLike<TResult>),
): Promise<T | TResult>
Attaches a callback for only the rejection of the Promise.
Type Parameters
- TResult = never
Parameters
- Optionalonrejected: null | ((reason: any) => TResult | PromiseLike<TResult>)
  The callback to execute when the Promise is rejected.
Returns Promise<T | TResult>
A Promise for the completion of the callback.
Inherited from Promise.catch
- Defined in node_modules/.pnpm/typescript@5.9.2/node_modules/typescript/lib/lib.es5.d.ts:1564

finally

finally(onfinally?: null | (() => void)): Promise<T>
Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.
Parameters
- Optionalonfinally: null | (() => void)
  The callback to execute when the Promise is settled (fulfilled or rejected).
Returns Promise<T>
A Promise for the completion of the callback.
Inherited from Promise.finally
- Defined in node_modules/.pnpm/typescript@5.9.2/node_modules/typescript/lib/lib.es2018.promise.d.ts:29

then

then<TResult1 = T, TResult2 = never>(
onfulfilled?: null | ((value: T) => TResult1 | PromiseLike<TResult1>),
onrejected?: null | ((reason: any) => TResult2 | PromiseLike<TResult2>),
): Promise<TResult1 | TResult2>
Attaches callbacks for the resolution and/or rejection of the Promise.
Type Parameters
- TResult1 = T
- TResult2 = never
Parameters
- Optionalonfulfilled: null | ((value: T) => TResult1 | PromiseLike<TResult1>)
  The callback to execute when the Promise is resolved.
- Optionalonrejected: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)
  The callback to execute when the Promise is rejected.
Returns Promise<TResult1 | TResult2>
A Promise for the completion of which ever callback is executed.
Inherited from Promise.then
- Defined in node_modules/.pnpm/typescript@5.9.2/node_modules/typescript/lib/lib.es5.d.ts:1557

`Static`all

all<T>(values: Iterable<T | PromiseLike<T>>): Promise<Awaited<T>[]>
Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.
Type Parameters
- T
Parameters
- values: Iterable<T | PromiseLike<T>>
  An iterable of Promises.
Returns Promise<Awaited<T>[]>
A new Promise.
Inherited from Promise.all
- Defined in node_modules/.pnpm/typescript@5.9.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:255
all<T extends [] | readonly unknown[]>(
values: T,
): Promise<{ -readonly [P in string | number | symbol]: Awaited<T[P<P>]> }>
Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.
Type Parameters
- T extends [] | readonly unknown[]
Parameters
- values: T
  An array of Promises.
Returns Promise<{ -readonly [P in string | number | symbol]: Awaited<T[P<P>]> }>
A new Promise.
Inherited from Promise.all
- Defined in node_modules/.pnpm/typescript@5.9.2/node_modules/typescript/lib/lib.es2015.promise.d.ts:39

`Static`allSettled

allSettled<T extends [] | readonly unknown[]>(
    values: T,
): Promise<
    {
        -readonly [P in string
        | number
        | symbol]: PromiseSettledResult<Awaited<T[P<P>]>>
    },
>
Creates a Promise that is resolved with an array of results when all of the provided Promises resolve or reject.
Type Parameters
- T extends [] | readonly unknown[]
Parameters
- values: T
  An array of Promises.
Returns Promise<
    {
        -readonly [P in string
        | number
        | symbol]: PromiseSettledResult<Awaited<T[P<P>]>>
    },
>
A new Promise.
Inherited from Promise.allSettled
- Defined in node_modules/.pnpm/typescript@5.9.2/node_modules/typescript/lib/lib.es2020.promise.d.ts:38
allSettled<T>(
values: Iterable<T | PromiseLike<T>>,
): Promise<PromiseSettledResult<Awaited<T>>[]>
Creates a Promise that is resolved with an array of results when all of the provided Promises resolve or reject.
Type Parameters
- T
Parameters
- values: Iterable<T | PromiseLike<T>>
  An array of Promises.
Returns Promise<PromiseSettledResult<Awaited<T>>[]>
A new Promise.
Inherited from Promise.allSettled
- Defined in node_modules/.pnpm/typescript@5.9.2/node_modules/typescript/lib/lib.es2020.promise.d.ts:46

`Static`any

any<T extends [] | readonly unknown[]>(values: T): Promise<Awaited<T[number]>>
The any function returns a promise that is fulfilled by the first given promise to be fulfilled, or rejected with an AggregateError containing an array of rejection reasons if all of the given promises are rejected. It resolves all elements of the passed iterable to promises as it runs this algorithm.
Type Parameters
- T extends [] | readonly unknown[]
Parameters
- values: T
  An array or iterable of Promises.
Returns Promise<Awaited<T[number]>>
A new Promise.
Inherited from Promise.any
- Defined in node_modules/.pnpm/typescript@5.9.2/node_modules/typescript/lib/lib.es2021.promise.d.ts:40
any<T>(values: Iterable<T | PromiseLike<T>>): Promise<Awaited<T>>
The any function returns a promise that is fulfilled by the first given promise to be fulfilled, or rejected with an AggregateError containing an array of rejection reasons if all of the given promises are rejected. It resolves all elements of the passed iterable to promises as it runs this algorithm.
Type Parameters
- T
Parameters
- values: Iterable<T | PromiseLike<T>>
  An array or iterable of Promises.
Returns Promise<Awaited<T>>
A new Promise.
Inherited from Promise.any
- Defined in node_modules/.pnpm/typescript@5.9.2/node_modules/typescript/lib/lib.es2021.promise.d.ts:47

`Static`race

race<T>(values: Iterable<T | PromiseLike<T>>): Promise<Awaited<T>>
Creates a Promise that is resolved or rejected when any of the provided Promises are resolved or rejected.
Type Parameters
- T
Parameters
- values: Iterable<T | PromiseLike<T>>
  An iterable of Promises.
Returns Promise<Awaited<T>>
A new Promise.
Inherited from Promise.race
- Defined in node_modules/.pnpm/typescript@5.9.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:263
race<T extends [] | readonly unknown[]>(values: T): Promise<Awaited<T[number]>>
Creates a Promise that is resolved or rejected when any of the provided Promises are resolved or rejected.
Type Parameters
- T extends [] | readonly unknown[]
Parameters
- values: T
  An array of Promises.
Returns Promise<Awaited<T[number]>>
A new Promise.
Inherited from Promise.race
- Defined in node_modules/.pnpm/typescript@5.9.2/node_modules/typescript/lib/lib.es2015.promise.d.ts:50

`Static`reject

reject<T = never>(reason?: any): Promise<T>
Creates a new rejected promise for the provided reason.
Type Parameters
- T = never
Parameters
- Optionalreason: any
  The reason the promise was rejected.
Returns Promise<T>
A new rejected Promise.
Inherited from Promise.reject
- Defined in node_modules/.pnpm/typescript@5.9.2/node_modules/typescript/lib/lib.es2015.promise.d.ts:60

`Static`resolve

resolve(): Promise<void>
Creates a new resolved promise.

Returns Promise<void>
A resolved promise.
Inherited from Promise.resolve
- Defined in node_modules/.pnpm/typescript@5.9.2/node_modules/typescript/lib/lib.es2015.promise.d.ts:66
resolve<T>(value: T): Promise<Awaited<T>>
Creates a new resolved promise for the provided value.
Type Parameters
- T
Parameters
- value: T
  A promise.
Returns Promise<Awaited<T>>
A promise whose internal state matches the provided promise.
Inherited from Promise.resolve
- Defined in node_modules/.pnpm/typescript@5.9.2/node_modules/typescript/lib/lib.es2015.promise.d.ts:72
resolve<T>(value: T | PromiseLike<T>): Promise<Awaited<T>>
Creates a new resolved promise for the provided value.
Type Parameters
- T
Parameters
- value: T | PromiseLike<T>
  A promise.
Returns Promise<Awaited<T>>
A promise whose internal state matches the provided promise.
Inherited from Promise.resolve
- Defined in node_modules/.pnpm/typescript@5.9.2/node_modules/typescript/lib/lib.es2015.promise.d.ts:78

Class AbortablePromise<T>

Example

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AbortablePromise<T>

Properties

Readonly[toStringTag]

Static Readonly[species]

Methods

catch

Type Parameters

Parameters

Returns Promise<T | TResult>

finally

Parameters

Returns Promise<T>

then

Type Parameters

Parameters

Returns Promise<TResult1 | TResult2>

Staticall

Type Parameters

Parameters

Returns Promise<Awaited<T>[]>

Type Parameters

Parameters

Returns Promise<{ -readonly [P in string | number | symbol]: Awaited<T[P<P>]> }>

StaticallSettled

Type Parameters

Parameters

Returns Promise< { -readonly [P in string | number | symbol]: PromiseSettledResult<Awaited<T[P<P>]>> },>

Type Parameters

Parameters

Returns Promise<PromiseSettledResult<Awaited<T>>[]>

Staticany

Type Parameters

Parameters

Returns Promise<Awaited<T[number]>>

Type Parameters

Parameters

Returns Promise<Awaited<T>>

Staticrace

Type Parameters

Parameters

Returns Promise<Awaited<T>>

Type Parameters

Parameters

Returns Promise<Awaited<T[number]>>

Staticreject

Type Parameters

Parameters

Returns Promise<T>

Staticresolve

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<Awaited<T>>

Type Parameters

Parameters

Returns Promise<Awaited<T>>

Settings

On This Page

`Readonly`[toStringTag]

`Static` `Readonly`[species]

`Static`all

`Static`allSettled

Returns Promise<
{
-readonly [P in string
| number
| symbol]: PromiseSettledResult<Awaited<T[P<P>]>>
},
>

`Static`any

`Static`race

`Static`reject

`Static`resolve