Biblioteca de clientes do Controlador de Anulação do Azure para JavaScript – versão 2.1.2
O @azure/abort-controller
pacote fornece AbortSignalLike
interface e AbortError
classes para facilitar o trabalho com o AbortController e o AbortSignal
usado pelo fetch integrado a plataformas JavaScript modernas.
Os clientes do SDK do Azure para JavaScript em geral não precisam usar essa biblioteca. Em vez disso, eles usam AbortController
e AbortSignal
são fornecidos por suas plataformas e transmitem os sinais de anulação para as operações do SDK do Azure.
Links principais:
Introdução
Instalação
Instale essa biblioteca usando o npm da seguinte maneira
npm install @azure/abort-controller
Conceitos Principais
Use AbortController
para criar um AbortSignal
que pode ser passado para operações do SDK do Azure para cancelar o trabalho pendente. O AbortSignal
pode ser acessado por meio da propriedade signal
em uma instância criada de AbortController
.
Um AbortSignal
também pode ser retornado diretamente de um método estático, por exemplo, AbortSignal.timeout(100)
.
que é cancelado após 100 milissegundos.
Exemplos
Os exemplos abaixo pressupõem que doAsyncWork
seja uma função que usa um conjunto de propriedades, e uma delas é o sinal de anulação.
Exemplo 1 – Uso básico
const controller = new AbortController();
doAsyncWork({ abortSignal: controller.signal });
// at some point later
controller.abort();
Exemplo 2 – Anular com tempo limite
const signal = AbortSignal.timeout(1000);
doAsyncWork({ abortSignal: signal });
Próximas etapas
Você pode criar e executar os testes localmente executando rushx test
. Explore a pasta test
para ver o uso e o comportamento avançados das classes públicas.
Solução de problemas
Se você tiver problemas ao usar essa biblioteca, fique à vontade para registrar um problema.
Contribuição
Se você quiser contribuir com essa biblioteca, leia o guia de contribuição para saber como criar e testar o código.
Azure SDK for JavaScript