From c05efa8d7ae464235cf83d7c0956e42dc6974103 Mon Sep 17 00:00:00 2001 From: julieng Date: Sat, 2 Oct 2021 17:20:14 +0200 Subject: move *.html to *.md --- files/fr/web/api/abortsignal/index.html | 98 --------------------------------- 1 file changed, 98 deletions(-) delete mode 100644 files/fr/web/api/abortsignal/index.html (limited to 'files/fr/web/api/abortsignal/index.html') diff --git a/files/fr/web/api/abortsignal/index.html b/files/fr/web/api/abortsignal/index.html deleted file mode 100644 index 11a48ef3d1..0000000000 --- a/files/fr/web/api/abortsignal/index.html +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: AbortSignal -slug: Web/API/AbortSignal -tags: - - API - - AbortSignal - - DOM - - Interfaces - - Reference -translation_of: Web/API/AbortSignal ---- -
{{APIRef("DOM")}}{{SeeCompatTable}}
- -

L'interface AbortSignal représente un objet signal qui vous permet de communiquer avec une requête DOM (telle que Fetch) et de l'annuler si nécessaire par un objet {{domxref("AbortController")}}.

- -

Propriétés

- -

L'interface AbortSignal hérite des propriétés de son interface parent {{domxref("EventTarget")}}.

- -
-
{{domxref("AbortSignal.aborted")}} {{readonlyInline}}
-
Un {{domxref("Boolean")}} (booléen) qui indique si les requêtes avec lesquelles le signal communique sont annulées (true) ou non (false).
-
- -

Gestionnaire d'évènement

- -
-
{{domxref("AbortSignal.onabort")}}
-
appelé quand un évènement {{event("abort_(dom_abort_api)", "abort")}} est lancé, c'est-à-dire quand les requêtes DOM avec lesquelles le signal communique sont annulées.
-
- -

Méthodes

- -

L'interface AbortSignal hérite des méthodes de son interface parent {{domxref("EventTarget")}}.

- -

Exemples

- -

Dans l'extrait suivant, nous visons à télécharger une vidéo en utilisant l'API Fetch.

- -

Tout d'abord, nous créons un contrôleur en utilisant le constructeur {{domxref("AbortController.AbortController","AbortController()")}}, puis nous saisissons une référence associée à son objet {{domxref("AbortSignal")}} au moyen de la propriété {{domxref("AbortController.signal")}}.

- -

Lorsque la  requête fetch (extraction) est lancée, nous transmettons le paramètre AbortSignal en tant qu'option dans l'objet d'options de la requête (voir {signal} ci-dessous). Cela associe le signal et le contrôleur à la requête d'extraction et nous permet de l'annuler en appelant {{domxref("AbortController.abort()")}}, comme indiqué ci-dessous dans le second écouteur d'événements.

- -
var controller = new AbortController();
-var signal = controller.signal;
-
-var downloadBtn = document.querySelector('.download');
-var abortBtn = document.querySelector('.abort');
-
-downloadBtn.addEventListener('click', fetchVideo);
-
-abortBtn.addEventListener('click', function() {
-  controller.abort();
-  console.log('Download aborted');
-});
-
-function fetchVideo() {
-  ...
-  fetch(url, {signal}).then(function(response) {
-    ...
-  }).catch(function(e) {
-    reports.textContent = 'Download error: ' + e.message;
-  })
-}
- -
-

Note : Lorsque abort() est appelé, la réponse fetch() rejette avec une erreur AbortError.

-
- -

vous pouvez trouver un exemple de travail complet sur GitHub — voir abort-api (voir cas d'usage concret).

- -

Spécifications

- - - - - - - - - - - - - - -
SpécificationStatusComment
{{SpecName('DOM WHATWG', '#interface-AbortSignal', 'AbortSignal')}}{{Spec2('DOM WHATWG')}}Définition initiale
- -

Compatibilité des navigateurs

- -

{{Compat("api.AbortSignal")}}

- -

Voir aussi

- - -- cgit v1.2.3-54-g00ecf