Base di conoscenzaCentro esami
ITItaliano
Scegli la lingua13

CKTIS / JavaScript

AbortController e AbortSignal: richiedere l’annullamento e leggerne lo stato

Passa `controller.signal` a un’operazione che supporta l’annullamento, richiedilo con `controller.abort()` e leggi `signal.aborted` per conoscere lo stato del segnale, non l’esito dell’operazione.

Versione: ECMAScript 2024 and the current web platform; runtime support varies

Sintassi

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 controller con new AbortController() e conservalo nel codice che decide quando annullare. La proprietà di istanza di sola lettura controller.signal restituisce sempre lo stesso oggetto AbortSignal per quel controller. Passalo a un’API che lo accetta, ad esempio con fetch(url, { signal }). Più operazioni possono condividere un segnale se devono essere annullate insieme.

signal.aborted è una proprietà booleana di sola lettura, non un metodo. All’inizio vale false. La prima chiamata a controller.abort() o controller.abort(reason) cambia in modo sincrono lo stato del segnale in true e genera l’evento abort prima di restituire undefined. signal.reason contiene il valore fornito; se l’argomento è omesso o vale undefined, contiene una DOMException denominata AbortError.

Le chiamate successive non sostituiscono il motivo e non generano un altro evento. Il segnale non si può ripristinare: crea un nuovo controller per un nuovo ciclo di annullamento. Il metodo statico AbortSignal.abort() è diverso: crea un nuovo segnale già annullato, invece di modificare quello di un controller esistente.

L’annullamento è cooperativo. aborted === true descrive il segnale: non conferma che un’operazione si sia fermata e non annulla il lavoro già completato. In una tua API basata su promise, controlla il segnale prima di iniziare, gestisci un successivo evento abort, rifiuta ogni promise ancora in sospeso con signal.reason e rimuovi il listener al termine normale. Queste API appartengono alla piattaforma web, non a ECMAScript 2024; verificane il supporto nell’ambiente di esecuzione di destinazione.

Esempi

{
  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}`);
}

Risultato

before: false
event: true
after: true, superseded

La riga `event: true` mostra che lo stato è già cambiato quando viene eseguito il listener. La seconda chiamata non genera un altro evento e non sostituisce il motivo `superseded`.

Lezioni correlate

  • JavaScript · Lezione 4 · Avanzato · Versione: 4

Fonti