@azure/core-lro package
Interfacce
| CreateHttpPollerOptions |
Opzioni per |
| OperationConfig |
Configurazioni per informazioni su come eseguire il polling dell'operazione e verificare se è stata terminata. |
| OperationResponse |
Tipo della risposta di un LRO. |
| OperationState |
Mentre il poller funziona come meccanismo di controllo locale per avviare l'attivazione e attendere un'operazione a esecuzione prolungata, OperationState documenta lo stato dell'operazione a esecuzione prolungata remota. Viene aggiornato dopo ogni sondaggio. |
| PollerLike |
Un poller per un'operazione. |
| RawRequest |
Tipo semplice della richiesta non elaborata. |
| RawResponse |
Tipo semplice della risposta non elaborata. |
| RunningOperation |
Descrizione di un'operazione a esecuzione prolungata. |
Alias tipo
| CancelOnProgress |
CancelOnProgress viene usato come valore restituito del metodo onProgress di un poller. Quando un utente richiama onProgress, è necessario passare una funzione che verrà chiamata come callback con i nuovi dati ricevuti ogni volta che l'operazione di polling viene aggiornata. onProgress restituisce una funzione che impedirà ulteriori aggiornamenti per raggiungere il callback originale. |
| OperationStatus |
Il set di possibili stati in cui un'operazione può trovarsi in qualsiasi momento. |
| ResourceLocationConfig |
Posizione potenziale del risultato dell'LRO se specificato dall'estensione LRO nel swagger. |
| RestorableOperationState |
Tipo di operazione con esecuzione prolungata ripristinabile. |
Funzioni
| create |
Crea un poller che può essere utilizzato per eseguire il polling di un'operazione a esecuzione prolungata. |
| deserialize |
Deserializza lo stato |
Dettagli funzione
createHttpPoller<TResult, TState>(RunningOperation<unknown>, CreateHttpPollerOptions<TResult, TState>)
Crea un poller che può essere utilizzato per eseguire il polling di un'operazione a esecuzione prolungata.
function createHttpPoller<TResult, TState>(lro: RunningOperation<unknown>, options?: CreateHttpPollerOptions<TResult, TState>): PollerLike<TState, TResult>Parametri
- lro
-
RunningOperation<unknown>
Descrizione dell'operazione a esecuzione prolungata
- options
-
CreateHttpPollerOptions<TResult, TState>
opzioni per configurare il poller
Restituisce
PollerLike<TState, TResult>
un poller inizializzato
deserializeState<TResult, TState>(string)
Deserializza lo stato
function deserializeState<TResult, TState>(serializedState: string): RestorableOperationState<TResult, TState>Parametri
- serializedState
-
string
Restituisce
RestorableOperationState<TResult, TState>