Condividi tramite

Libreria client LRO di Azure Core per JavaScript - versione 3.3.1

Si tratta dell'implementazione predefinita di operazioni a esecuzione prolungata nelle librerie client JavaScript di Azure SDK che funzionano sia nel browser che in NodeJS. Questa libreria è destinata principalmente all'uso nel codice generato da AutoRest e autorest.typescript.

@azure/core-lro segue Le linee guida per la progettazione di Azure SDK per le operazioni a esecuzione prolungata

Collegamenti chiave:

Come iniziare

Ambienti attualmente supportati

Installazione

Questo pacchetto viene usato principalmente nel codice generato e non deve essere utilizzato direttamente dagli utenti finali.

Concetti chiave

SimplePollerLike

Un poller è un oggetto che può eseguire il polling dell'operazione a esecuzione prolungata nel server per il relativo stato fino a raggiungere uno stato terminale. Fornisce i metodi seguenti:

  • getOperationState: restituisce lo stato dell'operazione, tipizzato come tipo che estende OperationState
  • getResult: restituisce il risultato dell'operazione al termine e in caso contrario.undefined
  • isDone: restituisce un valore che indica se l'operazione si trova in uno stato terminale
  • isStopped: restituisce se il polling è stato arrestato
  • onProgress: registra le funzioni di callback da chiamare ogni volta che viene ricevuta una risposta di polling
  • poll: invia una singola richiesta di polling
  • pollUntilDone: restituisce una promessa che verrà risolta con il risultato dell'operazione
  • stopPolling: arresta il polling;
  • toString: serializza lo stato del poller

OperationState

Tipo per lo stato dell'operazione. Contiene un status campo con i valori possibili seguenti: notStarted, running, succeededfailed, e canceled. È possibile accedervi come segue:

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

Funzione che restituisce un oggetto di tipo SimplePollerLike. Questo poller si comporta come segue in presenza di errori:

  • le chiamate a poll e pollUntilDone genereranno un errore nel caso in cui l'operazione non sia riuscita o annullata a meno che l'opzione resolveOnUnsuccessful non sia stata impostata su true.
  • poller.getOperationState().status verrà impostato su true quando l'operazione ha esito negativo o restituisce una risposta di errore.

Esempi

Gli esempi sono disponibili nella cartella samples.

Risoluzione dei problemi

Registrazione

I log possono essere aggiunti a discrezione della libreria che implementa il poller operazione a esecuzione prolungata. I pacchetti all'interno di azure-sdk-for-js usano @azure/logger.

Passaggi successivi

Per esempi dettagliati su come usare questa libreria, vedere gli esempi di directory.

Contribuire

Per contribuire a questa libreria, leggere la guida contribuire per altre informazioni su come compilare e testare il codice.

Prova

Per eseguire i nostri test, installa prima le dipendenze (con pnpm install), quindi esegui gli unit test con: npm run unit-test.

Codice di condotta

Questo progetto ha adottato il codice di comportamento Open Source di Microsoft. Per altre informazioni, vedere domande frequenti sul codice di comportamento o contattare opencode@microsoft.com con eventuali domande o commenti aggiuntivi.

  • Last updated on