Function: sleep()

sleep(ms: number, signal?: AbortSignal): Promise<void>

Defined in: shared/utils/abortUtils.ts:202

Promise-based sleep function with abort support.

Parameters

ms

number

Delay in milliseconds

signal?

AbortSignal

Optional AbortSignal for cancellation

Returns

Promise<void>

Promise that resolves after the delay

Remarks

Creates a cancelable delay that can be aborted via AbortSignal. Throws when the signal is aborted during the delay.

Example

const controller = new AbortController();

try {
    await sleep(5000, controller.signal);
    console.log("Delay completed");
} catch (error) {
    console.log("Delay was aborted");
}

Throws

When the signal is aborted