Skip to content

delay

延迟执行代码指定的毫秒数。

该函数返回一个 Promise,在指定的延迟后解析,可以与 async/await 结合使用来暂停执行。

它还支持一个可选的 AbortSignal 来取消延迟。

签名

typescript
function delay(ms: number, options?: DelayOptions): Promise<void>;

参数

  • ms (number): 要延迟的毫秒数。
  • options (DelayOptions, 可选): 一个选项对象。
    • signal (AbortSignal, 可选): 用于取消延迟的可选 AbortSignal

返回值

(Promise<void>): 在指定延迟后解析的 Promise。

示例

基本用法

typescript
async function foo() {
  console.log('Start');
  await delay(1000); // 延迟执行 1 秒钟
  console.log('End');
}

foo();

使用 AbortSignal

typescript
async function foo() {
  const controller = new AbortController();
  const signal = controller.signal;

  setTimeout(() => controller.abort(), 50); // 在 50 毫秒后取消延迟
  try {
    await delay(1000, { signal });
  } catch (error) {
    console.log(error); // 将会输出 'The operation was aborted'
  }
}

采用 MIT 许可证发布。