Class EventPromise<T>

Readonly[toStringTag]

Static Readonly[species]

catch

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

  Attaches a callback for only the rejection of the Promise.

  Type Parameters

  • TResult = never

  Parameters

  • Optionalonrejected: ((reason: any) => TResult | PromiseLike<TResult>) | null

    The callback to execute when the Promise is rejected.

  Returns Promise<T | TResult>

  A Promise for the completion of the callback.

finally

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

    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?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null,
      onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null,
  ): Promise<TResult1 | TResult2>

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

  Type Parameters

  • TResult1 = T
  • TResult2 = never

  Parameters

  • Optionalonfulfilled: ((value: T) => TResult1 | PromiseLike<TResult1>) | null

    The callback to execute when the Promise is resolved.

  • Optionalonrejected: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null

    The callback to execute when the Promise is rejected.

  Returns Promise<TResult1 | TResult2>

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

Staticall

• all<T>(values: Iterable<T | PromiseLike<T>>): Promise<Awaited<T>[]>

  Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.

  Type Parameters

  • T

  Parameters

  • values: Iterable<T | PromiseLike<T>>

    An iterable of Promises.

  Returns Promise<Awaited<T>[]>

  A new Promise.

• all<T extends [] | readonly unknown[]>(
      values: T,
  ): Promise<{ -readonly [P in string | number | symbol]: Awaited<T[P]> }>

  Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.

  Type Parameters

  • T extends [] | readonly unknown[]

  Parameters

  • values: T

    An array of Promises.

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

  A new Promise.

StaticallSettled

• allSettled<T extends [] | readonly unknown[]>(
      values: T,
  ): Promise<
      {
          -readonly [P in string
          | number
          | symbol]: PromiseSettledResult<Awaited<T[P]>>
      },
  >

  Creates a Promise that is resolved with an array of results when all of the provided Promises resolve or reject.

  Type Parameters

  • T extends [] | readonly unknown[]

  Parameters

  • values: T

    An array of Promises.

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

  A new Promise.

• allSettled<T>(
      values: Iterable<T | PromiseLike<T>>,
  ): Promise<PromiseSettledResult<Awaited<T>>[]>

  Creates a Promise that is resolved with an array of results when all of the provided Promises resolve or reject.

  Type Parameters

  • T

  Parameters

  • values: Iterable<T | PromiseLike<T>>

    An array of Promises.

  Returns Promise<PromiseSettledResult<Awaited<T>>[]>

  A new Promise.

Staticany

• any<T extends [] | readonly unknown[]>(values: T): Promise<Awaited<T[number]>>

  The any function returns a promise that is fulfilled by the first given promise to be fulfilled, or rejected with an AggregateError containing an array of rejection reasons if all of the given promises are rejected. It resolves all elements of the passed iterable to promises as it runs this algorithm.

  Type Parameters

  • T extends [] | readonly unknown[]

  Parameters

  • values: T

    An array or iterable of Promises.

  Returns Promise<Awaited<T[number]>>

  A new Promise.

• any<T>(values: Iterable<T | PromiseLike<T>>): Promise<Awaited<T>>

  The any function returns a promise that is fulfilled by the first given promise to be fulfilled, or rejected with an AggregateError containing an array of rejection reasons if all of the given promises are rejected. It resolves all elements of the passed iterable to promises as it runs this algorithm.

  Type Parameters

  • T

  Parameters

  • values: Iterable<T | PromiseLike<T>>

    An array or iterable of Promises.

  Returns Promise<Awaited<T>>

  A new Promise.

Staticrace

• race<T>(values: Iterable<T | PromiseLike<T>>): Promise<Awaited<T>>

  Creates a Promise that is resolved or rejected when any of the provided Promises are resolved or rejected.

  Type Parameters

  • T

  Parameters

  • values: Iterable<T | PromiseLike<T>>

    An iterable of Promises.

  Returns Promise<Awaited<T>>

  A new Promise.

• race<T extends [] | readonly unknown[]>(values: T): Promise<Awaited<T[number]>>

  Creates a Promise that is resolved or rejected when any of the provided Promises are resolved or rejected.

  Type Parameters

  • T extends [] | readonly unknown[]

  Parameters

  • values: T

    An array of Promises.

  Returns Promise<Awaited<T[number]>>

  A new Promise.

Staticreject

• reject<T = never>(reason?: any): Promise<T>

  Creates a new rejected promise for the provided reason.

  Type Parameters

  • T = never

  Parameters

  • Optionalreason: any

    The reason the promise was rejected.

  Returns Promise<T>

  A new rejected Promise.

Staticresolve

• resolve(): Promise<void>

  Creates a new resolved promise.

  Returns Promise<void>

  A resolved promise.

• resolve<T>(value: T): Promise<Awaited<T>>

  Creates a new resolved promise for the provided value.

  Type Parameters

  • T

  Parameters

  • value: T

    A promise.

  Returns Promise<Awaited<T>>

  A promise whose internal state matches the provided promise.

• resolve<T>(value: T | PromiseLike<T>): Promise<Awaited<T>>

  Creates a new resolved promise for the provided value.

  Type Parameters

  • T

  Parameters

  • value: T | PromiseLike<T>

    A promise.

  Returns Promise<Awaited<T>>

  A promise whose internal state matches the provided promise.

Statictry

• try<T, U extends unknown[]>(
      callbackFn: (...args: U) => T | PromiseLike<T>,
      ...args: U,
  ): Promise<Awaited<T>>

  Takes a callback of any kind (returns or throws, synchronously or asynchronously) and wraps its result in a Promise.

  Type Parameters

  • T
  • U extends unknown[]

  Parameters

  • callbackFn: (...args: U) => T | PromiseLike<T>

    A function that is called synchronously. It can do anything: either return a value, throw an error, or return a promise.

  • ...args: U

    Additional arguments, that will be passed to the callback.

  Returns Promise<Awaited<T>>

  A Promise that is:

  • Already fulfilled, if the callback synchronously returns a value.
  • Already rejected, if the callback synchronously throws an error.
  • Asynchronously fulfilled or rejected, if the callback returns a promise.

StaticwithResolvers

• withResolvers<T>(): PromiseWithResolvers<T>

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

  Type Parameters

  • T

  Returns PromiseWithResolvers<T>

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

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