PollerLikeWithCancellation interface

Pacote:

@azure/storage-blob

Representação abstrata de um poller, destinada a expor apenas a API mínima com que o utilizador precisa de trabalhar.

Métodos

cancelOperation({ abortSignal?: AbortSignalLike })	Tenta cancelar a operação subjacente.
getOperationState()	Devolve o estado da operação. O TState definido em PollerLike pode ser um subconjunto do TState definido na implementação do Poller.
getResult()	Devolve o valor de resultado da operação, independentemente do estado do poller. Pode devolver uma forma indefinida ou incompleta do valor final de TResult consoante a implementação.
isDone()	Devolve verdadeiro se o poller tiver terminado a consulta.
isStopped()	Devolve verdadeiro se o poller for parado.
onProgress((state: TState) => void)	Invoca a chamada de retorno fornecida após a conclusão de cada consulta, enviando o estado atual da operação do poller. Devolve um método que pode ser utilizado para parar de receber atualizações na função de chamada de retorno especificada.
poll({ abortSignal?: AbortSignalLike })	Devolve uma promessa que será resolvida assim que um único pedido de consulta for concluído. Fá-lo ao chamar o método de atualização da operação do Poller.
pollUntilDone()	Devolve uma promessa que será resolvida assim que a operação subjacente for concluída.
stopPolling()	Para o poller. Depois disso, não podem ser enviados pedidos manuais ou automatizados.
toString()	Devolve uma versão serializada da operação do poller ao invocar o método toString da operação.

Detalhes de Método

cancelOperation({ abortSignal?: AbortSignalLike })

Tenta cancelar a operação subjacente.

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

Parâmetros

options

{ abortSignal?: AbortSignalLike }

Devoluções

Promise<void>

getOperationState()

Devolve o estado da operação. O TState definido em PollerLike pode ser um subconjunto do TState definido na implementação do Poller.

function getOperationState(): TState

Devoluções

TState

getResult()

Devolve o valor de resultado da operação, independentemente do estado do poller. Pode devolver uma forma indefinida ou incompleta do valor final de TResult consoante a implementação.

function getResult(): undefined | TResult

Devoluções

undefined | TResult

isDone()

Devolve verdadeiro se o poller tiver terminado a consulta.

function isDone(): boolean

Devoluções

boolean

isStopped()

Devolve verdadeiro se o poller for parado.

function isStopped(): boolean

Devoluções

boolean

onProgress((state: TState) => void)

Invoca a chamada de retorno fornecida após a conclusão de cada consulta, enviando o estado atual da operação do poller.

Devolve um método que pode ser utilizado para parar de receber atualizações na função de chamada de retorno especificada.

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 consulta for concluído. Fá-lo ao chamar 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()

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

function pollUntilDone(): Promise<TResult>

Devoluções

Promise<TResult>

stopPolling()

Para o poller. Depois disso, não podem ser enviados pedidos manuais ou automatizados.

function stopPolling()

toString()

Devolve uma versão serializada da operação do poller ao invocar o método toString da operação.

function toString(): string

Devoluções

string