Window: clearTimeout() method
BaselineWidely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.
TheclearTimeout()
method of theWindow
interface cancels a timeout previously established by callingWindow.setTimeout()
.
If the parameter provided does not identify a previously established action,this method does nothing.
Syntax
clearTimeout(timeoutID)
Parameters
timeoutID
The identifier of the timeout you want to cancel. This ID was returned by thecorresponding call to
setTimeout()
.
It's worth noting that the pool of IDs used bysetTimeout()
andsetInterval()
are shared, which means you can technically useclearTimeout()
andclearInterval()
interchangeably. However, for clarity, you should avoid doing so.
Return value
None (undefined
).
Examples
Run the script below in the context of a web page and click on the page once. You'llsee a message popping up in a second. If you click the page multiple times inone second, the alert only appears once.
const alarm = { remind(aMessage) { alert(aMessage); this.timeoutID = undefined; }, setup() { if (typeof this.timeoutID === "number") { this.cancel(); } this.timeoutID = setTimeout( (msg) => { this.remind(msg); }, 1000, "Wake up!", ); }, cancel() { clearTimeout(this.timeoutID); },};window.addEventListener("click", () => alarm.setup());
Notes
Passing an invalid ID toclearTimeout()
silently does nothing; noexception is thrown.
Specifications
Specification |
---|
HTML # dom-cleartimeout-dev |