Class AbortablePromise<T>

constructor

• new AbortablePromise<T>(
      executor: PromiseExecutor<T>,
      props: AbortableProps,
  ): AbortablePromise<T>

  Type Parameters

  • T

  Parameters

  • executor: PromiseExecutor<T>
  • props: AbortableProps

  Returns AbortablePromise<T>

Readonlyprops

[toStringTag]

• get "[toStringTag]"(): string

  Returns string

catch

• catch<TResult = never>(
      onrejected?: null | PromiseOnRejected<TResult>,
  ): Promise<T | TResult>

  Attaches a callback for only the rejection of the Promise.

  Type Parameters

  • TResult = never

  Parameters

  • Optionalonrejected: null | PromiseOnRejected<TResult>

    The callback to execute when the Promise is rejected.

  Returns Promise<T | TResult>

  A Promise for the completion of the callback.

finally

• finally(onfinally?: null | PromiseOnFinally): 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 | PromiseOnFinally

    The callback to execute when the Promise is settled (fulfilled or rejected).

  Returns Promise<T>

  A Promise for the completion of the callback.

then

• then<TResult1 = T, TResult2 = never>(
      onfulfilled?: null | PromiseOnFulfilled<T, TResult1>,
      onrejected?: null | PromiseOnRejected<TResult2>,
  ): Promise<TResult1 | TResult2>

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

  Type Parameters

  • TResult1 = T
  • TResult2 = never

  Parameters

  • Optionalonfulfilled: null | PromiseOnFulfilled<T, TResult1>

    The callback to execute when the Promise is resolved.

  • Optionalonrejected: null | PromiseOnRejected<TResult2>

    The callback to execute when the Promise is rejected.

  Returns Promise<TResult1 | TResult2>

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

StaticwithResolvers

• withResolvers<ST>(props: AbortableProps): PromiseWithResolvers<ST>

  Creates a new Promise and returns it in an object, along with its resolve and reject functions.

  Type Parameters

  • ST

  Parameters

  • props: AbortableProps

  Returns PromiseWithResolvers<ST>

  An object with the properties promise, resolve, and reject.

  const { promise, resolve, reject } = Promise.withResolvers<T>();
  Copy