KennisbankExamencentrum
NL · NLNederlands (Nederland)
Taal kiezen13

CKTIS / JavaScript

cancelIdleCallback(): een wachtende callback annuleren

cancelIdleCallback(handle) annuleert een wachtende callback die met requestIdleCallback() is ingepland. Hiervoor is de aanvraag-ID nodig, niet de callbackfunctie zelf.

Versie: 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) neemt de numerieke ID die requestIdleCallback() in hetzelfde venster heeft teruggegeven. De methode verwijdert de wachtende callback, ook als die al klaarstaat om uitgevoerd te worden. De methode retourneert undefined.

Komt de ID niet overeen met een wachtende aanvraag, dan doet de methode niets. Een callback waarvan de uitvoering al is begonnen, kan niet worden onderbroken; de effecten ervan kunnen ook niet ongedaan worden gemaakt.

Dit is een Web API van Window, geen functie die door ECMAScript is gedefinieerd. Controleer of beide methoden beschikbaar zijn; de aanwezigheid van Node 24 in een repository bewijst geen browserondersteuning.

Het voorbeeld annuleert de aanvraag direct nadat deze is ingepland, voordat de controle aan de browser wordt overgedragen. Bewaar de ID, zodat je werk kunt annuleren dat niet meer nodig is.

Voorbeelden

(() => {
  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");
})();

Resultaat

Cancellation requested

De getoonde code en het opgegeven resultaat zijn in een geïsoleerde omgeving geverifieerd met de methode die in het verificatiebewijs voor exact deze versie is vastgelegd.

Bronnen