AbortSignal: reason-Eigenschaft

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since March 2019.

Hinweis: Diese Funktion ist in Web Workers verfügbar.

Die reason-Eigenschaft (nur lesbar) gibt einen JavaScript-Wert zurück, der den Abbruchgrund angibt.

Die Eigenschaft ist undefined, wenn das Signal nicht abgebrochen wurde. Sie kann auf einen bestimmten Wert gesetzt werden, wenn das Signal abgebrochen wird, indem AbortController.abort() oder AbortSignal.abort() verwendet wird. Wenn sie nicht explizit in diesen Methoden gesetzt wird, ist der Standardwert "AbortError" DOMException.

Wert

Ein JavaScript-Wert, der den Abbruchgrund angibt, oder undefined, wenn nicht abgebrochen.

Beispiele

Im folgenden Schnipsel erstellen wir ein neues AbortController-Objekt und erhalten dessen AbortSignal (verfügbar über die signal-Eigenschaft). Später überprüfen wir mit der aborted-Eigenschaft, ob das Signal abgebrochen wurde, und loggen den Abbruchstatus und Grund in die Konsole.

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

// …

if (signal.aborted) {
  if (signal.reason) {
    console.log(`Request aborted with reason: ${signal.reason}`);
  } else {
    console.log("Request aborted but no reason was given.");
  }
} else {
  console.log("Request not aborted");
}

Spezifikationen

Specification
DOM Standard # ref-for-dom-abortsignal-reason①

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch

Fetch-API