-
Notifications
You must be signed in to change notification settings - Fork 22.4k
/
index.md
92 lines (68 loc) · 1.93 KB
/
index.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
---
title: clearTimeout() global function
short-title: clearTimeout()
slug: Web/API/clearTimeout
page-type: web-api-global-function
browser-compat: api.clearTimeout
---
{{APIRef("HTML DOM")}}{{AvailableInWorkers}}
The global **`clearTimeout()`** method cancels a timeout previously established
by calling {{domxref("setTimeout()")}}.
If the parameter provided does not identify a previously established action,
this method does nothing.
## Syntax
```js-nolint
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
{{domxref("setTimeout()")}} and
{{domxref("setInterval()")}} are shared, which
means you can technically use `clearTimeout()` and
{{domxref("clearInterval", "clearInterval()")}}
interchangeably. However, for clarity, you should avoid doing so.
### Return value
None ({{jsxref("undefined")}}).
## Examples
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.
```js
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 to `clearTimeout()` silently does nothing; no
exception is thrown.
## Specifications
{{Specifications}}
## Browser compatibility
{{Compat}}
## See also
- {{domxref("setTimeout()")}}
- {{domxref("setInterval()")}}
- {{domxref("clearInterval()")}}
- {{domxref("Window.requestAnimationFrame()")}}