Udostępnij za pośrednictwem

Biblioteka klienta LRO platformy Azure dla języka JavaScript — wersja 2.7.2

  • Artykuł

Jest to domyślna implementacja długotrwałych operacji w bibliotekach klienta javaScript zestawu Azure SDK, które działają zarówno w przeglądarce, jak i w środowisku NodeJS. Ta biblioteka ma być używana głównie w kodzie generowanym przez funkcję AutoRest i autorest.typescript.

@azure/core-lro postępuje zgodnie z wytycznymi dotyczącymi projektowania zestawu Azure SDK dla długotrwałych operacji

Kluczowe linki:

Wprowadzenie

Obecnie obsługiwane środowiska

Instalacja

Ten pakiet jest używany głównie w generowanym kodzie i nie jest przeznaczony do użycia bezpośrednio przez użytkowników końcowych.

Kluczowe pojęcia

SimplePollerLike

Element poller to obiekt, który może sondować długotrwałą operację na serwerze pod kątem stanu, aż osiągnie stan terminalu. Udostępnia ona następujące metody:

  • getOperationState: zwraca stan operacji, wpisany jako typ, który rozszerza OperationState
  • getResult: zwraca wynik operacji po jej zakończeniu i undefined w inny sposób
  • isDone: zwraca, czy operacja jest w stanie terminalu
  • isStopped: zwraca, czy sondowanie przestało działać
  • onProgress: rejestruje funkcje wywołania zwrotnego, które mają być wywoływane za każdym razem, gdy odbierana jest odpowiedź sondowania
  • poll: wysyła jedno żądanie sondowania
  • pollUntilDone: zwraca obietnicę, która zostanie rozwiązana z wynikiem operacji
  • stopPolling: zatrzymuje sondowanie;
  • toString: serializuje stan poller

OperationState

Typ stanu operacji. Zawiera status pole z następującymi możliwymi wartościami: notStarted, running, succeeded, failedi canceled. Dostęp do niego można uzyskać w następujący sposób:

switch(poller.getOperationState().status) {
  case "succeeded":  // return poller.getResult();
  case "failed":     // throw poller.getOperationState().error;
  case "canceled":   // throw new Error("Operation was canceled");
  case "running":    // ...
  case "notStarted": // ...
}

createHttpPoller

Funkcja zwracająca obiekt typu SimplePollerLike. Ten poller zachowuje się w następujący sposób w obecności błędów:

  • wywołania i pollpollUntilDone zgłosi błąd w przypadku niepowodzenia lub anulowania operacji, chyba że resolveOnUnsuccessful opcja została ustawiona na true.
  • poller.getOperationState().status zostanie ustawiona na wartość true, gdy operacja zakończy się niepowodzeniem lub zwróci odpowiedź o błędzie.

Przykłady

Przykłady można znaleźć w folderze samples .

Rozwiązywanie problemów

Rejestrowanie

Dzienniki można dodać według uznania biblioteki implementowania operacji długotrwałej. Pakiety wewnątrz zestawu azure-sdk-for-js używają @azure/rejestratora.

Następne kroki

Zapoznaj się z katalogiem samples , aby uzyskać szczegółowe przykłady dotyczące sposobu korzystania z tej biblioteki.

Współtworzenie

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

Testowanie

Aby uruchomić nasze testy, najpierw zainstaluj zależności (z npm install systemem lub rush install), a następnie uruchom testy jednostkowe za pomocą polecenia : npm run unit-test.

Kodeks postępowania

W tym projekcie przyjęto Kodeks postępowania oprogramowania Open Source firmy Microsoft. Aby uzyskać więcej informacji, zobacz Często zadawane pytania dotyczące kodeksu postępowania lub skontaktuj się z opencode@microsoft.com dodatkowymi pytaniami lub komentarzami.

Wrażenia