SimplePollerLike interface

Pacote:
@azure/app-configuration

Um poller simples que pode ser usado para sondar uma operação de longa duração.

Esta interface espelha a forma de SimplePollerLike do @azure/core-lro v2, de modo que a superfície pública da API é preservada enquanto se utiliza internamente o poller v3.

Métodos

getOperationState()

Retorna o estado da operação.
getResult()

Devolve o valor do resultado da operação, independentemente do estado do sondador. Ele pode retornar uma forma indefinida ou incompleta do valor final do TResult, dependendo da implementação.
isDone()

Retorna true se o poller tiver terminado a votação.
isStopped()

Retorna true se o poller for parado.
onProgress((state: TState) => void)

Invoca o callback fornecido após cada sondagem ser concluída, enviando o estado atual da operação do poller.

Devolve um método que pode ser usado para impedir de receber atualizações na função de callback dada.
poll({ abortSignal?: AbortSignalLike })

Devolve uma promessa que será resolvida assim que um único pedido de sondagem terminar. Faz isto chamando o método de atualização da operação do Poller.
pollUntilDone({ abortSignal?: AbortSignalLike })

Devolve uma promessa que será resolvida assim que a operação subjacente for concluída.
stopPolling()

Impede o sondador de continuar a votar. Por favor, note que isto só vai parar as sondagens do lado do cliente
toString()

Devolve uma cadeia representativa da operação do poller. Semelhante ao serializar, mas devolve uma cadeia.

Detalhes de Método

getOperationState()

Retorna o estado da operação.

function getOperationState(): TState

Devoluções

TState

getResult()

Devolve o valor do resultado da operação, independentemente do estado do sondador. Ele pode retornar uma forma indefinida ou incompleta do valor final do TResult, dependendo da implementação.

function getResult(): undefined | TResult

Devoluções

undefined | TResult

isDone()

Retorna true se o poller tiver terminado a votação.

function isDone(): boolean

Devoluções

boolean

isStopped()

Retorna true se o poller for parado.

function isStopped(): boolean

Devoluções

boolean

onProgress((state: TState) => void)

Invoca o callback fornecido após cada sondagem ser concluída, enviando o estado atual da operação do poller.

Devolve um método que pode ser usado para impedir de receber atualizações na função de callback dada.

function onProgress(callback: (state: TState) => void): CancelOnProgress

Parâmetros

callback

(state: TState) => void

Devoluções

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Devolve uma promessa que será resolvida assim que um único pedido de sondagem terminar. Faz isto chamando o método de atualização da operação do Poller.

function poll(options?: { abortSignal?: AbortSignalLike }): Promise<void>

Parâmetros

options

{ abortSignal?: AbortSignalLike }

Devoluções

Promise<void>

pollUntilDone({ abortSignal?: AbortSignalLike })

Devolve uma promessa que será resolvida assim que a operação subjacente for concluída.

function pollUntilDone(pollOptions?: { abortSignal?: AbortSignalLike }): Promise<TResult>

Parâmetros

pollOptions

{ abortSignal?: AbortSignalLike }

Devoluções

Promise<TResult>

stopPolling()

Impede o sondador de continuar a votar. Por favor, note que isto só vai parar as sondagens do lado do cliente

function stopPolling()

toString()

Devolve uma cadeia representativa da operação do poller. Semelhante ao serializar, mas devolve uma cadeia.

function toString(): string

Devoluções

string