AbortSignal: abort() statische Methode
Baseline
Weitgehend verfügbar
Diese Funktion ist gut etabliert und funktioniert auf vielen Geräten und in vielen Browserversionen. Sie ist seit September 2021 browserübergreifend verfügbar.
Hinweis: Diese Funktion ist in Web Workers verfügbar.
Die statische Methode AbortSignal.abort() gibt ein AbortSignal zurück, das bereits auf abgebrochen gesetzt ist (und kein abort-Ereignis auslöst).
Dies ist eine Abkürzung für den folgenden Code:
const controller = new AbortController();
controller.abort();
return controller.signal;
Dies könnte beispielsweise an eine fetch-Methode übergeben werden, um deren Abbruchlogik auszuführen (das heißt, es kann sein, dass der Code so organisiert ist, dass die Abbruchlogik ausgeführt werden sollte, selbst wenn der beabsichtigte Abrufvorgang noch nicht gestartet wurde).
Hinweis:
Die Methode ähnelt in ihrem Zweck Promise.reject.
Syntax
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"
DOMExceptiongesetzt.
Rückgabewert
Eine AbortSignal-Instanz mit der Eigenschaft AbortSignal.aborted auf true gesetzt, und AbortSignal.reason auf den angegebenen oder Standardwert des Grundes gesetzt.
Spezifikationen
| Spezifikation |
|---|
| DOM # ref-for-dom-abortsignal-abort① |