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

CKTIS / JavaScript

AbortController y AbortSignal: solicitar la cancelación y consultar su estado

Pasa `controller.signal` a una operación que admita cancelación, solicítala con `controller.abort()` y lee `signal.aborted` para consultar el estado de la señal, no el resultado de la operación.

Versión: ECMAScript 2024 and the current web platform; runtime support varies

Sintaxis

const controller = new AbortController();
const signal = controller.signal;
const aborted = signal.aborted;

// Two call forms; choose one for the first abort:
controller.abort();
controller.abort(reason);

Crea un controlador con new AbortController() y consérvalo en el código que decide cuándo cancelar. La propiedad de instancia de solo lectura controller.signal siempre devuelve el mismo objeto AbortSignal para ese controlador. Pásalo a una API que lo acepte, por ejemplo con fetch(url, { signal }). Varias operaciones pueden compartir una señal si deben cancelarse juntas.

signal.aborted es una propiedad booleana de solo lectura, no un método. Inicialmente vale false. La primera llamada a controller.abort() o controller.abort(reason) cambia el estado de la señal a true de forma síncrona y despacha el evento abort antes de devolver undefined. signal.reason contiene el valor indicado; si el argumento se omite o es undefined, contiene una DOMException llamada AbortError.

Las llamadas posteriores no sustituyen el motivo ni despachan otro evento. La señal no se puede restablecer: crea un controlador nuevo para un nuevo ciclo de cancelación. El método estático AbortSignal.abort() es distinto: crea una señal nueva ya cancelada en lugar de cambiar la de un controlador existente.

La cancelación es cooperativa. aborted === true describe la señal: no confirma que una operación se haya detenido ni deshace el trabajo ya terminado. En tu propia API basada en promesas, comprueba la señal antes de empezar, atiende un evento abort posterior, rechaza las promesas aún pendientes con signal.reason y retira el escuchador al finalizar normalmente. Estas API son de la plataforma web, no de ECMAScript 2024; comprueba su compatibilidad con el entorno de ejecución de destino.

Ejemplos

{
  const controller = new AbortController();
  const signal = controller.signal;

  console.log(`before: ${signal.aborted}`);
  signal.addEventListener("abort", () => {
    console.log(`event: ${signal.aborted}`);
  });

  controller.abort("superseded");
  controller.abort("ignored");
  console.log(`after: ${signal.aborted}, ${signal.reason}`);
}

Resultado

before: false
event: true
after: true, superseded

La línea `event: true` muestra que el estado ya ha cambiado cuando se ejecuta el escuchador. La segunda llamada no dispara otro evento ni sustituye el motivo `superseded`.

Lecciones relacionadas

  • JavaScript · Lección 4 · Avanzado · Versión: 4

Fuentes