Window: clearTimeout() Methode
Baseline
Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since Juli 2015.
Die clearTimeout() Methode der Window Schnittstelle bricht einen zuvor durch einen Aufruf von Window.setTimeout() gesetzten Timeout ab.
Wenn der angegebene Parameter keine zuvor festgelegte Aktion identifiziert, hat diese Methode keine Auswirkung.
Syntax
clearTimeout(timeoutID)
Parameter
timeoutID-
Die Kennung des Timeouts, die Sie abbrechen möchten. Diese ID wurde durch den entsprechenden Aufruf von
setTimeout()zurückgegeben.
Es ist erwähnenswert, dass der Pool von IDs, der von setTimeout() und setInterval() verwendet wird, gemeinsam genutzt wird, was bedeutet, dass Sie technisch gesehen clearTimeout() und clearInterval() austauschbar verwenden können. Aus Gründen der Klarheit sollten Sie dies allerdings vermeiden.
Rückgabewert
Keiner (undefined).
Beispiele
Führen Sie das folgende Skript im Kontext einer Webseite aus und klicken Sie einmal auf die Seite. Sie werden sehen, dass eine Nachricht nach einer Sekunde erscheint. Wenn Sie innerhalb einer Sekunde mehrmals auf die Seite klicken, erscheint der Alarm nur einmal.
const alarm = {
remind(message) {
alert(message);
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());
Hinweise
Das Übergeben einer ungültigen ID an clearTimeout() hat keine Wirkung; es wird keine Ausnahme ausgelöst.
Spezifikationen
| Specification |
|---|
| HTML # dom-cleartimeout-dev |
Browser-Kompatibilität
Loading…