Partager via

Bibliothèque de client Azure Abort Controller pour JavaScript - version 2.1.2

  • Article

Le @azure/abort-controller package fournit une interface et AbortError des AbortSignalLike classes pour faciliter l’utilisation de AbortController et de l’élément AbortSignal utilisé par fetch intégré aux plateformes JavaScript modernes.

Les clients du Kit de développement logiciel (SDK) Azure pour JavaScript n’ont généralement pas besoin d’utiliser cette bibliothèque. Au lieu de cela, ils utilisent AbortController et AbortSignal fournis par leurs plateformes et passent les signaux d’abandon aux opérations du KIT de développement logiciel (SDK) Azure.

Liens clés :

Prise en main

Installation

Installez cette bibliothèque avec npm comme suit :

npm install @azure/abort-controller

Concepts clés

Utilisez AbortController pour créer un AbortSignal qui peut ensuite être passé aux opérations du Kit de développement logiciel (SDK) Azure pour annuler le travail en attente. Vous pouvez accéder à AbortSignal via la propriété signal sur un AbortController instancié. Un AbortSignal peut également être retourné directement à partir d’une méthode statique, par exemple AbortSignal.timeout(100). Son annulation survient au bout de 100 millisecondes.

Exemples

Les exemples ci-dessous supposent que doAsyncWork est une fonction qui accepte plusieurs propriétés, dont l’une est celle du signal d’abandon.

Exemple 1 : utilisation de base

const controller = new AbortController();
doAsyncWork({ abortSignal: controller.signal });

// at some point later
controller.abort();

Exemple 2 : abandon avec délai d’expiration

const signal = AbortSignal.timeout(1000);
doAsyncWork({ abortSignal: signal });

Étapes suivantes

Vous pouvez générer et exécuter les tests localement en exécutant rushx test. Explorez le dossier test pour voir l’utilisation et le comportement avancés des classes publiques.

Résolution des problèmes

Si vous rencontrez des problèmes lors de l’utilisation de cette bibliothèque, n’hésitez pas à signaler un problème.

Contribution

Si vous souhaitez contribuer à cette bibliothèque, lisez le guide de contribution pour en savoir plus sur la génération et le test du code.

Impressions