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

Article
04/11/2024

Il s’agit de l’implémentation par défaut d’opérations de longue durée dans les bibliothèques clientes JavaScript du 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 :

Prise en main

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é ; il n’est pas destiné à être consommé directement par les utilisateurs finaux.

Concepts clés

`SimplePollerLike`

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

getOperationState: retourne l’état de l’opération, tapé comme un 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: enregistre 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 se résout 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. Il est accessible comme suit :

switch(poller.getOperationState().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 pollneur se comporte comme suit en présence d’erreurs :

appelle à poll et pollUntilDone génère une erreur en cas d’échec ou d’annulation de l’opération, 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 qu’elle retourne une réponse d’erreur.

Exemples

Vous trouverez des exemples dans le dossier samples.

Résolution des problèmes

Journalisation

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

Étapes suivantes

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

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.

Test

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 Open Source de Microsoft. Pour plus d’informations, consultez les Questions fréquentes (FAQ) sur le code de conduite ou envoyez vos questions ou vos commentaires à opencode@microsoft.com.

Impressions

Partager via