Biblioteca de cliente LRO do Azure Core para JavaScript - versão 3.0.0

Artigo
07/04/2024

Esta é a implementação padrão de operações de longa execução nas bibliotecas de cliente JavaScript do SDK do Azure que funcionam no navegador e no NodeJS. Esta biblioteca destina-se principalmente a ser usada em código gerado pelo AutoRest e autorest.typescript.

@azure/core-lro segue As Diretrizes de Design do SDK do Azure para Operações de Longa Execução

Ligações principais:

Código fonte
Pacote (npm)
de documentação de referência da API
Amostras

Primeiros passos

Ambientes atualmente suportados

versões LTS do Node.js
Versões mais recentes do Safari, Chrome, Edge e Firefox.

Instalação

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

Conceitos-chave

`SimplePollerLike`

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

getOperationState: retorna o estado da operação, digitado como um tipo que se estende OperationState
getResult: Devolve o resultado da operação quando esta é concluída e undefined outra forma
isDone: Devolve se a operação está num estado terminal
isStopped: devolve se a sondagem parou
onProgress: registra funções de retorno de chamada a serem chamadas toda vez que uma resposta de sondagem é recebida
poll: envia um único pedido de sondagem
pollUntilDone: retorna uma promessa que será resolvida com o resultado da operação
stopPolling: Deixa de votar;
toString: serializa o estado do poller

`OperationState`

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

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 poller comporta-se da seguinte forma na presença de erros:

chamadas para poll e pollUntilDone lançarão um erro caso a operação tenha falhado ou sido cancelada, 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

Exemplos podem ser encontrados na pasta samples.

Solução de problemas

Registo

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

Próximos passos

Por favor, dê uma olhada no exemplos diretório para obter exemplos detalhados sobre como usar esta biblioteca.

Contribuição

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

Testes

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

Código de Conduta

Este projeto adotou o Microsoft Open Source Code of Conduct. Para obter mais informações, consulte o de perguntas frequentes sobre o Código de Conduta ou entre em contato com para obter perguntas ou comentários adicionais.

Impressões

Partilhar via