Node.js v25.0.0 ドキュメンテーション

immediate.hasRef()#

• 戻り値: <boolean>

true の場合、Immediate オブジェクトは Node.js のイベントループをアクティブに保ちます。

immediate.ref()#

• 戻り値: <Immediate> immediate への参照

呼び出されると、Immediate がアクティブである限り、Node.js のイベントループが終了しないように要求します。immediate.ref() を複数回呼び出しても効果はありません。

デフォルトでは、すべての Immediate オブジェクトは「参照」(ref'ed) されているため、以前に immediate.unref() が呼び出されていない限り、通常は immediate.ref() を呼び出す必要はありません。

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 への参照

呼び出されると、Timeout がアクティブである限り、Node.js のイベントループが終了しないように要求します。timeout.ref() を複数回呼び出しても効果はありません。

デフォルトでは、すべての Timeout オブジェクトは「参照」(ref'ed) されているため、以前に timeout.unref() が呼び出されていない限り、通常は timeout.ref() を呼び出す必要はありません。

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() で使用するため

I/O イベントのコールバックの後に、callback の「即時」実行をスケジュールします。

setImmediate() の呼び出しが複数回行われた場合、callback 関数は作成された順序で実行キューに入れられます。コールバックキュー全体は、イベントループの各イテレーションで処理されます。実行中のコールバック内から即時タイマーがキューに入れられた場合、そのタイマーは次のイベントループのイテレーションまでトリガーされません。

callback が関数でない場合、TypeError がスローされます。

このメソッドには、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 がスローされます。

このメソッドには、timersPromises.setInterval() を使用して利用できるプロミス用のカスタムバリアントがあります。

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

• callback <Function> タイマーが経過したときに呼び出す関数。
• delay <number> callback を呼び出す前に待機するミリ秒数。デフォルト: 1。
• ...args <any> callback が呼び出されるときに渡すオプションの引数。
• 戻り値: <Timeout> clearTimeout() で使用するため

delay ミリ秒後に 1 回限りの callback の実行をスケジュールします。

callback は、正確に delay ミリ秒で呼び出されるとは限りません。Node.js は、コールバックがいつ発生するかの正確なタイミングやその順序について保証しません。コールバックは、指定された時間にできるだけ近いタイミングで呼び出されます。

delay が 2147483647 より大きいか 1 未満、または NaN の場合、delay は 1 に設定されます。整数でない遅延は整数に切り捨てられます。

callback が関数でない場合、TypeError がスローされます。

このメソッドには、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> プロミスを履行する前に待機するミリ秒数。デフォルト: 1。
• value <any> プロミスが履行されるときの値。
• 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> プロミスが履行されるときの値。
• 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> プロミスを解決する前に待機するミリ秒数。
• options <Object>
  • ref <boolean> false に設定すると、スケジュールされた Timeout が Node.js のイベントループをアクティブに保つ必要がないことを示します。デフォルト: true。
  • signal <AbortSignal> 待機をキャンセルするために使用できるオプションの AbortSignal。
• 戻り値: <Promise>

標準の Web プラットフォーム 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>

標準の Web プラットフォーム API として開発されている Scheduling APIs ドラフト仕様によって定義された実験的な API です。

timersPromises.scheduler.yield() を呼び出すことは、引数なしで timersPromises.setImmediate() を呼び出すことと等価です。