Node.js v24.0.0 文档

immediate.hasRef()#

• 返回: <boolean>

如果为 true，则 Immediate 对象将保持 Node.js 事件循环处于活动状态。

immediate.ref()#

• 返回: <Immediate> 对 immediate 的引用

调用时，请求 Node.js 事件循环在 Immediate 处于活动状态时不退出。 多次调用 immediate.ref() 不会有任何效果。

默认情况下，所有 Immediate 对象都是“ref'ed”，因此通常不需要调用 immediate.ref()，除非先前已调用 immediate.unref()。

immediate.unref()#

• 返回: <Immediate> 对 immediate 的引用

调用后，活动的 Immediate 对象将不需要 Node.js 事件循环保持活动状态。 如果没有其他活动使事件循环保持运行，则该进程可能会在调用 Immediate 对象的 callback 之前退出。 多次调用 immediate.unref() 不会有任何效果。

immediate[Symbol.dispose]()#

取消 immediate。 这类似于调用 clearImmediate()。

timeout.close()#

• 返回: <Timeout> 对 timeout 的引用

取消超时。

timeout.hasRef()#

• 返回: <boolean>

如果为 true，则 Timeout 对象将保持 Node.js 事件循环处于活动状态。

timeout.ref()#

• 返回: <Timeout> 对 timeout 的引用

调用时，请求 Node.js 事件循环在 Timeout 处于活动状态时不退出。 多次调用 timeout.ref() 不会有任何效果。

默认情况下，所有 Timeout 对象都是“ref'ed”，因此通常不需要调用 timeout.ref()，除非先前已调用 timeout.unref()。

timeout.refresh()#

• 返回: <Timeout> 对 timeout 的引用

将计时器的开始时间设置为当前时间，并重新安排计时器以在先前指定的持续时间（根据当前时间调整）后调用其回调。 这对于刷新计时器而不分配新的 JavaScript 对象很有用。

在已经调用其回调的计时器上使用此方法将重新激活计时器。

timeout.unref()#

• 返回: <Timeout> 对 timeout 的引用

调用后，活动的 Timeout 对象将不需要 Node.js 事件循环保持活动状态。 如果没有其他活动使事件循环保持运行，则该进程可能会在调用 Timeout 对象的 callback 之前退出。 多次调用 timeout.unref() 不会有任何效果。

timeout[Symbol.toPrimitive]()#

• 返回: <integer> 可用于引用此 timeout 的数字

将 Timeout 强制转换为 primitive。 primitive 可用于清除 Timeout。 primitive 只能在创建超时的同一线程中使用。 因此，要在 worker_threads 中使用它，必须首先将其传递给正确的线程。 这允许增强与浏览器 setTimeout() 和 setInterval() 实现的兼容性。

timeout[Symbol.dispose]()#

取消超时。

setImmediate(callback[, ...args])#

• callback <Function> 在 Node.js 事件循环的此轮结束时调用的函数
• ...args <any> 调用 callback 时传递的可选参数。
• 返回: <Immediate> 用于 clearImmediate()

在 I/O 事件的回调之后调度 callback 的“立即”执行。

当多次调用 setImmediate() 时，callback 函数会排队等待执行，顺序与创建它们的顺序相同。 整个回调队列在每个事件循环迭代中都会被处理。 如果从正在执行的回调内部将 immediate 计时器排队，则该计时器将不会被触发，直到下一个事件循环迭代。

如果 callback 不是一个函数，则会抛出一个 TypeError。

此方法有一个用于 Promise 的自定义变体，可以使用 timersPromises.setImmediate()。

setInterval(callback[, delay[, ...args]])#

• callback <Function> 当计时器到期时要调用的函数。
• delay <number> 调用 callback 之前要等待的毫秒数。 默认: 1。
• ...args <any> 调用 callback 时传递的可选参数。
• 返回: <Timeout>，用于 clearInterval()

安排每隔 delay 毫秒重复执行 callback。

当 delay 大于 2147483647 或小于 1 或 NaN 时，delay 将设置为 1。 非整数延迟将被截断为整数。

如果 callback 不是一个函数，则会抛出一个 TypeError。

此方法有一个用于 Promise 的自定义变体，可以使用 timersPromises.setInterval()。

setTimeout(callback[, delay[, ...args]])#

• callback <Function> 当计时器到期时要调用的函数。
• delay <number> 调用 callback 之前要等待的毫秒数。 默认: 1。
• ...args <any> 调用 callback 时传递的可选参数。
• 返回: <Timeout>，用于 clearTimeout()

安排在 delay 毫秒后执行一次 callback。

callback 不太可能正好在 delay 毫秒后被调用。 Node.js 不保证回调触发的确切时间，也不保证它们的顺序。 回调将在尽可能接近指定时间的时间被调用。

