import { Disposable } from './disposable'; import { Event } from './event'; import { CancellationToken } from './cancellation'; /** * Simple implementation of the deferred pattern. * An object that exposes a promise and functions to resolve and reject it. */ export declare class Deferred { state: 'resolved' | 'rejected' | 'unresolved'; resolve: (value: T | PromiseLike) => void; reject: (err?: unknown) => void; promise: Promise; protected setState(state: 'resolved' | 'rejected'): void; } /** * @returns resolves after a specified number of milliseconds * @throws cancelled if a given token is cancelled before a specified number of milliseconds */ export declare function timeout(ms: number, token?: CancellationToken): Promise; /** * Creates a promise that is rejected after the given amount of time. A typical use case is to wait for another promise until a specified timeout using: * ``` * Promise.race([ promiseToPerform, timeoutReject(timeout, 'Timeout error message') ]); * ``` * * @param ms timeout in milliseconds * @param message error message on promise rejection * @returns rejection promise */ export declare function timeoutReject(ms: number, message?: string): Promise; export declare function retry(task: () => Promise, retryDelay: number, retries: number): Promise; /** * A function to allow a promise resolution to be delayed by a number of milliseconds. Usage is as follows: * * `const stringValue = await myPromise.then(delay(600)).then(value => value.toString());` * * @param ms the number of millisecond to delay * @returns a function that returns a promise that returns the given value, but delayed */ export declare function delay(ms: number): (value: T) => Promise; /** * Constructs a promise that will resolve after a given delay. * @param ms the number of milliseconds to wait */ export declare function wait(ms: number): Promise; export declare function waitForEvent(event: Event, ms: number, thisArg?: any, disposables?: Disposable[]): Promise; export declare function isThenable(obj: unknown): obj is Promise; /** * Returns with a promise that waits until the first promise resolves to `true`. */ export declare function firstTrue(...promises: readonly Promise[]): Promise; //# sourceMappingURL=promise-util.d.ts.map