PollerLikeWithCancellation interface
Representação abstrata de um sondador, destinada a expor apenas a API mínima com a qual o usuário precisa trabalhar.
Métodos
cancel |
Tenta cancelar a operação subjacente. |
get |
Retorna o estado da operação. O TState definido em PollerLike pode ser um subconjunto do TState definido na implementação do Poller. |
get |
Retorna o valor do resultado da operação, independentemente do estado do sondador. Ele pode retornar uma forma indefinida ou incompleta do valor TResult final, dependendo da implementação. |
is |
Retornará true se o sondador tiver terminado a votação. |
is |
Retornará true se o poller for interrompido. |
on |
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({ abort |
Retorna uma promessa que será resolvida assim que uma única solicitação de sondagem for concluída. Ele faz isso chamando o método de atualização da operação do Poller. |
poll |
Retorna uma promessa que será resolvida depois que a operação subjacente for concluída. |
stop |
Para o poller. Depois disso, nenhuma solicitação manual ou automatizada pode ser enviada. |
to |
Retorna uma versão serializada da operação do poller invocando o método toString da operação. |
Detalhes do método
cancelOperation({ abortSignal?: AbortSignalLike })
Tenta cancelar a operação subjacente.
function cancelOperation(options?: { abortSignal?: AbortSignalLike }): Promise<void>
Parâmetros
- options
-
{ abortSignal?: AbortSignalLike }
Retornos
Promise<void>
getOperationState()
Retorna 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
Retornos
TState
getResult()
Retorna o valor do resultado da operação, independentemente do estado do sondador. Ele pode retornar uma forma indefinida ou incompleta do valor TResult final, dependendo da implementação.
function getResult(): undefined | TResult
Retornos
undefined | TResult
isDone()
Retornará true se o sondador tiver terminado a votação.
function isDone(): boolean
Retornos
boolean
isStopped()
Retornará true se o poller for interrompido.
function isStopped(): boolean
Retornos
boolean
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
poll({ abortSignal?: AbortSignalLike })
Retorna uma promessa que será resolvida assim que 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<void>
Parâmetros
- options
-
{ abortSignal?: AbortSignalLike }
Retornos
Promise<void>
pollUntilDone()
Retorna uma promessa que será resolvida depois que a operação subjacente for concluída.
function pollUntilDone(): Promise<TResult>
Retornos
Promise<TResult>
stopPolling()
Para o poller. Depois disso, nenhuma solicitação manual ou automatizada pode ser enviada.
function stopPolling()
toString()
Retorna uma versão serializada da operação do poller invocando o método toString da operação.
function toString(): string
Retornos
string