immediate.hasRef()

• Возвращает: <boolean>

Если значение равно true, объект Immediate будет поддерживать активность цикла событий Node.js.

immediate.ref()

• Возвращает: <Immediate> ссылку на immediate

При вызове запрашивает, чтобы цикл событий Node.js не завершался, пока активен Immediate. Повторный вызов immediate.ref() не оказывает никакого эффекта.

По умолчанию все объекты Immediate имеют ссылку на цикл событий, поэтому обычно вызывать immediate.ref() не требуется, если ранее не был вызван immediate.unref().

immediate.unref()

• Возвращает: <Immediate> ссылку на immediate

При вызове активный объект Immediate не будет требовать, чтобы цикл событий Node.js оставался активным. Если нет другой активности, поддерживающей работу цикла событий, процесс может завершиться до вызова функции обратного вызова объекта Immediate. Повторный вызов 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 имеют ссылку на цикл событий, поэтому обычно вызывать timeout.ref() не требуется, если ранее не был вызван timeout.unref().

timeout.refresh()

• Возвращает: <Timeout> ссылку на timeout

Устанавливает время начала таймера на текущее время и повторно планирует его вызов через ранее заданный промежуток времени, отсчитываемый от текущего момента. Это полезно для перезапуска таймера без создания нового объекта JavaScript.

Вызов этого метода для таймера, функция обратного вызова которого уже была вызвана, активирует таймер повторно.

timeout.unref()

• Возвращает: <Timeout> ссылку на timeout

При вызове активный объект Timeout не будет требовать, чтобы цикл событий Node.js оставался активным. Если нет другой активности, поддерживающей работу цикла событий, процесс может завершиться до вызова функции обратного вызова объекта Timeout. Повторный вызов timeout.unref() не оказывает никакого эффекта.

timeout[Symbol.toPrimitive]()

• Возвращает: <integer> число, которое можно использовать для ссылки на этот timeout

Преобразует Timeout в примитив. Примитив можно использовать для очистки Timeout. Примитив можно использовать только в том же потоке, в котором был создан тайм-аут. Поэтому для использования в worker_threads его сначала нужно передать в нужный поток. Это обеспечивает улучшенную совместимость с реализациями браузерных setTimeout() и setInterval().

timeout[Symbol.dispose]()

Отменяет тайм-аут.

setImmediate(callback[, ...args])

• callback <Function> Функция, вызываемая в конце текущего прохода цикла событий Node.js (цикла событий)
• ...args <any> Необязательные аргументы, передаваемые при вызове callback.
• Возвращает: <Immediate> для использования с clearImmediate()

Планирует «немедленный» вызов callback после выполнения функций обратного вызова событий ввода-вывода.

При нескольких вызовах setImmediate() функции callback ставятся в очередь на выполнение в порядке создания. Вся очередь функций обратного вызова обрабатывается при каждой итерации цикла событий. Если таймер immediate поставлен в очередь из выполняющейся функции обратного вызова, он сработает только при следующей итерации цикла событий.

Если callback не является функцией, будет выброшено исключение TypeError.

Для этого метода доступен специальный вариант для промисов, который можно использовать с помощью timersPromises.setImmediate().

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

• callback <Function> Функция, вызываемая по истечении таймера.
• delay <number> Количество миллисекунд ожидания перед вызовом callback. По умолчанию: 1.
• ...args <any> Необязательные аргументы, передаваемые при вызове callback.
• Возвращает: <Timeout> для использования с clearInterval()

Планирует повторный вызов callback через каждые delay миллисекунд.

Если delay больше 2147483647, меньше 1 или равно NaN, значение delay будет установлено в 1. Дробные значения задержки усекаются до целого числа.

Если callback не является функцией, будет выброшено исключение TypeError.

Для этого метода доступен специальный вариант для промисов, который можно использовать с помощью timersPromises.setInterval().

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

• callback <Function> Функция, вызываемая по истечении таймера.
• delay <number> Количество миллисекунд ожидания перед вызовом callback. По умолчанию: 1.
• ...args <any> Необязательные аргументы, передаваемые при вызове callback.
• Возвращает: <Timeout> для использования с clearTimeout()

Планирует однократный вызов callback через delay миллисекунд.

Вероятно, callback не будет вызвана ровно через delay миллисекунд. Node.js не гарантирует точное время вызова функций обратного вызова или порядок их вызова. Функция будет вызвана как можно ближе к указанному времени.

Если delay больше 2147483647, меньше 1 или равно NaN, значение delay будет установлено в 1. Дробные значения задержки усекаются до целого числа.

Если callback не является функцией, будет выброшено исключение TypeError.

Для этого метода доступен специальный вариант для промисов, который можно использовать с помощью timersPromises.setTimeout().

clearImmediate(immediate)

• immediate <Immediate> Объект Immediate, возвращаемый методом setImmediate().

Отменяет объект Immediate, созданный методом setImmediate().

clearInterval(timeout)

• timeout <Timeout> | <string> | <number> Объект Timeout, возвращаемый методом setInterval(), или примитивное значение primitive объекта Timeout в виде строки или числа.

Отменяет объект Timeout, созданный методом setInterval().

clearTimeout(timeout)

• timeout <Timeout> | <string> | <number> Объект Timeout, возвращаемый методом setTimeout(), или примитивное значение primitive объекта Timeout в виде строки или числа.

Отменяет объект Timeout, созданный методом setTimeout().

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

• delay <number> Количество миллисекунд ожидания перед выполнением промиса. По умолчанию: 1.
• value <any> Значение, с которым выполняется промис.
• options <Object>
  • ref <boolean> Установите значение false, чтобы указать, что запланированный Timeout не должен требовать поддержания активности цикла событий Node.js. По умолчанию: true.
  • signal <AbortSignal> Необязательный AbortSignal, который можно использовать для отмены запланированного Timeout.

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'
});

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

• value <any> Значение, с которым выполняется промис.
• options <Object>
  • ref <boolean> Установите значение false, чтобы указать, что запланированный Immediate не должен требовать поддержания активности цикла событий Node.js. По умолчанию: true.
  • signal <AbortSignal> Необязательный AbortSignal, который можно использовать для отмены запланированного Immediate.

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'
});

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> Необязательный AbortSignal, который можно использовать для отмены запланированного Timeout между операциями.

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());
})();

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

• delay <number> Количество миллисекунд ожидания перед выполнением промиса.
• options <Object>
  • ref <boolean> Установите значение false, чтобы указать, что запланированный Timeout не должен требовать поддержания активности цикла событий Node.js. По умолчанию: true.
  • signal <AbortSignal> Необязательный AbortSignal, который можно использовать для отмены ожидания.
• Возвращает: <Promise>

Экспериментальный API, определённый черновой спецификацией Scheduling APIs, разрабатываемой в качестве стандартного 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>

Экспериментальный API, определённый черновой спецификацией Scheduling APIs, разрабатываемой в качестве стандартного API веб-платформы.

Вызов timersPromises.scheduler.yield() эквивалентен вызову timersPromises.setImmediate() без аргументов.