@azure/core-lro package
Interfaces
| CreateHttpPollerOptions |
Opções para |
| OperationConfig |
Configurações de como sondar a operação e verificar se ela foi encerrada. |
| OperationResponse |
O tipo da resposta de um LRO. |
| OperationState |
Enquanto o sondador funciona como o mecanismo de controle local para começar a disparar e aguardar uma operação de longa execução, o OperationState documenta o status da operação remota de longa execução. Ele é atualizado após cada votação. |
| PollerLike |
Um sondador para uma operação. |
| RawRequest |
Tipo simples da solicitação bruta. |
| RawResponse |
Tipo simples da resposta bruta. |
| RunningOperation |
Descrição de uma operação de execução prolongada. |
Aliases de tipo
| CancelOnProgress |
CancelOnProgress é usado como o valor retornado do método onProgress de um Poller. Quando um usuário invoca onProgress, ele é obrigado a passar uma função que será chamada como um retorno de chamada com os novos dados recebidos sempre que a operação de sondagem for atualizada. onProgress retorna uma função que impedirá que qualquer atualização adicional atinja o retorno de chamada original. |
| OperationStatus |
O conjunto de estados possíveis em que uma operação pode estar a qualquer momento. |
| ResourceLocationConfig |
O local potencial do resultado do LRO se especificado pela extensão LRO no swagger. |
| RestorableOperationState |
Tipo de uma operação de execução longa restaurável. |
Funções
| create |
Cria um sondador que pode ser usado para sondar uma operação de longa duração. |
| deserialize |
Desserializa o estado |
Detalhes da função
createHttpPoller<TResult, TState>(RunningOperation<unknown>, CreateHttpPollerOptions<TResult, TState>)
Cria um sondador que pode ser usado para sondar uma operação de longa duração.
function createHttpPoller<TResult, TState>(lro: RunningOperation<unknown>, options?: CreateHttpPollerOptions<TResult, TState>): PollerLike<TState, TResult>Parâmetros
- lro
-
RunningOperation<unknown>
Descrição da operação de execução prolongada
- options
-
CreateHttpPollerOptions<TResult, TState>
opções para configurar o poller
Retornos
PollerLike<TState, TResult>
um sondador inicializado
deserializeState<TResult, TState>(string)
Desserializa o estado
function deserializeState<TResult, TState>(serializedState: string): RestorableOperationState<TResult, TState>Parâmetros
- serializedState
-
string
Retornos
RestorableOperationState<TResult, TState>