Azure Abort Controller-Clientbibliothek für JavaScript – Version 2.1.2

Das @azure/abort-controller Paket stellt AbortSignalLike Schnittstellen und AbortError Klassen bereit, um die Arbeit mit dem AbortController und dem AbortSignal in modernen JavaScript-Plattformen integrierten Abruf zu erleichtern.

Kunden des Azure SDK für JavaScript müssen diese Bibliothek im Allgemeinen nicht verwenden. Stattdessen verwenden AbortController sie und AbortSignal werden von ihren Plattformen bereitgestellt und übergeben die Abbruchsignale an Azure SDK-Vorgänge.

Wichtige Links:

• Quellcode
• Paket (npm)
• API-Referenzdokumentation

Erste Schritte

Installation

Installieren Sie diese Bibliothek mithilfe von npm wie folgt

npm install @azure/abort-controller

Wichtige Konzepte

Verwenden Sie AbortController , um eine AbortSignal zu erstellen, die dann an Azure SDK-Vorgänge übergeben werden kann, um ausstehende Arbeiten abzubrechen. Auf AbortSignal kann über die signal-Eigenschaft für einen instanziierten AbortController zugegriffen werden. Ein AbortSignal kann auch direkt von einer statischen Methode zurückgegeben werden, z. B. AbortSignal.timeout(100) , die nach 100 Millisekunden abgebrochen wird.

Beispiele

Die folgenden Beispiele gehen davon aus, dass doAsyncWork eine Funktion ist, die eine Reihe von Eigenschaften akzeptiert, von denen eine das Abbruchsignal ist.

Beispiel 1: grundlegende Verwendung

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

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

Beispiel 2: Abbruch mit Timeout

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

Nächste Schritte

Sie können die Tests lokal entwickeln und ausführen, indem Sie rushx test ausführen. Erkunden Sie den Ordner test, um die erweiterte Nutzung und das Verhalten der öffentlichen Klassen kennenzulernen.

Problembehandlung

Wenn bei Nutzung dieser Bibliothek Probleme auftreten, können Sie uns gerne ein Problem melden.

Mitwirken

Wenn Sie an dieser Bibliothek mitwirken möchten, lesen Sie die Anleitung für Mitwirkende, um mehr darüber zu erfahren, wie Sie den Code erstellen und testen können.