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
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
clearTimeout | Chrome Full support 45 | Edge Full support 12 | Firefox
Full support
1
| IE
Full support
4
| Opera Full support 4 | Safari Full support 4 | WebView Android Full support 45 | Chrome Android Full support 45 | Firefox Android
Full support
4
| Opera Android Full support 10.1 | Safari iOS Full support 1 | Samsung Internet Android Full support 5.0 |
Legend
- Full support
- Full support
- See implementation notes.
- See implementation notes.