Azure Abort Controller client library for JavaScript - version 2.2.0

A @azure/abort-controller csomag interfészt és AbortError osztályokat biztosítAbortSignalLike, amelyek megkönnyítik az AbortController használatát és AbortSignal a modern JavaScript platformokba beépített fetch használatát.

Az Azure SDK JavaScript ügyfeleinek általában nem kell ezt a könyvtárat használniuk. Ehelyett platformjaik által AbortController biztosított jeleket használják és AbortSignal biztosítják, és továbbítják az abortációs jeleket az Azure SDK műveleteknek.

Főbb hivatkozások:

Kezdő lépések

Telepítés

Telepítse ezt a könyvtárat az npm használatával az alábbiak szerint

npm install @azure/abort-controller

Alapfogalmak

Használd AbortController egy AbortSignal olyan létrehozására, amit aztán át lehet adni az Azure SDK műveleteknek, hogy lemondja a függőben lévő munkákat. Elérhető AbortSignal az signal ingatlanon keresztül egy instantív AbortController. An AbortSignal közvetlenül vissza is adható statikus módszerből, például AbortSignal.timeout(100). Ez 100 milliszekundum után törlődik.

Examples

Az alábbi példák feltételezik, hogy doAsyncWork egy olyan függvény, amely egy zsák tulajdonságot vesz fel, amelyek közül az egyik az megszakítási jel.

1. példa – alapvető használat

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

Példa 2 – Időkorláttal való megszakítás

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

  // do async work
}

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

További lépések

A teszteket helyileg hozhatja létre és futtathatja a npm run testvégrehajtásával. A test mappában megtekintheti a nyilvános osztályok speciális használatát és viselkedését.

Hibaelhárítás

Ha problémákba ütközik a könyvtár használatakor, nyugodtan betöltsd a problémát.

Contributing

Ha hozzá szeretne járulni ehhez a kódtárhoz, olvassa el a közreműködői útmutatót, amelyből többet is megtudhat a kód összeállításáról és teszteléséről.

  • Last updated on