Uwaga
Dostęp do tej strony wymaga autoryzacji. Może spróbować zalogować się lub zmienić katalogi.
Dostęp do tej strony wymaga autoryzacji. Możesz spróbować zmienić katalogi.
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 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:
- kod źródłowy
- Pakiet (npm)
- Dokumentacja referencyjna interfejsu API
- Próbki
Wprowadzenie
Obecnie obsługiwane środowiska
- Wersje LTS Node.js
- Najnowsze wersje przeglądarek Safari, Chrome, Edge i Firefox.
Instalacja
Ten pakiet jest używany głównie w generowanym kodzie i nie jest przeznaczony do bezpośredniego użycia przez użytkowników końcowych.
Najważniejsze pojęcia
SimplePollerLike
Poller jest obiektem, który może sondować długotrwałą operację na serwerze pod kątem jego stanu, dopóki nie osiągnie stanu terminalu. Udostępnia ona następujące metody:
-
getOperationState
: zwraca stan operacji, wpisany jako typ, który rozszerzaOperationState
-
getResult
: zwraca wynik operacji po jej zakończeniu iundefined
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 zostanie odebrana 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
, , succeeded
running
, failed
i canceled
. Dostęp do niego można uzyskać w następujący sposób:
switch (poller.operationState.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 element poller zachowuje się w następujący sposób w obecności błędów:
- wywołania metody
poll
ipollUntilDone
wyrzucą błąd w przypadku niepowodzenia lub anulowania operacji, chyba żeresolveOnUnsuccessful
opcja została ustawiona na true. -
poller.getOperationState().status
zostanie ustawiona 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
Przemysł drzewny
Dzienniki można dodawać według uznania biblioteki implementowania narzędzia Long Running Operation poller. Pakiety wewnątrz zestawu azure-sdk-for-js używają @azure/rejestratora.
Następne kroki
Zapoznaj się z przykładami katalogu, aby zapoznać się ze szczegółowymi przykładami dotyczącymi korzystania z tej biblioteki.
Wkład
Jeśli chcesz współtworzyć tę bibliotekę, przeczytaj przewodnik dotyczący współtworzenia , aby dowiedzieć się więcej na temat tworzenia i testowania kodu.
Testowanie
Aby uruchomić nasze testy, najpierw zainstaluj zależności (z npm install
programem lub rush install
), a następnie uruchom testy jednostkowe za pomocą polecenia: npm run unit-test
.
Kodeks postępowania
Ten projekt przyjął kodeks postępowania otwartego firmy Microsoft . Aby uzyskać więcej informacji, zobacz Kodeks postępowania — często zadawane pytania lub skontaktuj się z opencode@microsoft.com z dodatkowymi pytaniami lub komentarzami.
Azure SDK for JavaScript