Class CancellablePromise<T>

A promise with a cancel method.

If canceled, the CancellablePromise will reject with a [[Cancellation]] object.

Type Parameters

T

what the CancellablePromise resolves to

Hierarchy

CancellablePromise

Index

Constructors

constructor

new CancellablePromise<T>(promise: PromiseLike<T>, cancel: ((reason?: string) => void)): CancellablePromise<T>
Type Parameters
- T
Parameters
- promise: PromiseLike<T>
  
  a normal promise or thenable
- cancel: ((reason?: string) => void)
  
  a function that cancels promise. Calling cancel after promise has resolved must be a no-op.
  - - (reason?: string): void
    - Parameters
      
      Optional reason: string
      
      Returns void
Returns CancellablePromise<T>
- Defined in src/CancellablePromise.ts:54

Properties

`Readonly` cancel

cancel: ((reason?: string) => void)

Type declaration

- (reason?: string): void
- Cancel the CancellablePromise.
  Parameters
  - Optional reason: string
  Returns void

`Protected` `Readonly` promise

promise: Promise<T>

As a consumer of the library, you shouldn't ever need to access CancellablePromise.promise directly.

If you are subclassing CancellablePromise for some reason, you can access this property.

Accessors

[toStringTag]

get [toStringTag](): string
This is necessary to make CancellablePromise assignable to Promise.

Returns string
- Defined in src/CancellablePromise.ts:155

Methods

catch

catch<TResult>(onRejected?: null | ((reason: any) => TResult | PromiseLike<TResult>)): CancellablePromise<T | TResult>
Analogous to Promise.catch.
Type Parameters
- TResult = never
Parameters
- Optional onRejected: null | ((reason: any) => TResult | PromiseLike<TResult>)
Returns CancellablePromise<T | TResult>
- Defined in src/CancellablePromise.ts:129

finally

finally(onFinally?: null | (() => void)): CancellablePromise<T>
Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.

Returns
A Promise for the completion of the callback.
Parameters
- Optional onFinally: null | (() => void)
  
  The callback to execute when the Promise is settled (fulfilled or rejected).
Returns CancellablePromise<T>
- Defined in src/CancellablePromise.ts:147

then

then<TResult1, TResult2>(onFulfilled?: null | ((value: T) => TResult1 | PromiseLike<TResult1>), onRejected?: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)): CancellablePromise<TResult1 | TResult2>
Analogous to Promise.then.

onFulfilled on onRejected can return a value, a normal promise, or a CancellablePromise. So you can make a chain a CancellablePromises like this:
```
const overallPromise = cancellableAsyncFunction1()
    .then(cancellableAsyncFunction2)
    .then(cancellableAsyncFunction3)
    .then(cancellableAsyncFunction4)
```
Then if you call overallPromise.cancel, cancel is called on all CancellablePromises in the chain! In practice, this means that whichever async operation is in progress will be canceled.

Returns
a new CancellablePromise
Type Parameters
- TResult1 = T
- TResult2 = never
Parameters
- Optional onFulfilled: null | ((value: T) => TResult1 | PromiseLike<TResult1>)
- Optional onRejected: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)
Returns CancellablePromise<TResult1 | TResult2>
- Defined in src/CancellablePromise.ts:79

`Static` all

all<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>(values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>, T8 | PromiseLike<T8>, T9 | PromiseLike<T9>, T10 | PromiseLike<T10>]): CancellablePromise<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]>
Analogous to Promise.all.

Returns
a [[CancellablePromise]], which, if canceled, will cancel each of the promises passed in to CancellablePromise.all.
Type Parameters
- T1
- T2
- T3
- T4
- T5
- T6
- T7
- T8
- T9
- T10
Parameters
- values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>, T8 | PromiseLike<T8>, T9 | PromiseLike<T9>, T10 | PromiseLike<T10>]
  
  an array that may contain CancellablePromises, promises, thenables, and resolved values
Returns CancellablePromise<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]>
- Defined in src/CancellablePromise.ts:194
all<T1, T2, T3, T4, T5, T6, T7, T8, T9>(values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>, T8 | PromiseLike<T8>, T9 | PromiseLike<T9>]): CancellablePromise<[T1, T2, T3, T4, T5, T6, T7, T8, T9]>
Analogous to Promise.all.

Returns
a [[CancellablePromise]], which, if canceled, will cancel each of the promises passed in to CancellablePromise.all.
Type Parameters
- T1
- T2
- T3
- T4
- T5
- T6
- T7
- T8
- T9
Parameters
- values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>, T8 | PromiseLike<T8>, T9 | PromiseLike<T9>]
  
  an array that may contain CancellablePromises, promises, thenables, and resolved values
