概要

window.setTimeout() によって設定された遅延を解除します。

構文

window.clearTimeout(timeoutID)

timeoutID は、解除したいタイマの ID です。ID は、window.setTimeout() の戻り値によって取得できます。

Web ページのコンテキストにおいて、以下のスクリプトを実行し、ページを一度クリックしてください。すぐに、メッセージがポップアップされます。絶え間なくページをクリックし続けると、その警告は決して現れません。

var alarm = {
  remind: function(aMessage) {
    alert(aMessage);
    delete this.timeoutID;
  },

  setup: function() {
    this.cancel();
    var self = this;
    this.timeoutID = window.setTimeout(function(msg) {self.remind(msg);}, 1000, "Wake up!");
  },

  cancel: function() {
    if(typeof this.timeoutID == "number") {
      window.clearTimeout(this.timeoutID);
      delete this.timeoutID;
    }
  }
};
window.onclick = function() { alarm.setup() };


注記

clearTimeout へ妥当ではない ID を渡しても、何の効果もありません(また、例外はスローされません)。

仕様

仕様書 策定状況 コメント
HTML Living Standard
WindowOrWorkerGlobalScope.cleartimeout() の定義
現行の標準 最新の仕様で、メソッドを WindowOrWorkerGlobalScope ミックスインに移動。
HTML Living Standard
WindowTimers.cleartimeout() の定義
現行の標準 最初期の定義 (DOM Level 0)

ブラウザー実装状況

機能 Chrome Edge Firefox (Gecko) Internet Explorer Opera Safari
基本サポート 1.0 (有) 1.0 (1.7 or earlier)
52 (52)[1]
4.0 4.0 1.0
機能 Android Android 版 Chrome Edge Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
基本サポート 1.0 1.0 (有) 1.0 (1)
52.0 (52)[1]
6.0 6.0 1.0

[1] clearTimeout() は現在継承されWindowOrWorkerGlobalScopeに定義されています.

参照

ドキュメントのタグと貢献者

タグ: 
 このページの貢献者: .Hiroya, mushahiroyuki, fscholz, jsx, ethertank, Potappo
 最終更新者: .Hiroya,