AbortController: AbortController() Konstruktor

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.

Der AbortController() Konstruktor erstellt eine neue Instanz eines AbortController-Objekts.

Beispiele

Im folgenden Beispielzyklus versuchen wir, ein Video mit der Fetch API herunterzuladen.

Wir erstellen zuerst einen Controller mit dem AbortController() Konstruktor und holen uns dann über die AbortController.signal-Eigenschaft eine Referenz auf das damit verbundene AbortSignal-Objekt.

Wenn die Fetch-Anfrage gestartet wird, übergeben wir das AbortSignal als Option innerhalb des Optionsobjekts 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, wird das fetch()-Versprechen mit einem AbortError abgelehnt.

Ein vollständiges, funktionierendes Beispiel finden Sie auf GitHub; Sie können es 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