WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / JavaScript

AbortController und AbortSignal: Abbruch anfordern und Status lesen

Übergib `controller.signal` an einen abbrechbaren Vorgang, fordere mit `controller.abort()` den Abbruch an und lies mit `signal.aborted` den Zustand des Signals, nicht das Ergebnis des Vorgangs.

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

Syntax

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);

Erzeuge mit new AbortController() einen Controller und behalte ihn in dem Code, der über den Abbruch entscheidet. Die schreibgeschützte Instanzeigenschaft controller.signal liefert für diesen Controller immer dasselbe AbortSignal-Objekt. Übergib es einer API, die es unterstützt, etwa mit fetch(url, { signal }). Mehrere Vorgänge können ein Signal teilen, wenn sie gemeinsam abgebrochen werden sollen.

signal.aborted ist eine schreibgeschützte boolesche Eigenschaft, keine Methode. Anfangs ist sie false. Der erste Aufruf von controller.abort() oder controller.abort(reason) ändert den Signalzustand synchron auf true und löst das Ereignis abort aus, bevor der Aufruf undefined zurückgibt. signal.reason enthält den übergebenen Wert; fehlt das Argument oder ist es undefined, enthält die Eigenschaft eine DOMException namens AbortError.

Weitere Aufrufe ersetzen weder den Grund noch lösen sie ein weiteres Ereignis aus. Das Signal lässt sich nicht zurücksetzen: Erzeuge für einen neuen Abbruchzyklus einen neuen Controller. Die statische Methode AbortSignal.abort() erzeugt dagegen ein neues, bereits abgebrochenes Signal, statt das Signal eines vorhandenen Controllers zu ändern.

Abbruch ist kooperativ. aborted === true beschreibt das Signal; es bestätigt nicht, dass ein Vorgang gestoppt wurde, und macht erledigte Arbeit nicht rückgängig. Prüfe in einer eigenen Promise-basierten API das Signal vor dem Start, reagiere auf ein späteres abort-Ereignis, lehne ein noch ausstehendes Promise mit signal.reason ab und entferne den Listener bei normalem Abschluss. Diese APIs gehören zur Webplattform, nicht zu ECMAScript 2024; prüfe die Unterstützung in deiner Zielumgebung.

Beispiele

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

Ergebnis

before: false
event: true
after: true, superseded

Die Zeile `event: true` zeigt, dass sich der Zustand beim Aufruf des Listeners bereits geändert hat. Der zweite Aufruf löst kein weiteres Ereignis aus und ersetzt den Grund `superseded` nicht.

Zugehörige Lektionen

  • JavaScript · Lektion 4 · Fortgeschritten · Version: 4

Quellen