Class PromiseCancellable<T>

Type Parameters

Hierarchy

Promise<T>
- PromiseCancellable

Index

Constructors

constructor

new PromiseCancellable<T>(executor, controller?): PromiseCancellable<T>
Type Parameters
- T
Parameters
- executor: ((resolve, reject, signal) => void)
  - - (resolve, reject, signal): void
    - Parameters
      
      resolve: ((value) => void)
      
      (value): void
      
      Parameters
      
      value: T | PromiseLike<T>
      
      Returns void
      
      reject: ((reason?) => void)
      
      (reason?): void
      
      Parameters
      
      Optional reason: any
      
      Returns void
      
      signal: AbortSignal
      
      Returns void
- Optional controller: PromiseCancellableController
Returns PromiseCancellable<T>
Overrides Promise<T>.constructor
- Defined in src/PromiseCancellable.ts:129

Properties

`Protected` abortController

abortController: AbortController

`Protected` `Readonly` reject

reject: ((reason?) => void)

Type declaration

- (reason?): void
- Parameters
  - Optional reason: any
  Returns void

Accessors

[toStringTag]

get [toStringTag](): string
Returns string
Overrides Promise.[toStringTag]
- Defined in src/PromiseCancellable.ts:203

`Static` [species]

get [species](): PromiseConstructor
Returns PromiseConstructor
Overrides Promise.[species]
- Defined in src/PromiseCancellable.ts:4

Methods

cancel

cancel(reason?): void
Parameters
- Optional reason: any
Returns void
- Defined in src/PromiseCancellable.ts:207

catch

catch<TResult>(onRejected?, controller?): PromiseCancellable<T | TResult>
Type Parameters
- TResult = never
Parameters
- Optional onRejected: null | ((reason, signal) => TResult | PromiseLike<TResult>)
- Optional controller: PromiseCancellableController
Returns PromiseCancellable<T | TResult>
Overrides Promise.catch
- Defined in src/PromiseCancellable.ts:239

finally

finally(onFinally?, controller?): PromiseCancellable<T>
Parameters
- Optional onFinally: null | ((signal) => void)
- Optional controller: PromiseCancellableController
Returns PromiseCancellable<T>
Overrides Promise.finally
- Defined in src/PromiseCancellable.ts:265

then

then<TResult1, TResult2>(onFulfilled?, onRejected?, controller?): PromiseCancellable<TResult1 | TResult2>
Type Parameters
- TResult1 = T
- TResult2 = never
Parameters
- Optional onFulfilled: null | ((value, signal) => TResult1 | PromiseLike<TResult1>)
- Optional onRejected: null | ((reason, signal) => TResult2 | PromiseLike<TResult2>)
- Optional controller: PromiseCancellableController
Returns PromiseCancellable<TResult1 | TResult2>
Overrides Promise.then
- Defined in src/PromiseCancellable.ts:211

`Static` all

all<T>(values, controller?): PromiseCancellable<{
-readonly [P in string | number | symbol]: Awaited<T[P]>
}>
Type Parameters
- T extends readonly unknown[] | []
Parameters
- values: T
- Optional controller: PromiseCancellableController
Returns PromiseCancellable<{
-readonly [P in string | number | symbol]: Awaited<T[P]>
}>
Overrides Promise.all
- Defined in src/PromiseCancellable.ts:21
all<T>(values, controller?): PromiseCancellable<Awaited<T>[]>
Type Parameters
- T
Parameters
- values: Iterable<T | PromiseLike<T>>
- Optional controller: PromiseCancellableController
Returns PromiseCancellable<Awaited<T>[]>
Overrides Promise.all
- Defined in src/PromiseCancellable.ts:25

`Static` allSettled

allSettled<T>(values, controller?): PromiseCancellable<{
-readonly [P in string | number | symbol]: PromiseSettledResult<Awaited<T[P]>>
}>
Type Parameters
- T extends readonly unknown[] | []
Parameters
- values: T
- Optional controller: PromiseCancellableController
Returns PromiseCancellable<{
-readonly [P in string | number | symbol]: PromiseSettledResult<Awaited<T[P]>>
}>
Overrides Promise.allSettled
- Defined in src/PromiseCancellable.ts:44
allSettled<T>(values, controller?): PromiseCancellable<PromiseSettledResult<Awaited<T>>[]>
Type Parameters
- T
Parameters
- values: Iterable<T | PromiseLike<T>>
- Optional controller: PromiseCancellableController
Returns PromiseCancellable<PromiseSettledResult<Awaited<T>>[]>
Overrides Promise.allSettled
- Defined in src/PromiseCancellable.ts:50

`Static` any

