Table of Contents

• Timers
  • setTimeout(callback, delay, [arg], [...])
  • clearTimeout(timeoutId)
  • setInterval(callback, delay, [arg], [...])
  • clearInterval(intervalId)
  • unref()
  • ref()
  • setImmediate(callback, [arg], [...])
  • clearImmediate(immediateId)

Timers#

Stability: 5 - Locked

全てのタイマ関数はグローバルです。 このモジュールを使うために require() をする必要はありません。

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

delay ミリ秒が経過した後で、 callback が一度だけ実行されるようにスケジュールします。 clearTimeout() で使うことができる timeoutId を返します。 オプションとして、コールバックへの引数を渡すこともできます。

コールバックが正確に delay ミリ秒後に呼び出されるとは限らない点に 注目することは重要です - Node.js はコールバックが呼び出される正確なタイミングも、 呼び出される順番も保証しません。 コールバックはできるだけ指定された時間に近いタイミングで呼び出されます。

clearTimeout(timeoutId)#

タイムアウトがトリガーされるのを止めます。

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

delay ミリ秒が経過するごとに繰り返し callback が実行されるようにスケジュールします。 clearInterval() で使うことができる intervalId を返します。 オプションとして、コールバックへの引数を渡すこともできます。

clearInterval(intervalId)#

インターバルがトリガーされるのを止めます。

unref()#

setTimeout() あるいは setInterval() が返す不透明な値は、 アクティブであるにもかかわらず、それがイベントループの最後の一つになっても プログラムの実行を継続しないタイマを作ることを可能にする、 timer.unref() メソッドを持っています。 既に unref されたタイマで再び unref が呼び出されても影響はありません。

setTimeout() が unref された場合、イベントループを起こすために独立した タイマが作成されるため、それらがあまりに多く作成されるとイベントループの パフォーマンスに悪影響を与えます -- 賢明に使ってください。

ref()#

以前に unref されたタイマは、明示的に ref() を呼び出すことで プログラムを実行したままにするよう要求することができます。 既に ref されたタイマで再び ref が呼び出されても影響はありません。

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

callback を「即時」 (I/O イベントのコールバックより後、setTimeout および setInterval よりも前) に実行するようスケジュールします。 clearImmediate() に渡すことのできる immediatedId を返します。 オプションとして、コールバックへの引数を渡すことができます。

即時実行のコールバックは、それが作られた順でキューイングされます。 コールバックのキューは全体が各イベントループの繰り返し毎に処理されます。 もし即時実行のコールバックが実行されている中から setImmediate() を呼び出しても、そのコールバックは次のイベントループの繰り返しまで 呼び出されません。

clearImmediate(immediateId)#

setImmediate() に渡した関数が呼び出されることを中止します。