es-promise-ext/dist/sequence/index.d.ts

Native promise extensions for javascript and typescript.

import { Option } from './sequence';
declare global {
    interface PromiseConstructor {
        /**
         * Creates a Promise that is resolved sequentially with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.
         *
         * @param {U} asyncFunctions
         * - An array of async functions.
         *
         * @return {Promise<{ [K in keyof U]: U[K] extends (...args: any[]) => infer R ? Awaited<R> : Awaited<U[K]> }>}
         * A new Promise.
         *
         * @example
         * Promise.sequence(
         *   [
         *     () => Promise.resolve(1),
         *     () => Promise.resolve(2),
         *     () => Promise.resolve(3)
         *   ]
         * )
         * // return [1,2,3] in the subsequent promise
         */
        sequence<U extends readonly unknown[] | []>(asyncFunctions: U): Promise<{
            [K in keyof U]: U[K] extends (...args: any[]) => infer R ? Awaited<R> : Awaited<U[K]>;
        }>;
        /**
         * Creates a Promise that is resolved sequentially with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.
         *
         * @param {U} asyncFunctions
         * - An array of async functions.
         *
         * @param {Option} option
         * - canceller: object.  Set `canceller.cancelled = true` stopping the sequence
         * - progress: `(subResult, step, total) => any`.  To show the progress and the sub result
         * - skipIfError: boolean
         *
         * @return {Promise<{ [K in keyof U]: U[K] extends (...args: any[]) => infer R ? Awaited<R> : Awaited<U[K]> }>}
         * A new Promise.
         *
         * @example
         * Promise.sequence(
         *   [
         *     () => Promise.resolve(1),
         *     () => Promise.resolve(2),
         *     () => Promise.resolve(3)
         *   ],
         *   {
         *     canceller: { cancelled: false },
         *       // set to true later
         *     progress: (subResult, step, total) =>
         *       {
         *         console.log(subResult)
         *         console.log(`${((step+1) / total)}%`)
         *       },
         *     skipIfError: true
         *   }
         * )
         * // return [1,2,3] in the subsequent promise
         */
        sequence<U extends readonly unknown[] | []>(asyncFunctions: U, option: Option): Promise<{
            [K in keyof U]: U[K] extends (...args: any[]) => infer R ? Awaited<R> : Awaited<U[K]>;
        }>;
    }
}