Base di conoscenzaCentro esami
ITItaliano
Scegli la lingua13

CKTIS / JavaScript

cancelIdleCallback(): annullare una callback in attesa

cancelIdleCallback(handle) annulla una callback in attesa pianificata da requestIdleCallback(). Richiede l’identificatore della richiesta, non la funzione callback stessa.

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

Sintassi

window.cancelIdleCallback(handle)

window.cancelIdleCallback(handle) riceve l’identificatore numerico restituito da requestIdleCallback() nella stessa finestra. Il metodo rimuove la callback in attesa, anche se è già pronta per essere eseguita. Restituisce undefined.

Se l’identificatore non corrisponde ad alcuna richiesta in attesa, il metodo non fa nulla. Non può interrompere una callback la cui esecuzione è già iniziata né annullarne gli effetti.

È una Web API di Window, non una funzione definita da ECMAScript. Verifica che entrambi i metodi siano disponibili; la presenza di Node 24 in un repository non dimostra il supporto nei browser.

L’esempio annulla la richiesta subito dopo averla pianificata, prima di restituire il controllo al browser. Conserva l’identificatore per poter annullare il lavoro che non serve più.

Esempi

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

Risultato

Cancellation requested

Il codice mostrato e il risultato dichiarato sono stati verificati in un ambiente isolato con il metodo registrato nella prova di verifica di questa versione esatta.

Fonti