Class AbortablePromise<A, E>

A promise that can be aborted using an AbortSignal.

Type Parameters

A
The type of the resolved value of this promise.
E = Error
The type of the rejected value of this promise. Defaults to Error, and it's usually best to keep it that way.

Hierarchy

Promise<A>
- AbortablePromise

Implements

Disposable

Index

Properties

`Readonly`[toStringTag]

"[toStringTag]": string

`Static` `Readonly`[species]

"[species]": PromiseConstructor

Accessors

aborted

get aborted(): boolean
True if the promise has been aborted.

Returns boolean
- Defined in src/async/abortable-promise.ts:234

signal

get signal(): AbortSignal
The AbortSignal attached to this promise.

Returns AbortSignal
- Defined in src/async/abortable-promise.ts:224

Methods

[dispose]

"[dispose]"(): void
Returns void
Implementation of Disposable.[dispose]
- Defined in src/async/abortable-promise.ts:248

abort

abort(reason?: string): void
Abort this promise.
Parameters
- Optionalreason: string
Returns void
- Defined in src/async/abortable-promise.ts:215

catch

catch<TResult = never>(
onrejected?: ((reason: E) => TResult | PromiseLike<TResult>) | null,
): AbortablePromise<A | TResult, E>
Attaches a callback for only the rejection of the Promise.
Type Parameters
- TResult = never
Parameters
- Optionalonrejected: ((reason: E) => TResult | PromiseLike<TResult>) | null
 The callback to execute when the Promise is rejected.
Returns AbortablePromise<A | TResult, E>
A Promise for the completion of the callback.
Overrides Promise.catch
- Defined in src/async/abortable-promise.ts:265

finally

finally(onfinally?: (() => void) | null): AbortablePromise<A, E>
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: (() => void) | null
 The callback to execute when the Promise is settled (fulfilled or rejected).
Returns AbortablePromise<A, E>
A Promise for the completion of the callback.
Overrides Promise.finally
- Defined in src/async/abortable-promise.ts:274

result

result(): AbortablePromise<Result<A, E>, never>
Convert this promise into a promise that returns a Result.

If the promise throws, it will return an Err instead of rejecting.

Returns AbortablePromise<Result<A, E>, never>
- Defined in src/async/abortable-promise.ts:244

then

then<TResult1 = A, TResult2 = never>(
onfulfilled?: ((value: A) => TResult1 | PromiseLike<TResult1>) | null,
onrejected?: ((reason: E) => TResult2 | PromiseLike<TResult2>) | null,
): AbortablePromise<TResult1 | TResult2, E>
Attaches callbacks for the resolution and/or rejection of the Promise.
Type Parameters
- TResult1 = A
- TResult2 = never
Parameters
- Optionalonfulfilled: ((value: A) => TResult1 | PromiseLike<TResult1>) | null
 The callback to execute when the Promise is resolved.
- Optionalonrejected: ((reason: E) => TResult2 | PromiseLike<TResult2>) | null
 The callback to execute when the Promise is rejected.
Returns AbortablePromise<TResult1 | TResult2, E>
A Promise for the completion of which ever callback is executed.
Overrides Promise.then
- Defined in src/async/abortable-promise.ts:252

`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/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]> }>
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]> }>
A new Promise.
Inherited from Promise.all
- Defined in node_modules/typescript/lib/lib.es2015.promise.d.ts:39

`Static`allAbortable

allAbortable<A extends readonly AbortablePromise<any, Error>[]>(
 executor: (signal: AbortSignal) => A,
 abort?: AbortSignal,
): AbortablePromise<
 { -readonly [P in string
 | number
 | symbol]: Awaited<A[P]> },
>
Type Parameters
- A extends readonly AbortablePromise<any, Error>[]
Parameters
- executor: (signal: AbortSignal) => A
- Optionalabort: AbortSignal
Returns AbortablePromise<
 { -readonly [P in string
 | number
 | symbol]: Awaited<A[P]> },
>
- Defined in src/async/abortable-promise.ts:91

`Static`allSettled

allSettled<T extends [] | readonly unknown[]>(
 values: T,
): Promise<
 {
 -readonly [P in string
 | number
 | symbol]: PromiseSettledResult<Awaited<T[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]>>
 },
>
A new Promise.
Inherited from Promise.allSettled
- Defined in 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/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/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/typescript/lib/lib.es2021.promise.d.ts:47

`Static`from

from<A, E = Error>(
promise: PromiseLike<A>,
abort?: AbortSignal,
): AbortablePromise<A, E>
Wrap any PromiseLike in an AbortablePromise.

This will make the promise resolution abortable, but it has no way of aborting the promise while it's running.
Type Parameters
- A
- E = Error
Parameters
- promise: PromiseLike<A>
- Optionalabort: AbortSignal
Returns AbortablePromise<A, E>
- Defined in src/async/abortable-promise.ts:68

`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/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/typescript/lib/lib.es2015.promise.d.ts:50

`Static`raceAbortable

