Azure Abort Controller client library for JavaScript - verze 2.2.0

Balíček @azure/abort-controller poskytuje AbortSignalLike rozhraní a třídy, které AbortError usnadňují práci s AbortControllerem a je použitý AbortSignalfetch zabudovaný v moderních JavaScriptových platformách.

Zákazníci Azure SDK pro JavaScript obecně tuto knihovnu používat nemusí. Místo toho používají AbortController a AbortSignal poskytují své platformy a předávají signály přerušení operacím Azure SDK.

Klíčové odkazy:

Začínáme

Instalace

Nainstalujte tuto knihovnu pomocí npm následujícím způsobem

npm install @azure/abort-controller

Klíčové koncepty

Použijte AbortController k vytvoření , AbortSignal které lze pak předat operacím Azure SDK pro zrušení čekající práce. K lze AbortSignal přistupovat přes vlastnost signal na instancovaném AbortController. An AbortSignal lze také vrátit přímo ze statické metody, např. AbortSignal.timeout(100). To je zrušeno po 100 milisekundách.

Příklady

Níže uvedené příklady předpokládají, že doAsyncWork je funkcí, která nabývá pytle vlastností, z nichž jedna je signálu přerušení.

Příklad 1 – základní použití

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říklad 2 – Přerušení s timeoutem

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

  // do async work
}

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

Další kroky

Testy můžete sestavit a spustit místně spuštěním npm run test. Prozkoumejte složku test a podívejte se na pokročilé využití a chování veřejných tříd.

Troubleshooting

Pokud při používání této knihovny narazíte na problémy, neváhejte efile issue.

Contributing

Pokud chcete přispívat do této knihovny, přečtěte si průvodce přispívání a přečtěte si další informace o vytváření a testování kódu.

  • Last updated on