Bibliothèque de client Azure Core LRO pour JavaScript - version 3.2.0

2025-04-08

Il s’agit de l’implémentation par défaut d’opérations longues dans les bibliothèques clientes JavaScript du Kit de développement logiciel (SDK) Azure qui fonctionnent à la fois dans le navigateur et NodeJS. Cette bibliothèque est principalement destinée à être utilisée dans le code généré par autorest et autorest.typescript.

@azure/core-lro suit les instructions de conception du Kit de développement logiciel (SDK) Azure pour les opérations de longue durée

Liens clés :

code source
package (npm)
Documentation de référence de l’API
Exemples

Mise en route

Environnements actuellement pris en charge

versions LTS de Node.js
Dernières versions de Safari, Chrome, Edge et Firefox.

Installation

Ce package est principalement utilisé dans le code généré et n’est pas destiné à être consommé directement par les utilisateurs finaux.

Concepts clés

`SimplePollerLike`

Un polleur est un objet qui peut interroger l’opération de longue durée sur le serveur pour son état jusqu’à ce qu’il atteigne un état terminal. Il fournit les méthodes suivantes :

getOperationState: retourne l’état de l’opération, typé en tant que type qui s’étend OperationState
getResult: retourne le résultat de l’opération lorsqu’elle se termine et undefined sinon
isDone: retourne si l’opération est dans un état terminal
isStopped: retourne si l’interrogation s’est arrêtée
onProgress: inscrit les fonctions de rappel à appeler chaque fois qu’une réponse d’interrogation est reçue
poll: envoie une requête d’interrogation unique
pollUntilDone: retourne une promesse qui sera résolue avec le résultat de l’opération
stopPolling: arrête l’interrogation ;
toString: sérialise l’état du polleur

`OperationState`

Type pour l’état de l’opération. Il contient un status champ avec les valeurs possibles suivantes : notStarted, , running, succeeded, failedet canceled. Vous pouvez y accéder comme suit :

switch (poller.operationState.status) {
  case "succeeded": // return poller.getResult();
  case "failed": // throw poller.getOperationState().error;
  case "canceled": // throw new Error("Operation was canceled");
  case "running": // ...
  case "notStarted": // ...
}

`createHttpPoller`

Fonction qui retourne un objet de type SimplePollerLike. Cet polleur se comporte comme suit en présence d’erreurs :

les appels vers poll et pollUntilDone lèvent une erreur si l’opération a échoué ou annulée, sauf si l’option resolveOnUnsuccessful a été définie sur true.
poller.getOperationState().status est défini sur true lorsque l’opération échoue ou retourne une réponse d’erreur.

Exemples

Vous trouverez des exemples dans le dossier samples.

Résolution des problèmes

Exploitation forestière

Les journaux peuvent être ajoutés à la discrétion de la bibliothèque qui implémente l’polleur d’opération longue durée. Les packages à l’intérieur d’azure-sdk-for-js utilisent @azure/enregistreur d’événements.

Étapes suivantes

Consultez les exemples répertoire pour obtenir des exemples détaillés sur l’utilisation de cette bibliothèque.

Contribuer

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.

Essai

Pour exécuter nos tests, installez d’abord les dépendances (avec npm install ou rush install), puis exécutez les tests unitaires avec : npm run unit-test.

Code de conduite

Ce projet a adopté le code de conduite Microsoft Open Source. Pour plus d’informations, consultez le forum aux questions du Code de conduite ou contactez avec des questions ou commentaires supplémentaires.

Partager via