Azure Abort Controller client library per JavaScript - versione 2.2.0

Il @azure/abort-controller pacchetto fornisce AbortSignalLike un'interfaccia e AbortError classi per facilitare il lavoro con l'AbortController e il AbortSignalfetch utilizzato da By integrato nelle piattaforme JavaScript moderne.

I clienti di Azure SDK per JavaScript in generale non sono obbligati a utilizzare questa libreria. Invece usano AbortController e AbortSignal vengono forniti dalle loro piattaforme e trasmettono i segnali di aborto alle operazioni Azure SDK.

Collegamenti chiave:

Come iniziare

Installazione

Installare questa libreria utilizzando npm come segue

npm install @azure/abort-controller

Concetti chiave

Usare AbortController per creare un AbortSignal dispositivo che può poi essere passato alle operazioni Azure SDK per cancellare lavori in sospeso. Può AbortSignal essere accessibile tramite la signal proprietà su un .AbortController An AbortSignal può anche essere restituito direttamente da un metodo statico, ad esempio AbortSignal.timeout(100). Che viene cancellato dopo 100 millisecondi.

Examples

Gli esempi seguenti assumono che doAsyncWork sia una funzione che assume una serie di proprietà, una delle quali è il segnale di aborto.

Esempio 1 - uso di base

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();

Esempio 2 - Aborto con 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 });

Passaggi successivi

È possibile compilare ed eseguire i test in locale eseguendo npm run test. Esplorare la cartella test per visualizzare l'utilizzo e il comportamento avanzati delle classi pubbliche.

Risoluzione dei problemi

Se incontri problemi durante l'uso di questa libreria, sentiti libero di segnalare un problema.

Contributing

Per contribuire a questa libreria, leggere la guida contribuire per altre informazioni su come compilare e testare il codice.