Base de conocimientosCentro de exámenes
ESEspañol
Elegir idioma13

CKTIS / JavaScript

cancelAnimationFrame — cancelar una devolución de llamada pendiente

cancelAnimationFrame(handle) elimina una devolución de llamada pendiente registrada con requestAnimationFrame(). Usa el identificador devuelto en el mismo contexto; el método no interrumpe el código que ya se está ejecutando.

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

Sintaxis

window.cancelAnimationFrame(handle);

cancelAnimationFrame(handle) cancela una única devolución de llamada pendiente registrada con requestAnimationFrame(). Pasa el identificador devuelto handle, no la función de devolución de llamada, y usa el mismo objeto que proporciona la API. El método devuelve undefined.

Un identificador que ya no figure entre las devoluciones de llamada pendientes no cambia nada. La cancelación no interrumpe una devolución de llamada que ya ha empezado ni revierte sus efectos. En un bucle que programa los siguientes fotogramas, guarda el identificador más reciente y cancela ese; un identificador anterior no representa toda la animación.

Esta es una API web del HTML Living Standard, no una función de ECMAScript. Los motores actuales de los navegadores la admiten para Window. El estándar también la contempla en contextos DedicatedWorkerGlobalScope compatibles; un contexto no compatible genera NotSupportedError. La versión de Node usada en un repositorio no permite confirmar que esta API esté disponible.

El ejemplo cancela la primera devolución de llamada y luego comprueba el contador en una segunda. El resultado esperado es calls: 0 y result: undefined. La comprobación solo ocurre cuando el navegador ejecuta la segunda devolución de llamada.

Ejemplos

(() => {
  let calls = 0;
  const handle = window.requestAnimationFrame(() => {
    calls += 1;
  });

  const result = window.cancelAnimationFrame(handle);

  window.requestAnimationFrame(() => {
    console.log(`calls: ${calls}`);
    console.log(`result: ${result}`);
  });
})();

Resultado

calls: 0
result: undefined

El código mostrado y el resultado declarado se verificaron en un entorno aislado mediante el método registrado en la evidencia de verificación de esta versión exacta.

Fuentes