Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / JavaScript

cancelIdleCallback(): cancelar uma chamada pendente

cancelIdleCallback(handle) cancela uma chamada pendente agendada por requestIdleCallback(). Precisa do identificador do pedido, não da própria função de chamada.

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

Sintaxe

window.cancelIdleCallback(handle)

window.cancelIdleCallback(handle) recebe o identificador numérico devolvido por requestIdleCallback() na mesma janela. O método remove a chamada pendente, mesmo que já esteja pronta para ser executada. Devolve undefined.

Se o identificador não corresponder a nenhum pedido pendente, o método não faz nada. Não consegue interromper uma chamada cuja execução já começou nem anular os seus efeitos.

É uma Web API de Window, não uma função definida pelo ECMAScript. Verifique se ambos os métodos estão disponíveis; a presença do Node 24 num repositório não comprova o suporte nos navegadores.

O exemplo cancela o pedido logo após o agendar, antes de devolver o controlo ao navegador. Guarde o identificador para poder cancelar trabalho que já não seja necessário.

Exemplos

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

Resultado

Cancellation requested

O código apresentado e o resultado declarado foram verificados num ambiente isolado pelo método registado na prova de verificação desta versão exata.

Fontes