any<T>(values, controller?): PromiseCancellable<Awaited<T[number]>>
Type Parameters
- T extends readonly unknown[] | []
Parameters
- values: T
- Optional controller: PromiseCancellableController
Returns PromiseCancellable<Awaited<T[number]>>
Overrides Promise.any
- Defined in src/PromiseCancellable.ts:94
any<T>(values, controller?): PromiseCancellable<Awaited<T>>
Type Parameters
- T
Parameters
- values: Iterable<T | PromiseLike<T>>
- Optional controller: PromiseCancellableController
Returns PromiseCancellable<Awaited<T>>
Overrides Promise.any
- Defined in src/PromiseCancellable.ts:98

`Static` from

from<T>(p, controller?): PromiseCancellable<T>
Type Parameters
- T
Parameters
- p: PromiseLike<T>
- Optional controller: PromiseCancellableController
Returns PromiseCancellable<T>
- Defined in src/PromiseCancellable.ts:117

`Static` race

race<T>(values, controller?): PromiseCancellable<Awaited<T[number]>>
Type Parameters
- T extends readonly unknown[] | []
Parameters
- values: T
- Optional controller: PromiseCancellableController
Returns PromiseCancellable<Awaited<T[number]>>
Overrides Promise.race
- Defined in src/PromiseCancellable.ts:71
race<T>(values, controller?): PromiseCancellable<Awaited<T>>
Type Parameters
- T
Parameters
- values: Iterable<T | PromiseLike<T>>
- Optional controller: PromiseCancellableController
Returns PromiseCancellable<Awaited<T>>
Overrides Promise.race
- Defined in src/PromiseCancellable.ts:75

`Static` reject

reject<T>(reason?): PromiseCancellable<T>
Type Parameters
- T = never
Parameters
- Optional reason: any
Returns PromiseCancellable<T>
Overrides Promise.reject
- Defined in src/PromiseCancellable.ts:17

`Static` resolve

resolve(): PromiseCancellable<void>
Returns PromiseCancellable<void>
Overrides Promise.resolve
- Defined in src/PromiseCancellable.ts:8
resolve<T>(value): PromiseCancellable<T>
Type Parameters
- T
Parameters
- value: T | PromiseLike<T>
Returns PromiseCancellable<T>
Overrides Promise.resolve
- Defined in src/PromiseCancellable.ts:9

Class PromiseCancellable<T>

Type Parameters

T

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T

Parameters

executor: ((resolve, reject, signal) => void)

Parameters

resolve: ((value) => void)

Parameters

value: T | PromiseLike<T>

Returns void

reject: ((reason?) => void)

Parameters

Optional reason: any

Returns void

signal: AbortSignal

Returns void

Optional controller: PromiseCancellableController

Returns PromiseCancellable<T>

Properties

Protected abortController

Protected Readonly reject

Type declaration

Parameters

Optional reason: any

Returns void

Accessors

[toStringTag]

Returns string

Static [species]

Returns PromiseConstructor

Methods

cancel

Parameters

Optional reason: any

Returns void

catch

Type Parameters

TResult = never

Parameters

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

Optional controller: PromiseCancellableController

Returns PromiseCancellable<T | TResult>

finally

Parameters

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

Optional controller: PromiseCancellableController

Returns PromiseCancellable<T>

then

Type Parameters

TResult1 = T

TResult2 = never

Parameters

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

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

Optional controller: PromiseCancellableController

Returns PromiseCancellable<TResult1 | TResult2>

Static all

Type Parameters

T extends readonly unknown[] | []

Parameters

values: T

Optional controller: PromiseCancellableController

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

Type Parameters

T

Parameters

values: Iterable<T | PromiseLike<T>>

Optional controller: PromiseCancellableController

Returns PromiseCancellable<Awaited<T>[]>

Static allSettled

`Optional` reason: any

`Optional` controller: PromiseCancellableController

`Protected` abortController

`Protected` `Readonly` reject

`Optional` reason: any

`Static` [species]

`Optional` reason: any

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

`Optional` controller: PromiseCancellableController

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

`Optional` controller: PromiseCancellableController

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

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

`Optional` controller: PromiseCancellableController

`Static` all

`Optional` controller: PromiseCancellableController

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

`Optional` controller: PromiseCancellableController

`Static` allSettled

`Optional` controller: PromiseCancellableController

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

`Optional` controller: PromiseCancellableController

`Static` any

`Optional` controller: PromiseCancellableController

`Optional` controller: PromiseCancellableController

`Static` from

`Optional` controller: PromiseCancellableController

`Static` race

`Optional` controller: PromiseCancellableController

`Optional` controller: PromiseCancellableController

`Static` reject

`Optional` reason: any

`Static` resolve