Azure Abort Controller client library for JavaScript - version 2.2.0

Pakiet @azure/abort-controller oferuje AbortSignalLike interfejs i klasy, które AbortError ułatwiają pracę z AbortController oraz wbudowane AbortSignal w nowoczesne platformy JavaScript używanego przez fetch .

Klienci Azure SDK dla JavaScript generalnie nie muszą korzystać z tej biblioteki. Zamiast tego korzystają z AbortControllerAbortSignal usług i dostarczają ich platformy, przekazując sygnały przerwania do operacji Azure SDK.

Kluczowe linki:

Rozpoczęcie pracy

Instalacja

Zainstaluj tę bibliotekę za pomocą npm w następujący sposób

npm install @azure/abort-controller

Kluczowe pojęcia

Użyj AbortController do utworzenia , AbortSignal który może być następnie przekazany operacjom Azure SDK, aby anulować oczekujące prace. Można AbortSignal uzyskać dostęp przez własność signal na instancji AbortController. An AbortSignal można również zwrócić bezpośrednio ze statycznej metody, np. AbortSignal.timeout(100). To zostaje anulowane po 100 milisekundach.

Examples

Poniższe przykłady zakładają, że jest doAsyncWork funkcją przyjmującą worek własności, z których jedna to sygnał przerwania.

Przykład 1 – podstawowe użycie

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

Przykład 2 – Przerwanie przerwy z przerwą na czas

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

  // do async work
}

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

Następne kroki

Testy można kompilować i uruchamiać lokalnie, wykonując npm run test. Zapoznaj się z folderem test, aby zobaczyć zaawansowane użycie i zachowanie klas publicznych.

Troubleshooting

Jeśli napotkasz problemy podczas korzystania z tej biblioteki, śmiało zgłaszaj zgłoś problem.

Contributing

Jeśli chcesz współtworzyć tę bibliotekę, przeczytaj przewodnik dotyczący współtworzenia , aby dowiedzieć się więcej na temat tworzenia i testowania kodu.

  • Last updated on