WindowOrWorkerGlobalScope.clearTimeout()

The clearTimeout() method of the WindowOrWorkerGlobalScope mixin cancels a timeout previously established by calling setTimeout().

Syntax

scope.clearTimeout(timeoutID)

Parameters

timeoutID
The identifier of the timeout you want to cancel. This ID was returned by the corresponding call to setTimeout().

It's worth noting that the pool of IDs used by setTimeout() and setInterval() are shared, which means you can technically use clearTimeout() and clearInterval() interchangeably. However, for clarity, you should avoid doing so.

Example

Run the script below in the context of a web page and click on the page once. You'll see a message popping up in a second. If you click the page multiple times in one second, the alert only appears once.

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);
  }
};
window.onclick = function() { alarm.setup(); };

Notes

Passing an invalid ID to clearTimeout() silently does nothing; no exception is thrown.

Specifications

Specification Status Comment
HTML Living Standard
The definition of 'WindowOrWorkerGlobalScope.clearTimeout()' in that specification.
Living Standard Method moved to the WindowOrWorkerGlobalScope mixin in the latest spec.
HTML Living Standard
The definition of 'clearTimeout()' in that specification.
Living Standard

Browser compatibility

DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
clearTimeoutChrome Full support 45Edge Full support 12Firefox Full support 1
Full support 1
Full support 52
Notes
Notes clearTimeout() now defined on WindowOrWorkerGlobalScope mixin.
IE Full support 4
Notes
Full support 4
Notes
Notes From Internet Explorer 4 through 8, clearTimeout is an Object rather than a Function. This behavior was fixed in Internet Explorer 9.
Opera Full support 4Safari Full support 4WebView Android Full support 45Chrome Android Full support 45Firefox Android Full support 4
Full support 4
Full support 52
Notes
Notes clearTimeout() now defined on WindowOrWorkerGlobalScope mixin.
Opera Android Full support 10.1Safari iOS Full support 1Samsung Internet Android Full support 5.0

Legend

Full support
Full support
See implementation notes.
See implementation notes.

See also