@azure/core-lro package

Klasy

LroEngine	Aparat LRO, klasa, która wykonuje sondowanie.
Poller	Klasa reprezentująca definicję programu, który sonduje kolejne żądania, dopóki nie osiągnie stanu ukończenia. Poller można wykonać ręcznie, sondując żądanie przez żądanie, wywołując poll() metodę wielokrotnie, aż jej operacja zostanie ukończona. Zapewnia również możliwość oczekiwania na zakończenie operacji przez wywołanie pollUntilDone() i oczekiwanie na zakończenie operacji. Ankieterzy mogą również zażądać anulowania trwającego procesu, do którego jest dostarczana podstawowa długotrwała operacja. const poller = new MyPoller(); // Polling just once: await poller.poll(); // We can try to cancel the request here, by calling: // // await poller.cancelOperation(); // // Getting the final result: const result = await poller.pollUntilDone(); Poller jest definiowany przez dwa typy, typ reprezentujący stan poller, który musi zawierać podstawowy zestaw właściwości z PollOperationState<TResult>, i typ zwracany zdefiniowany przez TResult, który może być dowolny. Klasa Poller implementuje PollerLike interfejs, który umożliwia implementacje poller uniknąć konieczności bezpośredniego eksportowania klasy Poller, a zamiast tego eksportować tylko utworzone wystąpienie poller z typem PollerLike. class Client { public async makePoller: PollerLike<MyOperationState, MyResult> { const poller = new MyPoller({}); // It might be preferred to return the poller after the first request is made, // so that some information can be obtained right away. await poller.poll(); return poller; } } const poller: PollerLike<MyOperationState, MyResult> = myClient.makePoller(); Poller można utworzyć za pomocą jego konstruktora, a następnie można go sondować, dopóki nie zostanie ukończony. W dowolnym momencie stan poller można uzyskać bez zwłoki za pomocą metody getOperationState. W dowolnym momencie można zażądać pośrednich formularzy typu wyników bez opóźnień. Gdy operacja bazowa zostanie oznaczona jako ukończona, poller zostanie zatrzymany, a końcowa wartość zostanie zwrócona. const poller = myClient.makePoller(); const state: MyOperationState = poller.getOperationState(); // The intermediate result can be obtained at any time. const result: MyResult | undefined = poller.getResult(); // The final result can only be obtained after the poller finishes. const result: MyResult = await poller.pollUntilDone();
PollerCancelledError	Po anulowaniu operacji poller zostanie odrzucony z wystąpieniem pollerCancelledError.
PollerStoppedError	Jeśli funkcja poller zostanie ręcznie zatrzymana za pośrednictwem stopPolling metody, funkcja poller zostanie odrzucona z wystąpieniem klasy PollerStoppedError.

Interfejsy

CreateHttpPollerOptions	Opcje dla programu createPoller.
LongRunningOperation	Opis długotrwałej operacji.
LroEngineOptions	Opcje dla poller LRO.
LroResponse	Typ odpowiedzi LRO.
OperationState	Podczas gdy narzędzie poller działa jako mechanizm kontroli lokalnej, aby rozpocząć wyzwalanie i czekać na długotrwałą operację, OperationState dokumentuje stan zdalnej długotrwałej operacji. Jest aktualizowany po każdym ankiecie.
PollOperation	PollOperation to interfejs, który definiuje sposób aktualizowania lokalnego odwołania do stanu zdalnej długotrwałej operacji, a także sposobu żądania anulowania tej samej operacji. Ma również metodę serializacji operacji, aby można ją było przechowywać i wznawiać w dowolnym momencie.
PollOperationState	PollOperationState zawiera listę z opiniami najmniejszego zestawu właściwości potrzebnych do zdefiniowania dowolnej długotrwałej operacji poller. Podczas gdy klasa Poller działa jako lokalny mechanizm sterowania, aby rozpocząć wyzwalanie, czekać i potencjalnie anulować długotrwałą operację, PollOperationState dokumentuje stan zdalnej długotrwałej operacji. Powinna zostać zaktualizowana co najmniej po rozpoczęciu operacji, zakończeniu i anulowaniu. Chociaż implementacje mogą mieć dowolną inną liczbę właściwości, które można zaktualizować z innych powodów.
PollerLike	Abstrakcyjna reprezentacja narzędzia poller, która ma na celu uwidocznienie tylko minimalnego interfejsu API, z którymi użytkownik musi pracować.
RawResponse	Prosty typ nieprzetworzonej odpowiedzi.
SimplePollerLike	Prosty interfejs poller.

Aliasy typu

CancelOnProgress	Metoda CancelOnProgress jest używana jako wartość zwracana przez metodę onProgress firmy Poller. Gdy użytkownik wywołuje metodę onProgress, musi przekazać funkcję, która zostanie wywołana jako wywołanie zwrotne z nowymi danymi odebranymi za każdym razem, gdy operacja sondowania zostanie zaktualizowana. Funkcja onProgress zwraca funkcję, która uniemożliwi dalszą aktualizację w celu uzyskania oryginalnego wywołania zwrotnego.
LroResourceLocationConfig	Potencjalna lokalizacja wyniku LRO, jeśli jest określona przez rozszerzenie LRO w strukturze Swagger.
OperationStatus	Zestaw możliwych stanów, w których operacja może znajdować się w danym momencie.
PollProgressCallback	PollProgressCallback to typ funkcji wywołania zwrotnego wysyłanych do elementu onProgress. Te funkcje otrzymają wartość TState zdefiniowaną przez implementację klasy Poller.

Funkcje

createHttpPoller<TResult, TState>(LongRunningOperation<unknown>, CreateHttpPollerOptions<TResult, TState>)

Tworzy bazę danych, która może służyć do sondowania długotrwałej operacji.

Szczegóły funkcji

createHttpPoller<TResult, TState>(LongRunningOperation<unknown>, CreateHttpPollerOptions<TResult, TState>)

Tworzy bazę danych, która może służyć do sondowania długotrwałej operacji.

function createHttpPoller<TResult, TState>(lro: LongRunningOperation<unknown>, options?: CreateHttpPollerOptions<TResult, TState>): Promise<SimplePollerLike<TState, TResult>>

Parametry

lro

LongRunningOperation<unknown>

Opis długotrwałej operacji

options

CreateHttpPollerOptions<TResult, TState>

opcje konfigurowania galerii

Zwraca

Promise<SimplePollerLike<TState, TResult>>

zainicjowany poller