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 July 2015.

Die clearTimeout()-Methode der Window-Schnittstelle hebt ein Timeout auf, das zuvor durch Aufruf von Window.setTimeout() festgelegt wurde.

Wenn der übergebene Parameter keine zuvor festgelegte Aktion identifiziert, führt diese Methode nichts aus.

Syntax

js
clearTimeout(timeoutID)

Parameter

timeoutID

Der Bezeichner des Timeouts, das Sie abbrechen möchten. Diese ID wurde vom entsprechenden Aufruf von setTimeout() zurückgegeben.

Es ist erwähnenswert, dass der Pool von IDs, die von setTimeout() und setInterval() verwendet werden, geteilt wird, was bedeutet, dass Sie clearTimeout() und clearInterval() technisch austauschbar verwenden können. Zur Klarheit sollten Sie dies jedoch vermeiden.

Rückgabewert

Keiner (undefined).

Beispiele

Führen Sie das unten stehende Skript im Kontext einer Webseite aus und klicken Sie einmal auf die Seite. Sie werden sehen, dass nach einer Sekunde eine Nachricht angezeigt wird. Wenn Sie die Seite innerhalb einer Sekunde mehrmals anklicken, erscheint der Alarm nur einmal.

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());

Hinweise

Das Übergeben einer ungültigen ID an clearTimeout() bewirkt stillschweigend nichts; es wird keine Ausnahme ausgelöst.

Spezifikationen

Specification
HTML
# dom-cleartimeout-dev

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch