Partilhar via


Biblioteca de cliente Azure Abort Controller 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 utilizado pela obtenção incorporada em plataformas JavaScript modernas.

Os clientes do SDK do Azure para JavaScript em geral não precisam de utilizar esta biblioteca. Em vez disso, utilizam AbortController e AbortSignal fornecem as respetivas plataformas e transmitem os sinais de abortação para as operações do SDK do Azure.

Ligações principais:

Introdução

Instalação

Instale esta biblioteca com o npm da seguinte forma

npm install @azure/abort-controller

Conceitos-chave

Utilize AbortController para criar um AbortSignal que pode ser passado para as operações do SDK do Azure para cancelar trabalho pendente. O AbortSignal pode ser acedido através da signal propriedade num AbortController. Um AbortSignal também pode ser devolvido diretamente a partir de um método estático, por exemplo, AbortSignal.timeout(100). que é cancelado após 100 milissegundos.

Exemplos

Os exemplos abaixo partem do princípio de que doAsyncWork se trata de uma função que utiliza um saco de propriedades, uma das quais é do sinal de abortar.

Exemplo 1 - utilização básica

const controller = new AbortController();
doAsyncWork({ abortSignal: controller.signal });

// at some point later
controller.abort();

Exemplo 2 – Abortar com o tempo limite

const signal = AbortSignal.timeout(1000);
doAsyncWork({ abortSignal: signal });

Passos seguintes

Pode criar e executar os testes localmente ao executar rushx test. Explore a test pasta para ver a utilização e o comportamento avançados das classes públicas.

Resolução de problemas

Se tiver problemas ao utilizar esta biblioteca, não hesite em apresentar um problema.

Contribuir

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

Impressões