Class AbortablePromise<T>

The promise that can be aborted.

Type Parameters

T
The value that the promise is resolved with.

Hierarchy

Promise<T>
- AbortablePromise

Index

Constructors

Accessors

Methods

abort withSignal

Constructors

constructor

new AbortablePromise<T>(executor): AbortablePromise<T>
Creates a new abortable promise.
Type Parameters
- T
  The value that the promise is resolved with.
Parameters
- executor: ((resolve, reject, signal) => void)
  A callback that initializes the promise.
  - - (resolve, reject, signal): void
    - Parameters
      resolve: ((value) => void)
      The resolve callback used to resolve the promise with a value or the result of another promise.
      
      Param: value
      The fulfillment result.
      
      (value): void
      Parameters
      value: Awaitable<T>
      Returns void
      reject: ((reason?) => void)
      The reject callback used to reject the promise with a provided reason or error.
      
      Param: reason
      The rejection reason.
      
      (reason?): void
      Parameters
      Optional reason: any
      Returns void
      signal: AbortSignal
      The signal that is aborted if abort method is called.
      
      Returns void
Returns AbortablePromise<T>
Overrides Promise<T>.constructor

Accessors

`Static` [species]

get [species](): PromiseConstructor
Returns PromiseConstructor
Overrides Promise.[species]

Methods

abort

abort(reason?): void
Aborts the signal passed to the executor and instantly rejects the promise with the reason.
Parameters
- Optional reason: unknown
  The abort reason. If not explicitly provided, it defaults to an AbortError.
Returns void

withSignal

withSignal(signal): this
Subscribes this promise to be aborted when the signal is aborted.
Parameters
- signal: AbortSignal
  The signal that aborts this promise.
Returns this
This promise.