The clearTimeout()
method of the WindowOrWorkerGlobalScope
mixin cancels a timeout previously established by calling setTimeout()
.
scope.clearTimeout(timeoutID)
timeoutID
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.
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(); };
Passing an invalid ID to clearTimeout()
silently does nothing; no exception is thrown.
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 |
Desktop | ||||||
---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | |
Basic support | 1 | Yes | 1
|
4 | 4 | 4 |
Mobile | |||||||
---|---|---|---|---|---|---|---|
Android webview | Chrome for Android | Edge Mobile | Firefox for Android | Opera for Android | iOS Safari | Samsung Internet | |
Basic support | 1 | 18 | Yes | 4
|
6 | 1 | ? |
WindowOrWorkerGlobalScope.setTimeout()
WindowOrWorkerGlobalScope.setInterval()
WindowOrWorkerGlobalScope.clearInterval()
Window.requestAnimationFrame()
© 2005–2018 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/clearTimeout