Azure Abort Controller Client-Bibliothek für JavaScript – Version 2.2.0

Das @azure/abort-controller Paket bietet AbortSignalLike eine Schnittstelle und AbortError Klassen, die die Arbeit mit dem AbortController erleichtern und die AbortSignal in moderne JavaScript-Plattformen integrierte Fetch verwenden.

Kunden des Azure SDK für JavaScript im Allgemeinen müssen diese Bibliothek nicht verwenden. Stattdessen nutzen AbortController und AbortSignal liefern sie ihre Plattformen und leiten die Abbruchsignale an die Azure SDK-Operationen weiter.

Wichtige Links:

Erste Schritte

Installation

Installieren Sie diese Bibliothek mit npm wie folgt

npm install @azure/abort-controller

Wichtige Konzepte

Verwenden AbortController Sie, um ein AbortSignal zu erstellen, das dann an die Azure SDK-Operationen weitergegeben werden kann, um ausstehende Arbeit abzubrechen. Die können AbortSignal über die signal Eigenschaft auf einem instanziierten AbortControllerZugriff erfolgen. An AbortSignal kann auch direkt aus einer statischen Methode zurückgegeben werden, z. B. AbortSignal.timeout(100). das wird nach 100 Millisekunden aufgehoben.

Beispiele

Die untenstehenden Beispiele nehmen an, dass doAsyncWork eine Funktion ist, die einen Beutel von Eigenschaften annimmt, von denen eine das Abbruchsignal ist.

Beispiel 1 – Grundgebrauch

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

Beispiel 2 – Abbruch mit Auszeit

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

  // do async work
}

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

Nächste Schritte

Sie können die Tests lokal erstellen und ausführen, indem Sie npm run testausführen. Erkunden Sie den Ordner test, um die erweiterte Verwendung und das Verhalten der öffentlichen Klassen anzuzeigen.

Problembehandlung

Wenn Sie bei der Nutzung dieser Bibliothek auf Probleme stoßen, können Sie gerne ein Problem einreichen.

Contributing

Wenn Sie an dieser Bibliothek mitwirken möchten, lesen Sie bitte den mitwirkenden Leitfaden, um mehr über das Erstellen und Testen des Codes zu erfahren.

  • Last updated on