AbortSignal : méthode statique abort()
Baseline
Widely available
Cette fonctionnalité est bien établie et fonctionne sur de nombreux appareils et versions de navigateurs. Elle est disponible sur tous les navigateurs depuis septembre 2021.
Note : Cette fonctionnalité est disponible via les Web Workers.
La méthode statique abort() de l'interface AbortSignal retourne un objet AbortSignal déjà à l'état annulé (et qui ne déclenche pas d'évènement abort).
Ceci est un raccourci pour le code suivant :
const controller = new AbortController();
controller.abort();
return controller.signal;
Cela peut, par exemple, être passé à une méthode fetch afin d'exécuter sa logique d'annulation (c'est-à-dire que le code peut être organisé de sorte que la logique d'annulation doive être exécutée même si l'opération fetch prévue n'a pas été lancée).
Note :
Cette méthode a un objectif similaire à Promise.reject.
Syntaxe
AbortSignal.abort()
AbortSignal.abort(reason)
Paramètres
reason-
La raison pour laquelle l'opération a été annulée, qui peut être n'importe quelle valeur JavaScript. Si elle n'est pas spécifiée, la raison est définie sur
DOMException"AbortError".
Valeur de retour
Une instance d'AbortSignal avec la propriété AbortSignal.aborted définie sur true, et AbortSignal.reason définie à la valeur de raison définie ou par défaut.
Spécifications
| Specification |
|---|
| DOM # ref-for-dom-abortsignal-abort① |