AbortSignal : propriété reason
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 mars 2022.
Note : Cette fonctionnalité est disponible via les Web Workers.
La propriété en lecture seule reason de l'interface AbortSignal retourne une valeur JavaScript qui indique la raison de l'annulation.
La propriété vaut undefined lorsque le signal n'a pas été annulé.
Elle peut être définie à une valeur spécifique lorsque le signal est annulé, en utilisant AbortController.abort() ou AbortSignal.abort().
Si elle n'est pas explicitement définie dans ces méthodes, elle prend la valeur par défaut DOMException "AbortError".
Valeur
Une valeur JavaScript qui indique la raison de l'annulation, ou undefined si le signal n'est pas annulé.
Exemples
Dans l'extrait suivant, nous créons un nouvel objet AbortController et récupérons son AbortSignal (disponible via la propriété signal).
Ensuite, à l'aide de la propriété aborted, nous vérifions si le signal a été annulé et affichons le statut d'annulation et la raison dans la console.
const controller = new AbortController();
const signal = controller.signal;
// …
if (signal.aborted) {
if (signal.reason) {
console.log(`Requête annulée avec la raison : ${signal.reason}`);
} else {
console.log("Requête annulée mais aucune raison n'a été fournie.");
}
} else {
console.log("La requête n'est pas annulée");
}
Spécifications
| Specification |
|---|
| DOM # ref-for-dom-abortsignal-reason① |