Interface PromiseConstructor

    interface PromiseConstructor {
        new PromiseConstructor<T>(
            executor: (
                resolve: (value: T | PromiseLike<T>) => void,
                reject: (reason?: any) => void,
            ) => void,
        ): Promise<T>;
        "[species]": PromiseConstructor;
        prototype: Promise<any>;
        all<T>(values: Iterable<T | PromiseLike<T>>): Promise<Awaited<T>[]>;
        all<T extends [] | readonly unknown[]>(
            values: T,
        ): Promise<{ -readonly [P in string | number | symbol]: Awaited<T[P<P>]> }>;
        allSettled<T extends [] | readonly unknown[]>(
            values: T,
        ): Promise<
            {
                -readonly [P in string
                | number
                | symbol]: PromiseSettledResult<Awaited<T[P<P>]>>
            },
        >;
        allSettled<T>(
            values: Iterable<T | PromiseLike<T>>,
        ): Promise<PromiseSettledResult<Awaited<T>>[]>;
        any<T extends [] | readonly unknown[]>(
            values: T,
        ): Promise<Awaited<T[number]>>;
        any<T>(values: Iterable<T | PromiseLike<T>>): Promise<Awaited<T>>;
        race<T>(values: Iterable<T | PromiseLike<T>>): Promise<Awaited<T>>;
        race<T extends [] | readonly unknown[]>(
            values: T,
        ): Promise<Awaited<T[number]>>;
        reject<T = never>(reason?: any): Promise<T>;
        resolve(): Promise<void>;
        resolve<T>(value: T): Promise<Awaited<T>>;
        resolve<T>(value: T | PromiseLike<T>): Promise<Awaited<T>>;
        withResolvers<T>(): PromiseWithResolvers<T>;
    }

    Constructors

    constructor

    Properties

    [species] prototype

    Methods

    all allSettled any race reject resolve withResolvers

    Constructors

    constructor

    • new PromiseConstructor<T>(
          executor: (
              resolve: (value: T | PromiseLike<T>) => void,
              reject: (reason?: any) => void,
          ) => void,
      ): Promise<T>

    • Creates a new Promise.

      Type Parameters

      • T

      Parameters

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

        A callback used to initialize the promise. This callback is passed two arguments: a resolve callback used to resolve the promise with a value or the result of another promise, and a reject callback used to reject the promise with a provided reason or error.

      Returns Promise<T>

    Properties

    Readonly[species]

    "[species]": PromiseConstructor

    Readonlyprototype

    prototype: Promise<any>

    A reference to the prototype.

    Methods

    all

    • 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

      Returns Promise<Awaited<T>[]>

      A new Promise.

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

      A new Promise.

    allSettled

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

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

      A new Promise.

    any

    • 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

      Returns Promise<Awaited<T>>

      A new Promise.

    race

    • 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

      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.

    reject

    • 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.

    resolve

    • 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

      Returns Promise<Awaited<T>>

      A promise whose internal state matches the provided promise.

    withResolvers

    • 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>();

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods