This article needs a technical review. How you can help.
Clears the delay set by WindowTimers.setTimeout().
Syntax
window.clearTimeout(timeoutID)
timeoutIDis the ID of the timeout you wish to clear, as returned byWindowTimers.setTimeout().
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 keep clicking on the page once in a second, the alert never appears.
var alarm = {
remind: function(aMessage) {
alert(aMessage);
this.timeoutID = undefined;
},
setup: function() {
if (typeof this.timeoutID === "number") {
this.cancel();
} else {
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(); };
Notes
Passing an invalid ID to clearTimeout does not have any effect (and doesn't throw an exception).
Specification
Specified in HTML5.
