Class AbortablePromise<T>

A Promise that can be rejected by an abort signal.

When a signal is provided, the promise is rejected with signal.reason if the signal is aborted before the executor resolves or rejects the promise.

The executor may return a cleanup callback, which is invoked when the executor calls resolve or reject, or when the signal aborts it.

The resolved argument passed to the cleanup callback is true when the executor called resolve, and false otherwise.

Example

import {AbortablePromise} from "lifecycle-utils";

const controller = new AbortController();

const promise = new AbortablePromise(controller.signal, (resolve, reject) => {
    // register to things here

    return (resolved) => {
        // do cleanup here

        // `resolved` is true if `resolve` was called,
        // and false if `reject` was called or the signal was aborted
    };
});

Type Parameters

Hierarchy

Promise<T>
- AbortablePromise

Index

Constructors

constructor

Methods

all allSettled any race sleep withSignal

Constructors

constructor

new AbortablePromise<T>(
signal: AbortSignal | undefined,
executor: AbortablePromiseExecutor<T>,
): AbortablePromise<T>
Type Parameters
- T
Parameters
- signal: AbortSignal | undefined
- executor: AbortablePromiseExecutor<T>
Returns AbortablePromise<T>
Overrides Promise<T>.constructor
- Defined in AbortablePromise.ts:33

Methods

`Static`all

all<T extends [] | readonly unknown[]>(
signal: AbortSignal | undefined,
values: T,
): Promise<{ -readonly [P in string | number | symbol]: Awaited<T[P]> }>
Like PromiseConstructor.all, with an optional abort signal as the first argument.

