PollerLike interface

  • Referência
Pacote:
@azure/core-lro

Um sondador para uma operação.

Extends

Promise<TResult>

Propriedades

isDone

É verdade se o sondador terminou a votação.
operationState

O estado da operação. Pode ser indefinido se o sondador ainda não tiver sido apresentado.
result

O valor do resultado da operação, independentemente do estado do sondador. Ele pode ser indefinido ou uma forma incompleta do valor TResult final, dependendo da implementação.

Propriedades herdadas

[toStringTag]

Métodos

onProgress((state: TState) => void)

Invoca o retorno de chamada fornecido após a conclusão de cada sondagem, enviando o estado atual da operação do sondador.

Ele retorna um método que pode ser usado para parar de receber atualizações na função de retorno de chamada fornecida.
poll({ abortSignal?: AbortSignalLike })

Retorna uma promessa que será resolvida quando uma única solicitação de sondagem for concluída. Ele faz isso chamando o método de atualização da operação do Poller.
pollUntilDone({ abortSignal?: AbortSignalLike })

Retorna uma promessa que será resolvida quando a operação subjacente for concluída.
serialize()

Retorna uma promessa que pode ser usada para a versão serializada da operação do sondador invocando o método de serialização da operação.
submitted()

Retorna uma promessa que pode ser usada para verificar se o sondador foi enviado.

Métodos herdados

catch<TResult>(null | (reason: any) => TResult | PromiseLike<TResult>)

Anexa um retorno de chamada apenas para a rejeição da Promessa.
finally(null | () => void)

Anexa um retorno de chamada que é invocado quando a Promessa é resolvida (atendida ou rejeitada). O valor resolvido não pode ser modificado do retorno de chamada.
then<TResult1, TResult2>(null | (value: TResult) => TResult1 | PromiseLike<TResult1>, null | (reason: any) => TResult2 | PromiseLike<TResult2>)

Anexa retornos de chamada para a resolução e/ou rejeição da Promessa.

Detalhes da propriedade

isDone

É verdade se o sondador terminou a votação.

isDone: boolean

Valor da propriedade

boolean

operationState

O estado da operação. Pode ser indefinido se o sondador ainda não tiver sido apresentado.

operationState: undefined | TState

Valor da propriedade

undefined | TState

result

O valor do resultado da operação, independentemente do estado do sondador. Ele pode ser indefinido ou uma forma incompleta do valor TResult final, dependendo da implementação.

result: undefined | TResult

Valor da propriedade

undefined | TResult

Detalhes das propriedades herdadas

[toStringTag] 

[toStringTag]: string

Valor da propriedade

string

herdado de Promise.__@toStringTag@68

Detalhes do método

onProgress((state: TState) => void)

Invoca o retorno de chamada fornecido após a conclusão de cada sondagem, enviando o estado atual da operação do sondador.

Ele retorna um método que pode ser usado para parar de receber atualizações na função de retorno de chamada fornecida.

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

Parâmetros

callback

(state: TState) => void

Retornos

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Retorna uma promessa que será resolvida quando uma única solicitação de sondagem for concluída. Ele faz isso chamando o método de atualização da operação do Poller.

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

Parâmetros

options

{ abortSignal?: AbortSignalLike }

Retornos

Promise<TState>

pollUntilDone({ abortSignal?: AbortSignalLike })

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

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

Parâmetros

pollOptions

{ abortSignal?: AbortSignalLike }

Retornos

Promise<TResult>

serialize()

Retorna uma promessa que pode ser usada para a versão serializada da operação do sondador invocando o método de serialização da operação.

function serialize(): Promise<string>

Retornos

Promise<string>

submitted()

Retorna uma promessa que pode ser usada para verificar se o sondador foi enviado.

function submitted(): Promise<void>

Retornos

Promise<void>

Detalhes do método herdado

catch<TResult>(null | (reason: any) => TResult | PromiseLike<TResult>)

Anexa um retorno de chamada apenas para a rejeição da Promessa.

function catch<TResult>(onrejected?: null | (reason: any) => TResult | PromiseLike<TResult>): Promise<TResult | TResult>

Parâmetros

onrejected

null | (reason: any) => TResult | PromiseLike<TResult>

O retorno de chamada a ser executado quando a Promessa for rejeitada.

Retornos

Promise<TResult | TResult>

Uma promessa para a conclusão do retorno de chamada.

Herdado de Promise.catch

finally(null | () => void)

Anexa um retorno de chamada que é invocado quando a Promessa é resolvida (atendida ou rejeitada). O valor resolvido não pode ser modificado do retorno de chamada.

function finally(onfinally?: null | () => void): Promise<TResult>

Parâmetros

onfinally

null | () => void

O retorno de chamada a ser executado quando a Promessa for liquidada (atendida ou rejeitada).

Retornos

Promise<TResult>

Uma promessa para a conclusão do retorno de chamada.

herdado de Promise.finally

then<TResult1, TResult2>(null | (value: TResult) => TResult1 | PromiseLike<TResult1>, null | (reason: any) => TResult2 | PromiseLike<TResult2>)

Anexa retornos de chamada para a resolução e/ou rejeição da Promessa.

function then<TResult1, TResult2>(onfulfilled?: null | (value: TResult) => TResult1 | PromiseLike<TResult1>, onrejected?: null | (reason: any) => TResult2 | PromiseLike<TResult2>): Promise<TResult1 | TResult2>

Parâmetros

onfulfilled

null | (value: TResult) => TResult1 | PromiseLike<TResult1>

O retorno de chamada a ser executado quando a Promessa for resolvida.

onrejected

null | (reason: any) => TResult2 | PromiseLike<TResult2>

O retorno de chamada a ser executado quando a Promessa for rejeitada.

Retornos

Promise<TResult1 | TResult2>

Uma promessa para a conclusão da qual o retorno de chamada é executado.

herdado de Promise.then