【Node.js24.x】Object::setInterval()メソッドの使い方
setIntervalメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
setIntervalメソッドは、指定された関数を一定の時間間隔で繰り返し実行するメソッドです。これは、Node.js環境において、決められた間隔で処理を自動的に実行したい場合に利用されます。
このメソッドの基本的な使い方として、第一引数には繰り返し実行したい処理を記述した関数(コールバック関数)を指定し、第二引数にはその関数を実行する間隔をミリ秒単位で渡します。例えば、1000ミリ秒と指定すれば、約1秒ごとにコールバック関数が繰り返し呼び出されます。
setIntervalメソッドは、そのタイマーを識別するための一意のIDとしてTimeoutオブジェクトを返します。このIDは非常に重要で、繰り返し処理を停止したい場合にclearIntervalメソッドの引数として渡すことで、タイマーを解除し、関数の繰り返し実行を停止させることができます。clearInterval()を適切に呼び出さない場合、処理が永久に実行され続ける可能性があるため注意が必要です。
また、第三引数以降には、繰り返し実行されるコールバック関数に渡したい任意の引数を指定することが可能です。Node.jsにおけるsetIntervalは非同期処理の一部であり、指定された時間間隔はあくまで目安となります。Node.jsのイベントループの状態や他の処理の負荷によっては、厳密な時間精度が保証されない場合があります。
主に、定期的なデータのポーリング、システムの状態監視、ログの出力、あるいは単純な時間経過に基づくイベントの発生といった、一定周期でタスクを実行する必要がある場面で活用されます。
構文(syntax)
1setInterval(() => { 2 console.log('繰り返し実行される処理'); 3}, 1000);
引数(parameters)
callback, delay, ...args
- callback: function: 指定された遅延時間ごとに実行される関数
- delay: number: callback関数を実行するまでの遅延時間(ミリ秒)
- ...args: any[]: callback関数に渡される追加の引数
戻り値(return)
NodeJS.Timeout
setIntervalメソッドは、指定した間隔で関数を繰り返し実行するためのタイマーをスケジュールします。このメソッドの戻り値はNodeJS.Timeoutオブジェクトであり、このオブジェクトはタイマーをクリア(停止)するために後でsetIntervalIDとして使用できます。