Function: sleep()

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

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

Promise-based sleep helper with AbortSignal support.

Parameters

ms

number

Delay duration in milliseconds.

signal?

AbortSignal

Optional cancellation signal to observe.

Returns

Promise<void>

Promise that resolves after the requested delay.

Remarks

Negative, zero, or non-finite durations resolve immediately. When the signal aborts during the delay window, the returned promise rejects with a new Error describing the cancellation.

Example

import { logger } from "@app/services/logger";

const controller = new AbortController();

try {
    await sleep(5_000, controller.signal);
    logger.info("Delay completed");
} catch (error) {
    if (isAbortError(error)) {
        logger.warn("Delay was aborted");
    }
}

Throws

When the supplied signal aborts before the delay completes.