es-promise-ext/dist/prototype/reduce/reduce.d.ts

Native promise extensions for javascript and typescript.

export interface Option<I> {
    canceller?: {
        cancelled?: boolean;
    };
    progress?: (subResult: any, step: number, total: number) => any;
    initValue?: I;
}
type Func = (...arg: any) => any;
export type AsyncFunctions<I, R, V0, V1, V2, V3, V4, V5, V6, V7, V8, V9> = [] | [(arg: Awaited<I>) => R] | [
    (arg: Awaited<I>) => V0,
    (arg: Awaited<V0>) => R
] | [
    (arg: Awaited<I>) => V0,
    (arg: Awaited<V0>) => V1,
    (arg: Awaited<V1>) => R
] | [
    (arg: Awaited<I>) => V0,
    (arg: Awaited<V0>) => V1,
    (arg: Awaited<V1>) => V2,
    (arg: Awaited<V2>) => R
] | [
    (arg: Awaited<I>) => V0,
    (arg: Awaited<V0>) => V1,
    (arg: Awaited<V1>) => V2,
    (arg: Awaited<V2>) => V3,
    (arg: Awaited<V3>) => R
] | [
    (arg: Awaited<I>) => V0,
    (arg: Awaited<V0>) => V1,
    (arg: Awaited<V1>) => V2,
    (arg: Awaited<V2>) => V3,
    (arg: Awaited<V3>) => V4,
    (arg: Awaited<V4>) => R
] | [
    (arg: Awaited<I>) => V0,
    (arg: Awaited<V0>) => V1,
    (arg: Awaited<V1>) => V2,
    (arg: Awaited<V2>) => V3,
    (arg: Awaited<V3>) => V4,
    (arg: Awaited<V4>) => V5,
    (arg: Awaited<V5>) => R
] | [
    (arg: Awaited<I>) => V0,
    (arg: Awaited<V0>) => V1,
    (arg: Awaited<V1>) => V2,
    (arg: Awaited<V2>) => V3,
    (arg: Awaited<V3>) => V4,
    (arg: Awaited<V4>) => V5,
    (arg: Awaited<V5>) => V6,
    (arg: Awaited<V6>) => R
] | [
    (arg: Awaited<I>) => V0,
    (arg: Awaited<V0>) => V1,
    (arg: Awaited<V1>) => V2,
    (arg: Awaited<V2>) => V3,
    (arg: Awaited<V3>) => V4,
    (arg: Awaited<V4>) => V5,
    (arg: Awaited<V5>) => V6,
    (arg: Awaited<V6>) => V7,
    (arg: Awaited<V7>) => R
] | [
    (arg: Awaited<I>) => V0,
    (arg: Awaited<V0>) => V1,
    (arg: Awaited<V1>) => V2,
    (arg: Awaited<V2>) => V3,
    (arg: Awaited<V3>) => V4,
    (arg: Awaited<V4>) => V5,
    (arg: Awaited<V5>) => V6,
    (arg: Awaited<V6>) => V7,
    (arg: Awaited<V7>) => V8,
    (arg: Awaited<V8>) => R
] | [
    (arg: Awaited<I>) => V0,
    (arg: Awaited<V0>) => V1,
    (arg: Awaited<V1>) => V2,
    (arg: Awaited<V2>) => V3,
    (arg: Awaited<V3>) => V4,
    (arg: Awaited<V4>) => V5,
    (arg: Awaited<V5>) => V6,
    (arg: Awaited<V6>) => V7,
    (arg: Awaited<V7>) => V8,
    (arg: Awaited<V8>) => V9,
    (arg: Awaited<V9>) => R
] | [
    (arg: Awaited<I>) => V0,
    (arg: Awaited<V0>) => V1,
    (arg: Awaited<V1>) => V2,
    (arg: Awaited<V2>) => V3,
    (arg: Awaited<V3>) => V4,
    (arg: Awaited<V4>) => V5,
    (arg: Awaited<V5>) => V6,
    (arg: Awaited<V6>) => V7,
    (arg: Awaited<V7>) => V8,
    (arg: Awaited<V8>) => V9,
    (arg: Awaited<V9>) => any,
    ...Func[],
    (arg: any) => R
];
type ReduceFunction<R> = () => Promise<Awaited<R>>;
/**
 * Creates a Promise that is resolved sequentially with a result when all of the provided Promises resolve, or rejected when any Promise is rejected.
 *
 * @param {AsyncFunctions} asyncFunctions
 * - An array of async functions.
 *
 * @return {ReduceFunction<R>}
 * A new Promise.
 *
 * @example
 * Promise.resolve().then(
 *   reduce(
 *     [
 *       () => Promise.resolve(1),
 *       plus(5),
 *       minus(2).
 *     ]
 *   )
 * )
 * // return 4 in the subsequent promise
 */
export default function reduce<I, R, V0, V1, V2, V3, V4, V5, V6, V7, V8, V9>(asyncFunctions: AsyncFunctions<I, R, V0, V1, V2, V3, V4, V5, V6, V7, V8, V9>): ReduceFunction<R>;
/**
 * Creates a Promise that is resolved sequentially with a result when all of the provided Promises resolve, or rejected when any Promise is rejected.
 *
 * @param {AsyncFunctions} 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
 * - initValue: any
 *
 * @return {ReduceFunction<R>}
 * A new Promise.
 *
 * @example
 * Promise.resolve().then(
 *   reduce(
 *     [
 *       plus(5),
 *       minus(2).
 *     ],
 *     {
 *       canceller: { cancelled: false },
 *         // set to true later
 *       progress: (subResult, step, total) =>
 *         {
 *           console.log(subResult)
 *           console.log(`${((step+1) / total)}%`)
 *         },
 *       initValue: 1
 *     }
 *   )
 * )
 * // return 4 in the subsequent promise
 */
export default function reduce<I, R, V0, V1, V2, V3, V4, V5, V6, V7, V8, V9>(asyncFunctions: AsyncFunctions<I, R, V0, V1, V2, V3, V4, V5, V6, V7, V8, V9>, option: Option<I>): ReduceFunction<R>;
export {};