WorkerGlobalScope: clearTimeout() method
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.
Note: This feature is only available in Web Workers.
The clearTimeout()
method of the WorkerGlobalScope
interface cancels a timeout previously established by calling WorkerGlobalScope.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 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.
Return value
None (undefined
).
Examples
See Window.clearTimeout()
for examples.
Notes
Passing an invalid ID to clearTimeout()
silently does nothing; no
exception is thrown.
Specifications
Specification |
---|
HTML Standard # dom-cleartimeout-dev |
Browser compatibility
BCD tables only load in the browser