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. Повторный вызов immediate.unref() не оказывает эффекта.

immediate[Symbol.dispose]()

Отменяет немедленный вызов. Это аналог вызова 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. Повторный вызов 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 будут поставлены в очередь на выполнение в порядке их создания. Очередь функций обратного вызова обрабатывается целиком на каждой итерации цикла событий. Если таймер немедленного вызова поставлен в очередь из выполняемой функции обратного вызова, он сработает только на следующей итерации цикла событий.

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

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

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

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

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

Если значение delay больше 2147483647 или меньше 1, значение 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, значение delay будет установлено в 1. Нецелые значения задержки усекаются до целого числа.

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

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

clearImmediate(immediate)

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

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

clearInterval(timeout)

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

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

clearTimeout(timeout)

• timeout <Timeout> | <string> | <number> Объект Timeout, возвращаемый методом setTimeout(), либо примитивное значение объекта 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() без аргументов.