Firefox Tomorrow

web api instance method

WorkerGlobalScope: clearTimeout() method

View on MDN ↗

Available in workers

The clearTimeout() method of the WorkerGlobalScope interface cancels a timeout previously established by calling 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 clearTimeout() for examples.

Notes

Passing an invalid ID to clearTimeout() silently does nothing; no exception is thrown.

Specifications

SpecificationsStandards references are available on the canonical MDN page.

Browser compatibility

Browser compatibilityCompatibility data is available on the canonical MDN page.

See also