@nktkas/hyperliquid/esm/deps/jsr.io/@std/async/1.0.13/delay.d.ts

Unofficial Hyperliquid API SDK for all major JS runtimes, written in TypeScript and provided with tests

/** Options for {@linkcode delay}. */
export interface DelayOptions {
    /** Signal used to abort the delay. */
    signal?: AbortSignal;
    /** Indicates whether the process should continue to run as long as the timer exists.
     *
     * @default {true}
     */
    persistent?: boolean;
}
/**
 * Resolve a {@linkcode Promise} after a given amount of milliseconds.
 *
 * @throws {DOMException} If the optional signal is aborted before the delay
 * duration, and `signal.reason` is undefined.
 * @param ms Duration in milliseconds for how long the delay should last.
 * @param options Additional options.
 *
 * @example Basic usage
 * ```ts no-assert
 * import { delay } from "@std/async/delay";
 *
 * // ...
 * const delayedPromise = delay(100);
 * const result = await delayedPromise;
 * // ...
 * ```
 *
 * @example Disable persistence
 *
 * Setting `persistent` to `false` will allow the process to continue to run as
 * long as the timer exists.
 *
 * ```ts no-assert ignore
 * import { delay } from "@std/async/delay";
 *
 * // ...
 * await delay(100, { persistent: false });
 * // ...
 * ```
 */
export declare function delay(ms: number, options?: DelayOptions): Promise<void>;
//# sourceMappingURL=delay.d.ts.map