AbortSignal: abort() statische 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 AbortSignal.abort() statische Methode gibt ein AbortSignal zurück, das bereits als abgebrochen gesetzt ist (und das kein abort Ereignis auslöst).

Dies ist eine Kurzform für den folgenden Code:

js
const controller = new AbortController();
controller.abort();
return controller.signal;

Dies könnte zum Beispiel an eine fetch-Methode übergeben werden, um deren Abbruch-Logik auszuführen (d.h. es könnte sein, dass der Code so organisiert ist, dass die Abbruch-Logik ausgeführt werden sollte, auch wenn der beabsichtigte fetch-Vorgang noch nicht gestartet wurde).

Hinweis: Die Methode ist ähnlich in der Absicht zu Promise.reject.

Syntax

js
AbortSignal.abort()
AbortSignal.abort(reason)

Parameter

reason

Der Grund, warum die Operation abgebrochen wurde, der jeder JavaScript-Wert sein kann. Wenn nicht angegeben, wird der Grund auf "AbortError" DOMException gesetzt.

Rückgabewert

Eine AbortSignal Instanz mit der AbortSignal.aborted Eigenschaft auf true gesetzt und AbortSignal.reason auf den angegebenen oder Standardgrundwert gesetzt.

Spezifikationen

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

Browser-Kompatibilität

BCD tables only load in the browser