AbortController: abort()-Methode

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: Dieses Feature ist verfügbar in Web Workers.

Die abort()-Methode der AbortController-Schnittstelle bricht eine asynchrone Operation ab, bevor sie abgeschlossen ist. Hiermit können Fetch-Anfragen, das Konsumieren von Antwort-Körpern oder Streams abgebrochen werden.

Syntax

abort()
abort(reason)

Parameter

reason Optional: Der Grund, warum die Operation abgebrochen wurde, welcher ein beliebiger JavaScript-Wert sein kann. Ist kein Grund angegeben, wird er auf "AbortError" DOMException gesetzt.

Rückgabewert

Keiner (undefined).

Beispiele

Im folgenden Beispiel wollen wir ein Video mit der Fetch API herunterladen.

Zuerst erzeugen wir einen Controller mit dem AbortController()-Konstruktor und holen eine Referenz auf das zugehörige AbortSignal-Objekt über die AbortController.signal-Eigenschaft.

Wenn die Fetch-Anfrage gestartet wird, übergeben wir das AbortSignal als Option im Optionsobjekt der Anfrage (das {signal} unten). Dies verknüpft das Signal und den Controller mit der Fetch-Anfrage und ermöglicht es uns, sie abzubrechen, indem wir AbortController.abort() aufrufen, wie unten im zweiten Event-Listener zu sehen ist.

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

const url = "video.mp4";
const downloadBtn = document.querySelector(".download");
const abortBtn = document.querySelector(".abort");

downloadBtn.addEventListener("click", fetchVideo);

abortBtn.addEventListener("click", () => {
  controller.abort();
  console.log("Download aborted");
});

function fetchVideo() {
  fetch(url, { signal })
    .then((response) => {
      console.log("Download complete", response);
    })
    .catch((err) => {
      console.error(`Download error: ${err.message}`);
    });
}

Hinweis: Wenn abort() aufgerufen wird, lehnt das fetch()-Versprechen mit einem Error vom Typ DOMException mit dem Namen AbortError ab.

Ein voll funktionsfähiges Beispiel finden Sie auf GitHub; Sie können es sich auch live ansehen.

Spezifikationen

Specification
DOM Standard # ref-for-dom-abortcontroller-abortcontroller①

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch

Fetch API