PollerLike interface

  • Riferimento
Pacchetto:
@azure/keyvault-secrets

Rappresentazione astratta di un poller, progettata per esporre solo l'API minima che l'utente deve usare.

Metodi

cancelOperation({ abortSignal?: AbortSignalLike })

Tenta di annullare l'operazione sottostante.
getOperationState()

Restituisce lo stato dell'operazione. L'oggetto TState definito in PollerLike può essere un subset dell'oggetto TState definito nell'implementazione poller.
getResult()

Restituisce il valore del risultato dell'operazione, indipendentemente dallo stato del poller. Può restituire un formato non definito o incompleto del valore TResult finale a seconda dell'implementazione.
isDone()

Restituisce true se il poller ha terminato il polling.
isStopped()

Restituisce true se il poller viene arrestato.
onProgress((state: TState) => void)

Richiama il callback specificato al termine di ogni polling, inviando lo stato corrente dell'operazione del poller.

Restituisce un metodo che può essere utilizzato per interrompere la ricezione degli aggiornamenti nella funzione di callback specificata.
poll({ abortSignal?: AbortSignalLike })

Restituisce una promessa che verrà risolta al termine di una singola richiesta di polling. A tale scopo, chiamare il metodo di aggiornamento dell'operazione di Poller.
pollUntilDone({ abortSignal?: AbortSignalLike })

Restituisce una promessa che verrà risolta al termine dell'operazione sottostante.
stopPolling()

Arresta il poller. Successivamente, non è possibile inviare richieste manuali o automatizzate.
toString()

Restituisce una versione serializzata dell'operazione del poller richiamando il metodo toString dell'operazione.

Dettagli metodo

cancelOperation({ abortSignal?: AbortSignalLike })

Avviso

Questa API è ora deprecata.

cancelOperation has been deprecated because it was not implemented.

Tenta di annullare l'operazione sottostante.

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

Parametri

options

{ abortSignal?: AbortSignalLike }

Restituisce

Promise<void>

getOperationState()

Restituisce lo stato dell'operazione. L'oggetto TState definito in PollerLike può essere un subset dell'oggetto TState definito nell'implementazione poller.

function getOperationState(): TState

Restituisce

TState

getResult()

Restituisce il valore del risultato dell'operazione, indipendentemente dallo stato del poller. Può restituire un formato non definito o incompleto del valore TResult finale a seconda dell'implementazione.

function getResult(): undefined | TResult

Restituisce

undefined | TResult

isDone()

Restituisce true se il poller ha terminato 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 al termine di ogni polling, inviando lo stato corrente dell'operazione del poller.

Restituisce un metodo che può essere utilizzato per interrompere la ricezione degli aggiornamenti nella funzione di callback specificata.

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

Parametri

callback

(state: TState) => void

Restituisce

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Restituisce una promessa che verrà risolta al termine di una singola richiesta di polling. A tale scopo, chiamare 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. Successivamente, 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