raceAbortable<A extends AbortablePromise<any, Error>>(
executor: (abort: AbortSignal) => readonly A[],
abort?: AbortSignal,
): AbortablePromise<A extends PromiseLike<T> ? T : never>
Type Parameters
- A extends AbortablePromise<any, Error>
Parameters
- executor: (abort: AbortSignal) => readonly A[]
- Optionalabort: AbortSignal
Returns AbortablePromise<A extends PromiseLike<T> ? T : never>
- Defined in src/async/abortable-promise.ts:126

`Static`reject

reject<A = never, E = Error>(reason?: any): AbortablePromise<A, E>
Creates a new rejected promise for the provided reason.
Type Parameters
- A = never
- E = Error
Parameters
- Optionalreason: any
 The reason the promise was rejected.
Returns AbortablePromise<A, E>
A new rejected Promise.
Overrides Promise.reject
- Defined in src/async/abortable-promise.ts:86

`Static`resolve

resolve<A, E = Error>(
value?: A | PromiseLike<A>,
): AbortablePromise<Awaited<A>, E>
Creates a new resolved promise.
Type Parameters
- A
- E = Error
Parameters
- Optionalvalue: A | PromiseLike<A>
Returns AbortablePromise<Awaited<A>, E>
A resolved promise.
Overrides Promise.resolve
- Defined in src/async/abortable-promise.ts:80

`Static`run

run<A, E = Error>(
executor: AbortableExecutor<A, E>,
abort?: AbortSignal,
): AbortablePromise<A, E>
Create a new AbortablePromise using an AbortableExecutor function and an optional AbortSignal.
Type Parameters
- A
- E = Error
Parameters
- executor: AbortableExecutor<A, E>
 A function which receives two callbacks resolve and reject used to resolve or reject the promise, and an AbortSignal which should be passed on to any abortable jobs triggered by the function.
- Optionalabort: AbortSignal
 An optional AbortSignal which can be used to abort the promise externally instead of calling its abort() method.
Returns AbortablePromise<A, E>
- Defined in src/async/abortable-promise.ts:55

`Static`try

try<T, U extends unknown[]>(
callbackFn: (...args: U) => T | PromiseLike<T>,
...args: U,
): Promise<Awaited<T>>
Takes a callback of any kind (returns or throws, synchronously or asynchronously) and wraps its result in a Promise.
Type Parameters
- T
- U extends unknown[]
Parameters
- callbackFn: (...args: U) => T | PromiseLike<T>
 A function that is called synchronously. It can do anything: either return a value, throw an error, or return a promise.
- ...args: U
 Additional arguments, that will be passed to the callback.
Returns Promise<Awaited<T>>
A Promise that is:
- Already fulfilled, if the callback synchronously returns a value.
- Already rejected, if the callback synchronously throws an error.
- Asynchronously fulfilled or rejected, if the callback returns a promise.
Inherited from Promise.try
- Defined in node_modules/typescript/lib/lib.esnext.promise.d.ts:33

`Static`withResolvers

withResolvers<T>(): PromiseWithResolvers<T>
Creates a new Promise and returns it in an object, along with its resolve and reject functions.
Type Parameters
- T
Returns PromiseWithResolvers<T>
An object with the properties promise, resolve, and reject.
```
const { promise, resolve, reject } = Promise.withResolvers<T>();
```
Inherited from Promise.withResolvers
- Defined in node_modules/typescript/lib/lib.es2024.promise.d.ts:34

Class AbortablePromise<A, E>

Type Parameters

Hierarchy

Implements

Index

Properties

Accessors

Methods

Properties

Readonly[toStringTag]

Static Readonly[species]

Accessors

aborted

Returns boolean

signal

Returns AbortSignal

Methods

[dispose]

Returns void

abort

Parameters

Returns void

catch

Type Parameters

Parameters

Returns AbortablePromise<A | TResult, E>

finally

Parameters

Returns AbortablePromise<A, E>

result

Returns AbortablePromise<Result<A, E>, never>

then

Type Parameters

Parameters

Returns AbortablePromise<TResult1 | TResult2, E>

Staticall

Type Parameters

Parameters

Returns Promise<Awaited<T>[]>

Type Parameters

Parameters

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

StaticallAbortable

Type Parameters

Parameters

Returns AbortablePromise< { -readonly [P in string | number | symbol]: Awaited<A[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>>

Staticfrom

Type Parameters

Parameters

Returns AbortablePromise<A, E>

Staticrace

Type Parameters

Parameters

Returns Promise<Awaited<T>>

Type Parameters

Parameters

Returns Promise<Awaited<T[number]>>

StaticraceAbortable

Type Parameters

Parameters

Returns AbortablePromise<A extends PromiseLike<T> ? T : never>

Staticreject

Type Parameters

Parameters

Returns AbortablePromise<A, E>

Staticresolve

`Readonly`[toStringTag]

`Static` `Readonly`[species]

`Static`all

`Static`allAbortable

Returns AbortablePromise<
{ -readonly [P in string
| number
| symbol]: Awaited<A[P<P>]> },
>

`Static`allSettled

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

`Static`any

`Static`from

`Static`race

`Static`raceAbortable

`Static`reject

`Static`resolve

`Static`run

`Static`try

`Static`withResolvers