Class CancellablePromise<T>

A cancellable Promise, taking a cancellation function returning executor. Cancellation can be triggered through the cancel method, or by an AbortSignal.

Type parameters

T

Hierarchy

ExtensiblePromise<T>
- CancellablePromise

Index

Constructors

constructor

Accessors

[toStringTag]

Methods

Constructors

constructor

new CancellablePromise<T>(executor: CancellablePromise.Executor<T>, signal?: null | AbortSignal): CancellablePromise<T>

Overrides ExtensiblePromise.constructor
- Defined in classes/CancellablePromise.ts:20
Type parameters
- T
Parameters
- executor: CancellablePromise.Executor<T>
- Optional signal: null | AbortSignal
Returns CancellablePromise<T>

Accessors

[toStringTag]

get [toStringTag](): string

Overrides ExtensiblePromise.__@toStringTag@30
- Defined in classes/CancellablePromise.ts:42
Returns string

Methods

cancel

cancel(): void

- Defined in classes/CancellablePromise.ts:48
Trigger Promise cancellation

Returns void

catch

catch<TF>(onrejected?: null | UnaryFn<unknown, TF | PromiseLike<TF>>): Promise<T | TF>

Inherited from ExtensiblePromise.catch
- Defined in classes/ExtensiblePromise.ts:32
Type parameters
- TF = never
Parameters
- Optional onrejected: null | UnaryFn<unknown, TF | PromiseLike<TF>>
Returns Promise<T | TF>

finally

finally(onfinally?: null | NullaryFn<void>): Promise<T>

Inherited from ExtensiblePromise.finally
- Defined in classes/ExtensiblePromise.ts:40
Parameters
- Optional onfinally: null | NullaryFn<void>
Returns Promise<T>

then

then<TS, TF>(onfulfilled?: null | UnaryFn<T, TS | PromiseLike<TS>>, onrejected?: null | UnaryFn<unknown, TF | PromiseLike<TF>>): Promise<TS | TF>

Inherited from ExtensiblePromise.then
- Defined in classes/ExtensiblePromise.ts:23
Type parameters
- TS = T
- TF = never
Parameters
- Optional onfulfilled: null | UnaryFn<T, TS | PromiseLike<TS>>
- Optional onrejected: null | UnaryFn<unknown, TF | PromiseLike<TF>>
Returns Promise<TS | TF>

Generated using TypeDoc