当 delay 大于 2147483647 或小于 1 或 NaN 时，delay 将设置为 1。 非整数延迟将被截断为整数。

如果 callback 不是一个函数，则会抛出一个 TypeError。

此方法有一个用于 Promise 的自定义变体，可以使用 timersPromises.setTimeout()。

clearImmediate(immediate)#

• immediate <Immediate> 由 setImmediate() 返回的 Immediate 对象。

取消由 setImmediate() 创建的 Immediate 对象。

clearInterval(timeout)#

• timeout <Timeout> | <string> | <number> 由 setInterval() 返回的 Timeout 对象，或者 Timeout 对象的 原始值，作为字符串或数字。

取消由 setInterval() 创建的 Timeout 对象。

clearTimeout(timeout)#

• timeout <Timeout> | <string> | <number> 由 setTimeout() 返回的 Timeout 对象，或者 Timeout 对象的 原始值，作为字符串或数字。

取消由 setTimeout() 创建的 Timeout 对象。

timersPromises.setTimeout([delay[, value[, options]]])#

• delay <number> 在 fulfilled promise 之前等待的毫秒数。 默认: 1。
• value <any> promise 被 fulfilled 的值。
• options <Object>
  • ref <boolean> 设置为 false 以指示已安排的 Timeout 不需要 Node.js 事件循环保持活动状态。 默认: true。
  • signal <AbortSignal> 可用于取消已安排的 Timeout 的可选 AbortSignal。

import {
  setTimeout,
} from 'node:timers/promises';

const res = await setTimeout(100, 'result');

console.log(res);  // Prints 'result'const {
  setTimeout,
} = require('node:timers/promises');

setTimeout(100, 'result').then((res) => {
  console.log(res);  // Prints 'result'
});copy

timersPromises.setImmediate([value[, options]])#

• value <any> promise 被 fulfilled 的值。
• options <Object>
  • ref <boolean> 设置为 false 以指示已安排的 Immediate 不需要 Node.js 事件循环保持活动状态。 默认: true。
  • signal <AbortSignal> 可用于取消已安排的 Immediate 的可选 AbortSignal。

import {
  setImmediate,
} from 'node:timers/promises';

const res = await setImmediate('result');

console.log(res);  // Prints 'result'const {
  setImmediate,
} = require('node:timers/promises');

setImmediate('result').then((res) => {
  console.log(res);  // Prints 'result'
});copy

timersPromises.setInterval([delay[, value[, options]]])#

返回一个异步迭代器，该迭代器以 delay 毫秒的间隔生成值。 如果 ref 为 true，则需要显式或隐式调用异步迭代器的 next() 以保持事件循环处于活动状态。

• delay <number> 迭代之间等待的毫秒数。 默认: 1。
• value <any> 迭代器返回的值。
• options <Object>
  • ref <boolean> 设置为 false 以指示迭代之间已安排的 Timeout 不需要 Node.js 事件循环保持活动状态。 默认: true。
  • signal <AbortSignal> 可用于取消操作之间已安排的 Timeout 的可选 AbortSignal。

import {
  setInterval,
} from 'node:timers/promises';

const interval = 100;
for await (const startTime of setInterval(interval, Date.now())) {
  const now = Date.now();
  console.log(now);
  if ((now - startTime) > 1000)
    break;
}
console.log(Date.now());const {
  setInterval,
} = require('node:timers/promises');
const interval = 100;

(async function() {
  for await (const startTime of setInterval(interval, Date.now())) {
    const now = Date.now();
    console.log(now);
    if ((now - startTime) > 1000)
      break;
  }
  console.log(Date.now());
})();copy

timersPromises.scheduler.wait(delay[, options])#

• delay <number> 在解析 Promise 之前等待的毫秒数。
• options <Object>
  • ref <boolean> 设置为 false 以指示已安排的 Timeout 不需要 Node.js 事件循环保持活动状态。 默认: true。
  • signal <AbortSignal> 可用于取消等待的可选 AbortSignal。
• 返回: <Promise>

由 Scheduling APIs 草案规范定义的实验性 API，该规范正在开发为标准 Web 平台 API。

调用 timersPromises.scheduler.wait(delay, options) 等同于调用 timersPromises.setTimeout(delay, undefined, options)。

import { scheduler } from 'node:timers/promises';

await scheduler.wait(1000); // Wait one second before continuing copy

timersPromises.scheduler.yield()#

• 返回: <Promise>

由 Scheduling APIs 草案规范定义的实验性 API，该规范正在开发为标准 Web 平台 API。

调用 timersPromises.scheduler.yield() 等同于调用不带参数的 timersPromises.setImmediate()。