@azure/core-lro package

Klasser

LroEngine	LRO-motorn, en klass som utför avsökning.
Poller	En klass som representerar definitionen av ett program som avsöker genom på varandra följande begäranden tills det når slutförandetillståndet. En poller kan köras manuellt genom avsökningsbegäran genom begäran genom att poll() anropa metoden upprepade gånger tills dess åtgärd har slutförts. Det ger också ett sätt att vänta tills åtgärden har slutförts genom att anropa pollUntilDone() och vänta tills åtgärden har slutförts. Pollers kan också begära att den pågående processen som tillhandahåller den underliggande långvariga åtgärden avbryts. 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 definieras av två typer, en typ som representerar pollerns tillstånd, som måste innehålla en grundläggande uppsättning egenskaper från PollOperationState<TResult>och en returtyp som definieras av TResult, som kan vara vad som helst. Klassen Poller implementerar PollerLike gränssnittet, vilket gör att pollerimplementeringar kan undvika att behöva exportera Poller-klassen direkt och i stället bara exportera den redan instansierade pollern med typen 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(); En poller kan skapas via konstruktorn och sedan kan den avsökas tills den har slutförts. När som helst kan pollerarens tillstånd hämtas utan fördröjning via metoden getOperationState. När som helst kan de mellanliggande formerna av resultattypen begäras utan dröjsmål. När den underliggande åtgärden har markerats som slutförd stoppas pollern och det slutliga värdet returneras. 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	När åtgärden avbryts avvisas pollern med en instans av PollerCancelledError.
PollerStoppedError	När en poller stoppas manuellt via stopPolling metoden avvisas pollern med en instans av PollerStoppedError.

Gränssnitt

CreateHttpPollerOptions	Alternativ för createPoller.
LongRunningOperation	Beskrivning av en tidskrävande åtgärd.
LroEngineOptions	Alternativ för LRO-polleraren.
LroResponse	Typ av svar för en LRO.
OperationState	Medan polleraren fungerar som den lokala kontrollmekanismen för att börja utlösa och vänta på en långvarig åtgärd, dokumenterar OperationState statusen för den långvariga fjärråtgärden. Den uppdateras efter varje omröstning.
PollOperation	PollOperation är ett gränssnitt som definierar hur du uppdaterar den lokala referensen för tillståndet för fjärråtgärden som körs länge, samt hur du begär att samma åtgärd avbryts. Den har också en metod för att serialisera åtgärden så att den kan lagras och återupptas när som helst.
PollOperationState	PollOperationState innehåller en åsiktslista över den minsta uppsättningen egenskaper som behövs för att definiera en tidskrävande åtgärdsbestämning. Medan Poller-klassen fungerar som den lokala kontrollmekanismen för att börja utlösa, vänta på och eventuellt avbryta en tidskrävande åtgärd, dokumenterar PollOperationState statusen för fjärråtgärden som körs länge. Den bör uppdateras åtminstone när åtgärden startas, när den är klar och när den avbryts. Implementeringar kan dock ha valfritt annat antal egenskaper som kan uppdateras av andra orsaker.
PollerLike	Abstrakt representation av en poller, avsedd att exponera bara det minimala API som användaren behöver arbeta med.
RawResponse	Enkel typ av råsvar.
SimplePollerLike	Ett enkelt pollergränssnitt.

Typalias

CancelOnProgress	CancelOnProgress används som returvärde för en Poller-metod onProgress. När en användare anropar onProgress måste de skicka in en funktion som anropas som ett återanrop med nya data som tas emot varje gång avsökningsåtgärden uppdateras. onProgress returnerar en funktion som förhindrar ytterligare uppdateringar för att nå det ursprungliga återanropet.
LroResourceLocationConfig	Den potentiella platsen för resultatet av LRO om det anges av LRO-tillägget i swagger.
OperationStatus	Uppsättningen möjliga tillstånd som en åtgärd kan finnas i vid en viss tidpunkt.
PollProgressCallback	PollProgressCallback är typen av återanropsfunktioner som skickas till onProgress. Dessa funktioner får en TState som definieras av din implementering av Poller-klassen.

Funktioner

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

Skapar en poller som kan användas för att avsöka en långvarig åtgärd.

Funktionsinformation

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

Skapar en poller som kan användas för att avsöka en långvarig åtgärd.

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

Parametrar

lro

LongRunningOperation<unknown>

Beskrivning av den långvariga åtgärden

options

CreateHttpPollerOptions<TResult, TState>

alternativ för att konfigurera poller

Returer

Promise<SimplePollerLike<TState, TResult>>

en initierad poller