@httptoolkit/util/dist/promises.d.ts

A tiny utility package, sharing JS code widely used across HTTP Toolkit projects

export type MaybePromise<T> = T | Promise<T>;
export declare const delay: (ms: number, options?: {
    /**
     * If set, if the code is running in a compatible runtime (i.e. Node.js)
     * then the .unref() will be used to ensure that this delay does not
     * block the process shutdown.
     */
    unref?: boolean;
}) => Promise<void>;
export declare function doWhile<T>(doFn: () => Promise<T>, whileFn: () => Promise<boolean> | boolean): Promise<void>;
/**
 * A deferred is a promise (you can await it directly) but also exposes the promise
 * explicitly at .promise, and exposes public resolve & reject callbacks for external
 * resolution.
 */
export interface Deferred<T> extends Promise<T> {
    resolve: (arg: T) => void;
    reject: (e: Error) => void;
    promise: Promise<T>;
}
export declare function getDeferred<T = void>(): Deferred<T>;
/**
 * Wrap a function, so that any parallel calls which happen while the async function
 * is pending return the same value as the first call (so the function is only run
 * once, but the result is shared). This is useful for expensive async functions or
 * race conditions. This ignores arguments completely, and is only applicable for
 * functions that don't need any other input.
 */
export declare function combineParallelCalls<T>(fn: () => Promise<T>): () => Promise<T>;