clearInterval

関数の概要

clearIntervalは、Node.jsで定期的な処理を行うために設定したタイマーを停止するための関数です。setInterval関数で設定したタイマーを解除する際に使用します。タイマーの処理を停止することで、無駄なリソース消費を避けることができます。

パラメータの説明

パラメータ 用途
intervalID Number 停止したいタイマーのIDを指定する

戻り値

戻り値は特になく、単に指定したタイマーが停止される。同期的に処理される。

使用例

例1: setIntervalで設定したタイマーを停止する


const intervalID = setInterval(() => {
  console.log('タイマー処理');
}, 1000);

clearInterval(intervalID);

例2: タイマーを複数設定して、特定のタイマーのみを停止する


const intervalID1 = setInterval(() => {
  console.log('タイマー1処理');
}, 1000);

const intervalID2 = setInterval(() => {
  console.log('タイマー2処理');
}, 2000);

clearInterval(intervalID1);

関連する関数

  • setInterval: 一定の間隔で指定された関数を繰り返し実行
  • setTimeout: 一定時間後に指定された関数を実行

まとめ

clearIntervalは、設定したタイマーを停止するための便利な関数です。タイマーの管理を行う際に、必要なタイミングでタイマーを停止することができるため、効率的なプログラミングに役立ちます。ただし、適切なタイミングでclearIntervalを使用しないと、意図しない処理が発生する可能性があるので注意が必要です。