WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / JavaScript

cancelIdleCallback(): einen ausstehenden Callback abbrechen

cancelIdleCallback(handle) bricht einen ausstehenden Callback ab, der mit requestIdleCallback() geplant wurde. Benötigt wird die Kennung der Anfrage, nicht die Callback-Funktion selbst.

Version: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support

Syntax

window.cancelIdleCallback(handle)

window.cancelIdleCallback(handle) erwartet die numerische Kennung, die requestIdleCallback() im selben Fenster zurückgegeben hat. Die Methode entfernt den ausstehenden Callback, auch wenn er bereits ausgeführt werden kann. Sie gibt undefined zurück.

Wenn die Kennung keiner ausstehenden Anfrage entspricht, geschieht nichts. Ein Callback, dessen Ausführung bereits begonnen hat, kann nicht unterbrochen werden; auch lassen sich seine Auswirkungen nicht rückgängig machen.

Dies ist eine Web API des Window-Objekts und keine in ECMAScript definierte Funktion. Prüfe, ob beide Methoden verfügbar sind; dass sich Node 24 in einem Repository befindet, belegt keine Browserunterstützung.

Das Beispiel bricht die Anfrage direkt nach dem Planen ab, bevor die Kontrolle an den Browser abgegeben wird. Speichere die Kennung, damit du nicht mehr benötigte Arbeit abbrechen kannst.

Beispiele

(() => {
  if (typeof window === "undefined" ||
      typeof window.requestIdleCallback !== "function" ||
      typeof window.cancelIdleCallback !== "function") {
    console.log("Idle callbacks unavailable");
    return;
  }

  const handle = window.requestIdleCallback(() => {
    console.log("Unexpected callback");
  });
  window.cancelIdleCallback(handle);
  console.log("Cancellation requested");
})();

Ergebnis

Cancellation requested

Der angezeigte Code und das angegebene Ergebnis wurden in einer isolierten Umgebung mit der im Prüfnachweis für genau diese Version dokumentierten Methode verifiziert.

Quellen