SimplePollerLike interface
Interfaccia semplice del poller.
Metodi
get |
Restituisce lo stato dell'operazione. |
get |
Restituisce il valore del risultato dell'operazione, indipendentemente dallo stato del poller. Può restituire una forma non definita o incompleta del valore TResult finale a seconda dell'implementazione. |
is |
Restituisce true se il poller ha completato il polling. |
is |
Restituisce true se il poller viene arrestato. |
on |
Richiama il callback specificato dopo il completamento di ogni polling, inviando lo stato corrente dell'operazione del poller. Restituisce un metodo che può essere usato per interrompere la ricezione degli aggiornamenti nella funzione di callback specificata. |
poll({ abort |
Restituisce una promessa che verrà risolta al termine di una singola richiesta di polling. Questa operazione viene eseguita chiamando il metodo di aggiornamento dell'operazione di Poller. |
poll |
Restituisce una promessa che verrà risolta al termine dell'operazione sottostante. |
stop |
Arresta il poller. In seguito, non è possibile inviare richieste manuali o automatizzate. |
to |
Restituisce una versione serializzata dell'operazione del poller richiamando il metodo toString dell'operazione. |
Dettagli metodo
getOperationState()
Restituisce lo stato dell'operazione.
function getOperationState(): TState
Restituisce
TState
getResult()
Restituisce il valore del risultato dell'operazione, indipendentemente dallo stato del poller. Può restituire una forma non definita o incompleta del valore TResult finale a seconda dell'implementazione.
function getResult(): undefined | TResult
Restituisce
undefined | TResult
isDone()
Restituisce true se il poller ha completato il polling.
function isDone(): boolean
Restituisce
boolean
isStopped()
Restituisce true se il poller viene arrestato.
function isStopped(): boolean
Restituisce
boolean
onProgress((state: TState) => void)
Richiama il callback specificato dopo il completamento di ogni polling, inviando lo stato corrente dell'operazione del poller.
Restituisce un metodo che può essere usato per interrompere la ricezione degli aggiornamenti nella funzione di callback specificata.
function onProgress(callback: (state: TState) => void): CancelOnProgress
Parametri
- callback
-
(state: TState) => void
Restituisce
poll({ abortSignal?: AbortSignalLike })
Restituisce una promessa che verrà risolta al termine di una singola richiesta di polling. Questa operazione viene eseguita chiamando il metodo di aggiornamento dell'operazione di Poller.
function poll(options?: { abortSignal?: AbortSignalLike }): Promise<void>
Parametri
- options
-
{ abortSignal?: AbortSignalLike }
Restituisce
Promise<void>
pollUntilDone({ abortSignal?: AbortSignalLike })
Restituisce una promessa che verrà risolta al termine dell'operazione sottostante.
function pollUntilDone(pollOptions?: { abortSignal?: AbortSignalLike }): Promise<TResult>
Parametri
- pollOptions
-
{ abortSignal?: AbortSignalLike }
Restituisce
Promise<TResult>
stopPolling()
Arresta il poller. In seguito, non è possibile inviare richieste manuali o automatizzate.
function stopPolling()
toString()
Restituisce una versione serializzata dell'operazione del poller richiamando il metodo toString dell'operazione.
function toString(): string
Restituisce
string