clearInterval()
グローバルの clearInterval()
メソッドは、以前に setInterval()
の呼び出しによって確立されたタイマーを利用した繰り返し動作を取り消します。
指定された引数で前回確立されたアクションを識別できなかった場合、このメソッドは何も行いません。
構文
clearInterval(intervalID)
引数
intervalID
-
取り消す繰り返し動作の識別子です。この ID は対応する
setInterval()
の呼び出しの返値です。
setInterval()
と setTimeout()
で使用する ID のプールが共有されていることは注目に値します。つまり、技術的には clearInterval()
と clearTimeout()
を交換することができます。
しかし、わかりやすくするために、そうすることは避けるべきです。
返値
なし (undefined
)。
例
setInterval()
の例を参照してください。
仕様書
Specification |
---|
HTML Standard # dom-clearinterval-dev |
ブラウザーの互換性
BCD tables only load in the browser