Returns CancellablePromise<[T1, T2, T3, T4, T5, T6, T7, T8, T9]>
- Defined in src/CancellablePromise.ts:217
all<T1, T2, T3, T4, T5, T6, T7, T8>(values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>, T8 | PromiseLike<T8>]): CancellablePromise<[T1, T2, T3, T4, T5, T6, T7, T8]>
Analogous to Promise.all.

Returns
a [[CancellablePromise]], which, if canceled, will cancel each of the promises passed in to CancellablePromise.all.
Type Parameters
- T1
- T2
- T3
- T4
- T5
- T6
- T7
- T8
Parameters
- values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>, T8 | PromiseLike<T8>]
  
  an array that may contain CancellablePromises, promises, thenables, and resolved values
Returns CancellablePromise<[T1, T2, T3, T4, T5, T6, T7, T8]>
- Defined in src/CancellablePromise.ts:239
all<T1, T2, T3, T4, T5, T6, T7>(values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>]): CancellablePromise<[T1, T2, T3, T4, T5, T6, T7]>
Analogous to Promise.all.

Returns
a [[CancellablePromise]], which, if canceled, will cancel each of the promises passed in to CancellablePromise.all.
Type Parameters
- T1
- T2
- T3
- T4
- T5
- T6
- T7
Parameters
- values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>]
  
  an array that may contain CancellablePromises, promises, thenables, and resolved values
Returns CancellablePromise<[T1, T2, T3, T4, T5, T6, T7]>
- Defined in src/CancellablePromise.ts:260
all<T1, T2, T3, T4, T5, T6>(values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>]): CancellablePromise<[T1, T2, T3, T4, T5, T6]>
Analogous to Promise.all.

Returns
a [[CancellablePromise]], which, if canceled, will cancel each of the promises passed in to CancellablePromise.all.
Type Parameters
- T1
- T2
- T3
- T4
- T5
- T6
Parameters
- values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>]
  
  an array that may contain CancellablePromises, promises, thenables, and resolved values
Returns CancellablePromise<[T1, T2, T3, T4, T5, T6]>
- Defined in src/CancellablePromise.ts:280
all<T1, T2, T3, T4, T5>(values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>]): CancellablePromise<[T1, T2, T3, T4, T5]>
Analogous to Promise.all.

Returns
a [[CancellablePromise]], which, if canceled, will cancel each of the promises passed in to CancellablePromise.all.
Type Parameters
- T1
- T2
- T3
- T4
- T5
Parameters
- values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>]
  
  an array that may contain CancellablePromises, promises, thenables, and resolved values
Returns CancellablePromise<[T1, T2, T3, T4, T5]>
- Defined in src/CancellablePromise.ts:299
all<T1, T2, T3, T4>(values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>]): CancellablePromise<[T1, T2, T3, T4]>
Analogous to Promise.all.

Returns
a [[CancellablePromise]], which, if canceled, will cancel each of the promises passed in to CancellablePromise.all.
Type Parameters
- T1
- T2
- T3
- T4
Parameters
- values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>]
  
  an array that may contain CancellablePromises, promises, thenables, and resolved values
Returns CancellablePromise<[T1, T2, T3, T4]>
- Defined in src/CancellablePromise.ts:317
all<T1, T2, T3>(values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>]): CancellablePromise<[T1, T2, T3]>
Analogous to Promise.all.

Returns
a [[CancellablePromise]], which, if canceled, will cancel each of the promises passed in to CancellablePromise.all.
Type Parameters
- T1
- T2
- T3
Parameters
- values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>]
  
  an array that may contain CancellablePromises, promises, thenables, and resolved values
Returns CancellablePromise<[T1, T2, T3]>
- Defined in src/CancellablePromise.ts:334
all<T1, T2>(values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>]): CancellablePromise<[T1, T2]>
Analogous to Promise.all.

Returns
a [[CancellablePromise]], which, if canceled, will cancel each of the promises passed in to CancellablePromise.all.
Type Parameters
- T1
- T2
Parameters
- values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>]
  
  an array that may contain CancellablePromises, promises, thenables, and resolved values
Returns CancellablePromise<[T1, T2]>
- Defined in src/CancellablePromise.ts:350
all<T>(values: readonly (T | PromiseLike<T>)[]): CancellablePromise<T[]>
Analogous to Promise.all.

Returns
a [[CancellablePromise]], which, if canceled, will cancel each of the promises passed in to CancellablePromise.all.
Type Parameters
- T
Parameters
- values: readonly (T | PromiseLike<T>)[]
  
  an array that may contain CancellablePromises, promises, thenables, and resolved values
Returns CancellablePromise<T[]>
- Defined in src/CancellablePromise.ts:362

`Static` allSettled

