Skip to main content

@rtorcato/js-common / sleep

sleep

Functions​

sleep()​

sleep(ms): Promise<void>

Defined in: sleep/index.ts:14

Returns a promise that resolves after the specified number of milliseconds.

Example​

const started = Date.now()
await sleep(200)
Date.now() - started >= 200 // true

Parameters​

ms​

number

Number of milliseconds to sleep.

Returns​

Promise<void>

Promise that resolves after ms milliseconds.

sleepSync()​

sleepSync(ms): void

Defined in: sleep/index.ts:28

Blocks the event loop for the specified number of milliseconds (synchronous sleep). Not recommended for production use, but useful for scripts or tests.

Example​

sleepSync(50) // blocks the event loop for ~50ms, no await needed

Parameters​

ms​

number

Number of milliseconds to block.

Returns​

void

sleepRandom()​

sleepRandom(min, max): Promise<void>

Defined in: sleep/index.ts:45

Returns a promise that resolves after a random delay between min and max milliseconds.

Example​

await sleepRandom(100, 500) // resolves after 100–500ms — handy for jittered retries

Parameters​

min​

number

Minimum milliseconds to sleep.

max​

number

Maximum milliseconds to sleep.

Returns​

Promise<void>

Promise that resolves after a random delay.

sleepWithAbort()​

sleepWithAbort(ms, signal?): Promise<void>

Defined in: sleep/index.ts:57

Returns a promise that resolves after ms, or rejects with signal.reason if aborted. An already-aborted signal rejects immediately.

Parameters​

ms​

number

Milliseconds to sleep.

signal?​

AbortSignal

Optional AbortSignal to cancel the sleep.

Returns​

Promise<void>

Promise that resolves after ms or rejects with signal.reason if aborted.