When a signal is provided, the returned promise is rejected with signal.reason if the signal is aborted before the returned promise settles.
Type Parameters
- T extends [] | readonly unknown[]
Parameters
- signal: AbortSignal | undefined
- values: T
Returns Promise<{ -readonly [P in string | number | symbol]: Awaited<T[P]> }>
Overrides Promise.all
- Defined in AbortablePromise.ts:118
all<T>(
signal: AbortSignal | undefined,
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
- signal: AbortSignal | undefined
- values: Iterable<T | PromiseLike<T>>
 An array of Promises.
Returns Promise<Awaited<T>[]>
A new Promise.
Overrides Promise.all
- Defined in AbortablePromise.ts:122
all<T extends [] | readonly unknown[]>(
values: T,
): Promise<{ -readonly [P in string | number | symbol]: Awaited<T[P]> }>
Like PromiseConstructor.all, with an optional abort signal as the first argument.

When a signal is provided, the returned promise is rejected with signal.reason if the signal is aborted before the returned promise settles.
Type Parameters
- T extends [] | readonly unknown[]
Parameters
- values: T
Returns Promise<{ -readonly [P in string | number | symbol]: Awaited<T[P]> }>
Overrides Promise.all
- Defined in AbortablePromise.ts:126
all<T>(values: Iterable<T | PromiseLike<T>>): Promise<Awaited<T>[]>
Like PromiseConstructor.all, with an optional abort signal as the first argument.

When a signal is provided, the returned promise is rejected with signal.reason if the signal is aborted before the returned promise settles.
Type Parameters
- T
Parameters
- values: Iterable<T | PromiseLike<T>>
Returns Promise<Awaited<T>[]>
Overrides Promise.all
- Defined in AbortablePromise.ts:127

`Static`allSettled

allSettled<T extends [] | readonly unknown[]>(
 signal: AbortSignal | undefined,
 values: T,
): Promise<
 {
 -readonly [P in string
 | number
 | symbol]: PromiseSettledResult<Awaited<T[P]>>
 },
>
Like PromiseConstructor.allSettled, with an optional abort signal as the first argument.

When a signal is provided, the returned promise is rejected with signal.reason if the signal is aborted before the returned promise settles.
Type Parameters
- T extends [] | readonly unknown[]
Parameters
- signal: AbortSignal | undefined
- values: T
Returns Promise<
 {
 -readonly [P in string
 | number
 | symbol]: PromiseSettledResult<Awaited<T[P]>>
 },
>
Overrides Promise.allSettled
- Defined in AbortablePromise.ts:196
allSettled<T>(
signal: AbortSignal | undefined,
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
- signal: AbortSignal | undefined
- values: Iterable<T | PromiseLike<T>>
 An array of Promises.
Returns Promise<PromiseSettledResult<Awaited<T>>[]>
A new Promise.
Overrides Promise.allSettled
- Defined in AbortablePromise.ts:200
allSettled<T extends [] | readonly unknown[]>(
 values: T,
): Promise<
 {
 -readonly [P in string
 | number
 | symbol]: PromiseSettledResult<Awaited<T[P]>>
 },
>
Like PromiseConstructor.allSettled, with an optional abort signal as the first argument.

When a signal is provided, the returned promise is rejected with signal.reason if the signal is aborted before the returned promise settles.
Type Parameters
- T extends [] | readonly unknown[]
Parameters
- values: T
Returns Promise<
 {
 -readonly [P in string
 | number
 | symbol]: PromiseSettledResult<Awaited<T[P]>>
 },
>
Overrides Promise.allSettled
- Defined in AbortablePromise.ts:204
allSettled<T>(
values: Iterable<T | PromiseLike<T>>,
): Promise<PromiseSettledResult<Awaited<T>>[]>
Like PromiseConstructor.allSettled, with an optional abort signal as the first argument.

When a signal is provided, the returned promise is rejected with signal.reason if the signal is aborted before the returned promise settles.
Type Parameters
- T
Parameters
- values: Iterable<T | PromiseLike<T>>
Returns Promise<PromiseSettledResult<Awaited<T>>[]>
Overrides Promise.allSettled
- Defined in AbortablePromise.ts:207

`Static`any

any<T extends [] | readonly unknown[]>(
signal: AbortSignal | undefined,
values: T,
): Promise<Awaited<T[number]>>
Like PromiseConstructor.any, with an optional abort signal as the first argument.

When a signal is provided, the returned promise is rejected with signal.reason if the signal is aborted before the returned promise settles.
Type Parameters
- T extends [] | readonly unknown[]
Parameters
- signal: AbortSignal | undefined
- values: T
Returns Promise<Awaited<T[number]>>
Overrides Promise.any
- Defined in AbortablePromise.ts:170
any<T>(
signal: AbortSignal | undefined,
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
- signal: AbortSignal | undefined
- values: Iterable<T | PromiseLike<T>>
 An array or iterable of Promises.
Returns Promise<Awaited<T>>
A new Promise.
Overrides Promise.any
- Defined in AbortablePromise.ts:174
any<T extends [] | readonly unknown[]>(values: T): Promise<Awaited<T[number]>>
Like PromiseConstructor.any, with an optional abort signal as the first argument.

When a signal is provided, the returned promise is rejected with signal.reason if the signal is aborted before the returned promise settles.
Type Parameters
- T extends [] | readonly unknown[]
Parameters
- values: T
Returns Promise<Awaited<T[number]>>
Overrides Promise.any
- Defined in AbortablePromise.ts:178
any<T>(values: Iterable<T | PromiseLike<T>>): Promise<Awaited<T>>
Like PromiseConstructor.any, with an optional abort signal as the first argument.

When a signal is provided, the returned promise is rejected with signal.reason if the signal is aborted before the returned promise settles.
Type Parameters
- T
Parameters
- values: Iterable<T | PromiseLike<T>>
Returns Promise<Awaited<T>>
Overrides Promise.any
- Defined in AbortablePromise.ts:179

`Static`race

race<T extends [] | readonly unknown[]>(
signal: AbortSignal | undefined,
values: T,
): Promise<Awaited<T[number]>>
Like PromiseConstructor.race, with an optional abort signal as the first argument.

When a signal is provided, the returned promise is rejected with signal.reason if the signal is aborted before the returned promise settles.
Type Parameters
- T extends [] | readonly unknown[]
Parameters
- signal: AbortSignal | undefined
- values: T
Returns Promise<Awaited<T[number]>>
Overrides Promise.race
- Defined in AbortablePromise.ts:144
race<T>(
signal: AbortSignal | undefined,
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
- signal: AbortSignal | undefined
- values: Iterable<T | PromiseLike<T>>
 An array of Promises.
Returns Promise<Awaited<T>>
A new Promise.
Overrides Promise.race
- Defined in AbortablePromise.ts:148
race<T extends [] | readonly unknown[]>(values: T): Promise<Awaited<T[number]>>
Like PromiseConstructor.race, with an optional abort signal as the first argument.

When a signal is provided, the returned promise is rejected with signal.reason if the signal is aborted before the returned promise settles.
Type Parameters
- T extends [] | readonly unknown[]
Parameters
- values: T
Returns Promise<Awaited<T[number]>>
Overrides Promise.race
- Defined in AbortablePromise.ts:152
race<T>(values: Iterable<T | PromiseLike<T>>): Promise<Awaited<T>>
Like PromiseConstructor.race, with an optional abort signal as the first argument.

When a signal is provided, the returned promise is rejected with signal.reason if the signal is aborted before the returned promise settles.
Type Parameters
- T
Parameters
- values: Iterable<T | PromiseLike<T>>
Returns Promise<Awaited<T>>
Overrides Promise.race
- Defined in AbortablePromise.ts:153

`Static`sleep

sleep(signal: AbortSignal | undefined, duration: number): Promise<void>
Returns a promise that resolves after the given duration.

If a signal is provided and is aborted before the duration has elapsed, then the promise is rejected with signal.reason.
Parameters
- signal: AbortSignal | undefined
- duration: number
 the duration to wait in milliseconds
Returns Promise<void>
- Defined in AbortablePromise.ts:248
sleep(duration: number): Promise<void>
Returns a promise that resolves after the given duration.

If a signal is provided and is aborted before the duration has elapsed, then the promise is rejected with signal.reason.
Parameters
- duration: number
 the duration to wait in milliseconds
Returns Promise<void>
- Defined in AbortablePromise.ts:249

`Static`withSignal

withSignal<T>(signal: AbortSignal | undefined, promise: Promise<T>): Promise<T>
Wraps a promise with an abort signal.

If the signal is aborted before the promise settles, then the returns promise is rejected with signal.reason. Otherwise, it settles in the same way as the original promise.

If no signal is provided then the original promise is returned unchanged.
Type Parameters
- T
Parameters
- signal: AbortSignal | undefined
- promise: Promise<T>
Returns Promise<T>
- Defined in AbortablePromise.ts:228

Class AbortablePromise<T>

Example

Type Parameters

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AbortablePromise<T>

Methods

Staticall

Type Parameters

Parameters

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

Type Parameters

Parameters

Returns Promise<Awaited<T>[]>

Type Parameters

Parameters

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

Type Parameters

Parameters

Returns Promise<Awaited<T>[]>

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>>[]>

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>>

Type Parameters

Parameters

Returns Promise<Awaited<T[number]>>

Type Parameters

Parameters

Returns Promise<Awaited<T>>

Staticrace

Type Parameters

Parameters

Returns Promise<Awaited<T[number]>>

Type Parameters

Parameters

Returns Promise<Awaited<T>>

Type Parameters

Parameters

Returns Promise<Awaited<T[number]>>

Type Parameters

Parameters

Returns Promise<Awaited<T>>

Staticsleep

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

StaticwithSignal

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page

`Static`all

`Static`allSettled

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

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

`Static`any

`Static`race

`Static`sleep

`Static`withSignal