神岛 API 文档 - ArenaPro版
    Preparing search index...

    Interface PromiseConstructor

    interface PromiseConstructor {
        new PromiseConstructor<T>(
            executor: (
                resolve: (value: T | PromiseLike<T>) => void,
                reject: (reason?: any) => void,
            ) => void,
        ): Promise<T>;
        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>]> }>;
        all<TAll>(values: Iterable<TAll | PromiseLike<TAll>>): Promise<TAll[]>;
        all<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>(
            values: readonly [
                T1
                | PromiseLike<T1>,
                T2 | PromiseLike<T2>,
                T3 | PromiseLike<T3>,
                T4 | PromiseLike<T4>,
                T5 | PromiseLike<T5>,
                T6 | PromiseLike<T6>,
                T7 | PromiseLike<T7>,
                T8 | PromiseLike<T8>,
                T9 | PromiseLike<T9>,
                T10 | PromiseLike<T10>,
            ],
        ): Promise<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]>;
        all<T1, T2, T3, T4, T5, T6, T7, T8, T9>(
            values: readonly [
                T1
                | PromiseLike<T1>,
                T2 | PromiseLike<T2>,
                T3 | PromiseLike<T3>,
                T4 | PromiseLike<T4>,
                T5 | PromiseLike<T5>,
                T6 | PromiseLike<T6>,
                T7 | PromiseLike<T7>,
                T8 | PromiseLike<T8>,
                T9 | PromiseLike<T9>,
            ],
        ): Promise<[T1, T2, T3, T4, T5, T6, T7, T8, T9]>;
        all<T1, T2, T3, T4, T5, T6, T7, T8>(
            values: readonly [
                T1
                | PromiseLike<T1>,
                T2 | PromiseLike<T2>,
                T3 | PromiseLike<T3>,
                T4 | PromiseLike<T4>,
                T5 | PromiseLike<T5>,
                T6 | PromiseLike<T6>,
                T7 | PromiseLike<T7>,
                T8 | PromiseLike<T8>,
            ],
        ): Promise<[T1, T2, T3, T4, T5, T6, T7, T8]>;
        all<T1, T2, T3, T4, T5, T6, T7>(
            values: readonly [
                T1
                | PromiseLike<T1>,
                T2 | PromiseLike<T2>,
                T3 | PromiseLike<T3>,
                T4 | PromiseLike<T4>,
                T5 | PromiseLike<T5>,
                T6 | PromiseLike<T6>,
                T7 | PromiseLike<T7>,
            ],
        ): Promise<[T1, T2, T3, T4, T5, T6, T7]>;
        all<T1, T2, T3, T4, T5, T6>(
            values: readonly [
                T1
                | PromiseLike<T1>,
                T2 | PromiseLike<T2>,
                T3 | PromiseLike<T3>,
                T4 | PromiseLike<T4>,
                T5 | PromiseLike<T5>,
                T6 | PromiseLike<T6>,
            ],
        ): Promise<[T1, T2, T3, T4, T5, T6]>;
        all<T1, T2, T3, T4, T5>(
            values: readonly [
                T1
                | PromiseLike<T1>,
                T2 | PromiseLike<T2>,
                T3 | PromiseLike<T3>,
                T4 | PromiseLike<T4>,
                T5 | PromiseLike<T5>,
            ],
        ): Promise<[T1, T2, T3, T4, T5]>;
        all<T1, T2, T3, T4>(
            values: readonly [
                T1
                | PromiseLike<T1>,
                T2 | PromiseLike<T2>,
                T3 | PromiseLike<T3>,
                T4 | PromiseLike<T4>,
            ],
        ): Promise<[T1, T2, T3, T4]>;
        all<T1, T2, T3>(
            values: readonly [
                T1
                | PromiseLike<T1>,
                T2 | PromiseLike<T2>,
                T3 | PromiseLike<T3>,
            ],
        ): Promise<[T1, T2, T3]>;
        all<T1, T2>(
            values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>],
        ): Promise<[T1, T2]>;
        all<T>(values: readonly (T | PromiseLike<T>)[]): Promise<T[]>;
        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>>[]>;
        allSettled<T extends readonly unknown[] | readonly [unknown]>(
            values: T,
        ): Promise<
            {
                -readonly [P in string
                | number
                | symbol]: PromiseSettledResult<
                    T[P<P>] extends PromiseLike<U> ? U : T[P<P>],
                >
            },
        >;
        allSettled<T>(
            values: Iterable<T>,
        ): Promise<PromiseSettledResult<T extends PromiseLike<U> ? U : T>[]>;
        race<T>(values: Iterable<T | PromiseLike<T>>): Promise<Awaited<T>>;
        race<T extends [] | readonly unknown[]>(
            values: T,
        ): Promise<Awaited<T[number]>>;
        race<T>(values: Iterable<T | PromiseLike<T>>): Promise<T>;
        race<T>(values: readonly T[]): Promise<T extends PromiseLike<U> ? U : T>;
        race<T>(values: Iterable<T>): Promise<T extends PromiseLike<U> ? U : T>;
        reject<T = never>(reason?: any): Promise<T>;
        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>>;
        resolve<T>(value: T | PromiseLike<T>): Promise<T>;
        resolve(): Promise<void>;
    }
    Index

    Constructors

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

    • 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

    "[species]": PromiseConstructor
    prototype: Promise<any>

    A reference to the prototype.

    Methods

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

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

    • 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[] | readonly [unknown]

      Parameters

      • values: T

        An array of Promises.

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

      A new Promise.

    • 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<T extends PromiseLike<U> ? U : T>[]>

      A new Promise.

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

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

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

      Type Parameters

      • T

      Parameters

      Returns Promise<T>

      A new Promise.

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

      Type Parameters

      • T

      Parameters

      • values: readonly T[]

        An array of Promises.

      Returns Promise<T extends PromiseLike<U> ? U : T>

      A new Promise.

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

      Type Parameters

      • T

      Parameters

      Returns Promise<T extends PromiseLike<U> ? U : T>

      A new Promise.

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

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

    • Creates a new resolved promise.

      Returns Promise<void>

      A resolved promise.

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

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

    • Creates a new resolved promise for the provided value.

      Type Parameters

      • T

      Parameters

      Returns Promise<T>

      A promise whose internal state matches the provided promise.

    • Creates a new resolved promise .

      Returns Promise<void>

      A resolved promise.