Azure Abort Controller biblioteca cliente para JavaScript - versão 2.2.0

O @azure/abort-controller pacote fornece AbortSignalLike interface e AbortError classes para facilitar o trabalho com o AbortController e o AbortSignalfetch usado por integrados em plataformas JavaScript modernas.

Os clientes do SDK do Azure para JavaScript em geral não precisam de usar esta biblioteca. Em vez disso, utilizam AbortController e AbortSignal são fornecidos pelas suas plataformas e transmitem os sinais de aborto para as operações do SDK do Azure.

Ligações principais:

Como Começar

Instalação

Instale esta biblioteca usando npm da seguinte maneira:

npm install @azure/abort-controller

Conceitos-chave

Use AbortController para criar um AbortSignal que pode depois ser passado para operações do SDK do Azure para cancelar trabalhos pendentes. O AbortSignal pode ser acedido através da signal propriedade em um instanciado AbortController. An 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 assumem que doAsyncWork é uma função que recebe um conjunto de propriedades, uma das quais é o sinal de aborto.

Exemplo 1 - uso básico

async function doAsyncWork(options: { abortSignal: AbortSignal }): Promise<void> {
  if (options.abortSignal.aborted) {
    return;
  }

  // do async work
}

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

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

Exemplo 2 - Abortar com timeout

async function doAsyncWork(options: { abortSignal: AbortSignal }): Promise<void> {
  if (options.abortSignal.aborted) {
    return;
  }

  // do async work
}

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

Passos seguintes

Você pode criar e executar os testes localmente executando npm run test. Explore a pasta test para ver o uso avançado e o comportamento das classes públicas.

Troubleshooting

Se tiver problemas ao usar esta biblioteca, sinta-se à vontade para apresentar uma questão.

Contributing

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

  • Last updated on