Class CancelablePromise<T>

constructor

• new CancelablePromise<T>(
      executor: (
          resolve: (value: T | PromiseLike<T>) => void,
          reject: (reason?: unknown) => void,
          onCancel: OnCancel,
      ) => void,
  ): CancelablePromise<T>

  Type Parameters

  • T

  Parameters

  • executor: (
        resolve: (value: T | PromiseLike<T>) => void,
        reject: (reason?: unknown) => void,
        onCancel: OnCancel,
    ) => void

  Returns CancelablePromise<T>

ReadonlycancelHandlers

Readonlypromise

[toStringTag]

• get "[toStringTag]"(): string

  Returns string

isCancelled

• get isCancelled(): boolean

  Returns boolean

cancel

• cancel(): void

  Returns void

catch

• catch<TResult = never>(
      onRejected?:
          | null
          | ((reason: unknown) => TResult | PromiseLike<TResult>),
  ): Promise<T | TResult>

  Attaches a callback for only the rejection of the Promise.

  Type Parameters

  • TResult = never

  Parameters

  • OptionalonRejected: null | ((reason: unknown) => TResult | PromiseLike<TResult>)

  Returns Promise<T | TResult>

  A Promise for the completion of the callback.

finally

• finally(onFinally?: null | (() => void)): Promise<T>

  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: null | (() => void)

  Returns Promise<T>

  A Promise for the completion of the callback.

then

• then<TResult1 = T, TResult2 = never>(
      onFulfilled?: null | ((value: T) => TResult1 | PromiseLike<TResult1>),
      onRejected?: null | ((reason: unknown) => TResult2 | PromiseLike<TResult2>),
  ): Promise<TResult1 | TResult2>

  Attaches callbacks for the resolution and/or rejection of the Promise.

  Type Parameters

  • TResult1 = T
  • TResult2 = never

  Parameters

  • OptionalonFulfilled: null | ((value: T) => TResult1 | PromiseLike<TResult1>)
  • OptionalonRejected: null | ((reason: unknown) => TResult2 | PromiseLike<TResult2>)

  Returns Promise<TResult1 | TResult2>

  A Promise for the completion of which ever callback is executed.