v15.x 新 feature — Node.js timers 模块引入 setInterval 异步迭代器

作者简介：五月君，Software Designer，公众号「Nodejs技术栈」作者。

timers/promises 提供了计时器函数的 Promise 版本，如果使用需要文件头部先加载，否则默认还是 callback 形式的计时器函数。

import { setInterval } from 'timers/promises';

setInterval 几个功能点

Node.js v15.9.0 版本在 timers 模块新增了基于异步生成器函数实现的 setInterval，拥有以下几个功能点：

• 返回一个以 ms 为单位的异步迭代器对象，可以使用 Promise 的方式管理
• 可以使用 for await…of 迭代。
• 可以使用 AbortController 控制器对象中止计时器函数。

注意：目前该 API 处于试验性阶段，v15.9.0 这是一个奇数版本，请不要用于生产，对于 Node.js 版本不了解的可以参考这篇文章介绍 Node.js 版本知多少？又该如何选择？

setInterval API 介绍

• delay：两次迭代之间需要等待的毫秒时间，默认 1。
• value：迭代器返回值。
• options.ref：设置为 false 表示迭代之间的计划超时不应要求 Node.js 事件循环保持活动状态，默认值：true。
• options.signal：可选参数，用于取消计时器，该参数是控制器对象 AbortController 的一个实例属性。

setInterval(delay, value, { ref: false, signal });

示例一：for await…of 迭代定时器函数

const ac = new AbortController();
const { signal } = ac;
const delay = 1000;
setTimeout(() => ac.abort(), 5100);
let i=0;
try {
  for await (const startTime of setInterval(delay, Date.now(), { ref: false, signal })) {
    console.log(Date.now(), i, startTime);
    i++;
  }
} catch (err) {
  // AbortError: The operation was aborted
  console.error(err);
}

示例二：break 语句中断

因为是一个基于生成器函数实现的迭代器对象，因此还可以在符合一定条件后使用 break 语句中止计时器。

try {
  for await (const v of setInterval(delay)) {
    console.log(Date.now(), i);
    i++;
    if(i >= 2) {
      console.log(Date.now(), i, 'break');
      break;
    }
  }
} catch (err) {
  console.error(err);
}

本文中涉及到一个异步迭代器知识，参见 探索异步迭代器在 Node.js 中的使用

Reference

• https://github.com/nodejs/node/pull/37153
• https://nodejs.org/docs/latest-v15.x/api/timers.html#timers_timers_promises_api