Dela via

Azure Abort Controller-klientbibliotek för JavaScript – version 2.1.2

Paketet @azure/abort-controller tillhandahåller AbortSignalLike gränssnitt och AbortError klasser för att göra det enklare att arbeta med AbortController och de AbortSignal som används av fetch inbyggda i moderna JavaScript-plattformar.

Kunder i Azure SDK för JavaScript i allmänhet behöver inte använda det här biblioteket. I stället använder AbortController de och AbortSignal tillhandahålls av sina plattformar och skickar avbrutna signaler till Azure SDK-åtgärder.

Nyckellänkar:

Komma igång

Installation

Installera det här biblioteket med npm enligt följande

npm install @azure/abort-controller

Viktiga begrepp

Använd AbortController för att skapa en AbortSignal som sedan kan skickas till Azure SDK-åtgärder för att avbryta väntande arbete. AbortSignal Kan nås via egenskapen signal på en instansierad AbortController. En AbortSignal kan också returneras direkt från en statisk metod, t.ex. AbortSignal.timeout(100). som avbryts efter 100 millisekunder.

Exempel

I exemplen nedan förutsätter vi att det doAsyncWork är en funktion som tar en påse med egenskaper, varav en är avbruten signal.

Exempel 1 – grundläggande användning

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

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

Exempel 2 – Avbryta med timeout

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

Nästa steg

Du kan skapa och köra testerna lokalt genom att rushx testköra . test Utforska mappen för att se avancerad användning och beteende för de offentliga klasserna.

Felsökning

Om du stöter på problem när du använder det här biblioteket kan du skapa ett problem.

Bidra

Om du vill bidra till det här biblioteket kan du läsa bidragsguiden för att lära dig mer om hur du skapar och testar koden.

Visningar