softkave-js-utils/build/promise/getConjoinedPromise.d.ts

JavaScript & Typescript utility functions, types, and classes

import { ValueOf } from 'type-fest';
import { DeferredPromise } from './getDeferredPromise.js';
export interface ConjoinedPromise {
    deferredPromise: DeferredPromise;
    add: (p: Promise<unknown>) => Promise<unknown>;
    newDeferred: () => DeferredPromise;
    start: () => void;
}
export declare const kConjoinedPromiseSettlementType: {
    /** Resolves when all the promises added to it are resolved, and rejects when
     * one of them is rejected. */
    readonly all: "a";
    /** Resolves when all the promises added to it are resolved. */
    readonly allSettled: "s";
};
export type ConjoinedPromiseSettlementType = ValueOf<typeof kConjoinedPromiseSettlementType>;
/** Returns a promise that resolves when all the promises added to it are
 * resolved. */
export declare function getConjoinedPromise(params: {
    settlementType: ConjoinedPromiseSettlementType;
}): ConjoinedPromise;