@azure/core-lro package
Gränssnitt
| CreateHttpPollerOptions |
Alternativ för |
| OperationConfig |
Konfigurationer för hur du avsöker åtgärden och för att kontrollera om den har avslutats. |
| OperationResponse |
Typen 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 tidskrävande åtgärd, dokumenterar OperationState statusen för fjärråtgärden som körs länge. Den uppdateras efter varje omröstning. |
| PollerLike |
En poller för en åtgärd. |
| RawRequest |
Enkel typ av raw-begäran. |
| RawResponse |
Enkel typ av raw-svar. |
| RunningOperation |
Beskrivning av en tidskrävande åtgärd. |
Typalias
| CancelOnProgress |
CancelOnProgress används som returvärde för en Poller-onProgress-metod. När en användare anropar onProgress måste de skicka in en funktion som anropas som motringning 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. |
| OperationStatus |
Uppsättningen möjliga tillstånd som en åtgärd kan finnas i när som helst. |
| ResourceLocationConfig |
Den potentiella platsen för resultatet av LRO om det anges av LRO-tillägget i swagger. |
| RestorableOperationState |
Typ av återställningsbar tidskrävande åtgärd. |
Funktioner
| create |
Skapar en poller som kan användas för att avsöka en tidskrävande åtgärd. |
| deserialize |
Deserialiserar tillståndet |
Funktionsinformation
createHttpPoller<TResult, TState>(RunningOperation<unknown>, CreateHttpPollerOptions<TResult, TState>)
Skapar en poller som kan användas för att avsöka en tidskrävande åtgärd.
function createHttpPoller<TResult, TState>(lro: RunningOperation<unknown>, options?: CreateHttpPollerOptions<TResult, TState>): PollerLike<TState, TResult>Parametrar
- lro
-
RunningOperation<unknown>
Beskrivning av den långvariga åtgärden
- options
-
CreateHttpPollerOptions<TResult, TState>
alternativ för att konfigurera poller
Returer
PollerLike<TState, TResult>
en initierad poller
deserializeState<TResult, TState>(string)
Deserialiserar tillståndet
function deserializeState<TResult, TState>(serializedState: string): RestorableOperationState<TResult, TState>Parametrar
- serializedState
-
string
Returer
RestorableOperationState<TResult, TState>