Variable CombineablePromiseConst

Type Declaration

• all: function

  • all<const T extends readonly RestatePromise<unknown>[]>(
        values: T,
    ): RestatePromise<
        { -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.

    See Promise.all for more details.

    Type Parameters

    • const T extends readonly RestatePromise<unknown>[]

    Parameters

    • values: T

      An iterable of Promises.

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

    A new Promise.

• allSettled: function

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

    Creates a promise that fulfills when all the input's promises settle (including when an empty iterable is passed), with an array of objects that describe the outcome of each promise.

    See Promise.allSettled for more details.

    Type Parameters

    • const T extends readonly RestatePromise<unknown>[]

    Parameters

    • values: T

      An iterable of Promises.

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

    A new Promise.

• any: function

  • any<const T extends readonly RestatePromise<unknown>[]>(
        values: T,
    ): RestatePromise<Awaited<T[number]>>

    Creates a promise that fulfills when any of the input's promises fulfills, with this first fulfillment value. It rejects when all the input's promises reject (including when an empty iterable is passed), with an AggregateError containing an array of rejection reasons.

    See Promise.any for more details.

    Type Parameters

    • const T extends readonly RestatePromise<unknown>[]

    Parameters

    • values: T

      An iterable of Promises.

    Returns RestatePromise<Awaited<T[number]>>

    A new Promise.

• race: function

  • race<const T extends readonly RestatePromise<unknown>[]>(
        values: T,
    ): RestatePromise<Awaited<T[number]>>

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

    See Promise.race for more details.

    Type Parameters

    • const T extends readonly RestatePromise<unknown>[]

    Parameters

    • values: T

      An iterable of Promises.

    Returns RestatePromise<Awaited<T[number]>>

    A new Promise.

• reject: function

  • reject<T = never>(reason: TerminalError): RestatePromise<T>

    Creates a RestatePromise that is rejected with the given TerminalError.

    Type Parameters

    • T = never

    Parameters

    • reason: TerminalError

      The TerminalError to reject with.

    Returns RestatePromise<T>

    A rejected RestatePromise.

• resolve: function

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

    Creates a RestatePromise that is resolved with the given value.

    If the value is already a RestatePromise, it is returned as-is (mirroring the behavior of Promise.resolve when given a native Promise).

    Type Parameters

    • T

    Parameters

    • value: T

      The value to resolve, or an existing RestatePromise to return.

    Returns RestatePromise<Awaited<T>>

    A resolved RestatePromise, or the input promise unchanged.