Compartilhar via

Biblioteca de clientes LRO do Azure Core para JavaScript – versão 2.7.2

  • Artigo

Essa é a implementação padrão de operações de execução prolongada em bibliotecas de clientes JavaScript do SDK do Azure que funcionam no navegador e no NodeJS. Essa biblioteca deve ser usada principalmente no código gerado pelo AutoRest e o autorest.typescript.

@azure/core-lro segue as diretrizes de design do SDK do Azure para operações de execução prolongada

Links principais:

Introdução

Ambientes com suporte no momento

Instalação

Este pacote é usado principalmente no código gerado e não deve ser consumido diretamente pelos usuários finais.

Principais conceitos

SimplePollerLike

Um sondador é um objeto que pode sondar a operação de execução prolongada no servidor para seu estado até atingir um estado terminal. Ele fornece os seguintes métodos:

  • getOperationState: retorna o estado da operação, digitado como um tipo que estende OperationState
  • getResult: retorna o resultado da operação quando ela é concluída e undefined , caso contrário,
  • isDone: retorna se a operação está em um estado terminal
  • isStopped: retorna se a sondagem parou
  • onProgress: registra funções de retorno de chamada a serem chamadas sempre que uma resposta de sondagem é recebida
  • poll: envia uma única solicitação de sondagem
  • pollUntilDone: retorna uma promessa que resolve com o resultado da operação
  • stopPolling: interrompe a sondagem;
  • toString: serializa o estado do poller

OperationState

Um tipo para o estado da operação. Ele contém um status campo com os seguintes valores possíveis: notStarted, running, succeeded, failede canceled. Ele pode ser acessado da seguinte maneira:

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

Uma função que retorna um objeto do tipo SimplePollerLike. Este sondador se comporta da seguinte maneira na presença de erros:

  • chama para poll e pollUntilDone gerará um erro caso a operação tenha falhado ou cancelado, a menos que a opção resolveOnUnsuccessful tenha sido definida como true.
  • poller.getOperationState().status será definido como true quando a operação falhar ou retornar uma resposta de erro.

Exemplos

Veja exemplos na pasta samples.

Solução de problemas

Log

Os logs podem ser adicionados a critério da biblioteca que implementa o sondador de Operação de Execução Longa. Os pacotes dentro do azure-sdk-for-js usam @azure/agente.

Próximas etapas

Examine o diretório de exemplos para obter exemplos detalhados sobre como usar essa biblioteca.

Contribuição

Se você quiser contribuir com essa biblioteca, leia o guia de contribuição para saber como criar e testar o código.

Testando

Para executar nossos testes, primeiro instale as dependências (com npm install ou rush install), depois execute os testes de unidade com: npm run unit-test.

Código de Conduta

Este projeto adotou o Código de Conduta de Software Livre da Microsoft. Para obter mais informações, confira as Perguntas frequentes sobre o Código de Conduta ou contate opencode@microsoft.com para enviar outras perguntas ou comentários.

Impressões