WindowOrWorkerGlobalScope ミックスインの clearTimeout() メソッドは、以前の setTimeout() の呼び出して確立されたタイムアウトを解除します。

構文

scope.clearTimeout(timeoutID)

引数

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

注目に値するのは、 setTimeout() 及び setInterval() で使用される ID のプールは共有されますので、つまり技術的には clearTimeout() 及び clearInterval() は互いに交換できます。しかし、明確化のため、そのようなことは避けてください。

ウェブページのコンテキストで以下のスクリプトを実行し、ページを一度クリックしてください。1秒後にメッセージがポップアップします。1秒間に複数回ページをクリックしても、アラートは一度しか表示されません。

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

  setup: function() {
    if (typeof this.timeoutID === 'number') {
      this.cancel();
    }

    this.timeoutID = window.setTimeout(function(msg) {
      this.remind(msg);
    }.bind(this), 1000, 'Wake up!');
  },

  cancel: function() {
    window.clearTimeout(this.timeoutID);
    this.timeoutID = undefined;
  }
};
window.onclick = function() { alarm.setup(); };

メモ

clearTimeout へ妥当ではない ID を渡しても、何の効果もありません。例外は発生しません。

仕様書

仕様書 状態 備考
HTML Living Standard
WindowOrWorkerGlobalScope.clearTimeout() の定義
現行の標準 最新の仕様で、メソッドを WindowOrWorkerGlobalScope ミックスインに移動。
HTML Living Standard
clearTimeout() の定義
現行の標準

ブラウザーの対応

Update compatibility data on GitHub
デスクトップモバイル
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewAndroid 版 ChromeEdge MobileAndroid 版 FirefoxAndroid 版 OperaiOS 版 SafariSamsung Internet
基本対応Chrome 完全対応 1Edge 完全対応 ありFirefox 完全対応 1
完全対応 1
完全対応 52
補足
補足 clearTimeout() now defined on WindowOrWorkerGlobalScope mixin.
IE 完全対応 4Opera 完全対応 4Safari 完全対応 4WebView Android 完全対応 1Chrome Android 完全対応 18Edge Mobile 完全対応 ありFirefox Android 完全対応 4
完全対応 4
完全対応 52
補足
補足 clearTimeout() now defined on WindowOrWorkerGlobalScope mixin.
Opera Android 完全対応 6Safari iOS 完全対応 1Samsung Internet Android ?

凡例

完全対応  
完全対応
実装状況不明  
実装状況不明
実装ノートを参照してください。
実装ノートを参照してください。

関連情報

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

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