PollerLike interface

Tenta cancelar a operação subjacente.

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

Parâmetros

Devoluções

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

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

function getResult(): undefined | TResult

Devoluções

Devolve true se o poller tiver terminado a consulta.

function isDone(): boolean

Devoluções

Devolve true se o poller for parado.

function isStopped(): boolean

Devoluções

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

Devoluções

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

Devoluções

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

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

Parâmetros

Devoluções

Para o poller. Depois disso, não é possível enviar pedidos manuais ou automatizados.

function stopPolling()

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

function toString(): string

Devoluções