allSettled<T>(values: T): CancellablePromise<{ -readonly [ P in string | number | symbol]: PromiseSettledResult<T[P] extends PromiseLike<U> ? U : T[P]> }>
Creates a CancellablePromise that is resolved with an array of results when all of the provided Promises resolve or reject.

Returns
A new CancellablePromise.
Type Parameters
- T extends readonly unknown[] | readonly [unknown]
Parameters
- values: T
  
  An array of Promises.
Returns CancellablePromise<{ -readonly [ P in string | number | symbol]: PromiseSettledResult<T[P] extends PromiseLike<U> ? U : T[P]> }>
- Defined in src/CancellablePromise.ts:388
allSettled<T>(values: Iterable<T>): CancellablePromise<PromiseSettledResult<T extends PromiseLike<U> ? U : T>[]>
Creates a CancellablePromise that is resolved with an array of results when all of the provided Promises resolve or reject.

Returns
A new CancellablePromise. Canceling it cancels all of the input promises.
Type Parameters
- T
Parameters
- values: Iterable<T>
  
  An array of Promises.
Returns CancellablePromise<PromiseSettledResult<T extends PromiseLike<U> ? U : T>[]>
- Defined in src/CancellablePromise.ts:404

`Static` delay

delay(ms: number): CancellablePromise<void>
Returns
a CancellablePromise that resolves after ms milliseconds.
Parameters
- ms: number
Returns CancellablePromise<void>
- Defined in src/CancellablePromise.ts:460

`Static` race

race<T>(values: T): CancellablePromise<Awaited<T[number]>>
Creates a CancellablePromise that is resolved or rejected when any of the provided Promises are resolved or rejected.

Returns
A new CancellablePromise. Canceling it cancels all of the input promises.
Type Parameters
- T extends [] | readonly unknown[]
Parameters
- values: T
  
  An array of Promises.
Returns CancellablePromise<Awaited<T[number]>>
- Defined in src/CancellablePromise.ts:429

`Static` reject

reject<T>(reason?: unknown): CancellablePromise<T>
Analogous to Promise.reject.

Like CancellablePromise.resolve, canceling the returned CancellablePromise is a no-op.
Type Parameters
- T
Parameters
- Optional reason: unknown
  
  this should probably be an Error object
Returns CancellablePromise<T>
- Defined in src/CancellablePromise.ts:182

`Static` resolve

resolve(): CancellablePromise<void>
Analogous to Promise.resolve.

The returned promise should resolve even if it is canceled. The idea is that the promise is resolved instantaneously, so by the time the promise is canceled, it has already resolved.

Returns CancellablePromise<void>
- Defined in src/CancellablePromise.ts:166
resolve<T>(value: T): CancellablePromise<T>
Type Parameters
- T
Parameters
- value: T
Returns CancellablePromise<T>
- Defined in src/CancellablePromise.ts:168

Class CancellablePromise<T>

Type Parameters

T

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T

Parameters

promise: PromiseLike<T>

cancel: ((reason?: string) => void)

Parameters

Optional reason: string

Returns void

Returns CancellablePromise<T>

Properties

Readonly cancel

Type declaration

Parameters

Optional reason: string

Returns void

Protected Readonly promise

Accessors

[toStringTag]

Returns string

Methods

catch

Type Parameters

TResult = never

Parameters

Optional onRejected: null | ((reason: any) => TResult | PromiseLike<TResult>)

Returns CancellablePromise<T | TResult>

finally

Returns

Parameters

Optional onFinally: null | (() => void)

Returns CancellablePromise<T>

then

Returns

Type Parameters

TResult1 = T

TResult2 = never

Parameters

Optional onFulfilled: null | ((value: T) => TResult1 | PromiseLike<TResult1>)

Optional onRejected: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)

Returns CancellablePromise<TResult1 | TResult2>

Static all

Returns

Type Parameters

T1

T2

T3

T4

T5

T6

T7

T8

T9

T10

Parameters

values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>, T8 | PromiseLike<T8>, T9 | PromiseLike<T9>, T10 | PromiseLike<T10>]

Returns CancellablePromise<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]>

Returns

Type Parameters

T1

T2

T3

T4

T5

T6

T7

T8

T9

Parameters

values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>, T8 | PromiseLike<T8>, T9 | PromiseLike<T9>]

`Optional` reason: string

`Readonly` cancel

`Optional` reason: string

`Protected` `Readonly` promise

`Optional` onRejected: null | ((reason: any) => TResult | PromiseLike<TResult>)

`Optional` onFinally: null | (() => void)

`Optional` onFulfilled: null | ((value: T) => TResult1 | PromiseLike<TResult1>)

`Optional` onRejected: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)

`Static` all