Skip to content

async.Function.sleep

github-actions[bot] edited this page Jun 8, 2026 · 2 revisions

@zenstone/ts-utils / async / sleep

Function: sleep()

Call Signature

sleep(ms): Promise<void>

Defined in: src/async/index.ts:262

延迟指定毫秒数,可选延迟后执行函数

Parameters

ms

number

延迟毫秒数

Returns

Promise<void>

无 fn 时返回 Promise,有 fn 时返回 Promise<Awaited<ReturnType>>

Example

// 纯等待
await sleep(1000);

// 延迟后执行
const data = await sleep(1000, () => fetchData());

Call Signature

sleep<F>(ms, fn): Promise<Awaited<ReturnType<F>>>

Defined in: src/async/index.ts:263

延迟指定毫秒数,可选延迟后执行函数

Type Parameters

F

F extends AnyFn

Parameters

ms

number

延迟毫秒数

fn

F

延迟后执行的函数(可选)

Returns

Promise<Awaited<ReturnType<F>>>

无 fn 时返回 Promise,有 fn 时返回 Promise<Awaited<ReturnType>>

Example

// 纯等待
await sleep(1000);

// 延迟后执行
const data = await sleep(1000, () => fetchData());

Clone this wiki locally