SimplePollerLike interface

Pacchetto:
@azure/app-configuration

Un semplice poller che può essere usato per eseguire il polling di un'operazione a esecuzione prolungata.

Questa interfaccia rispecchia la forma di SimplePollerLike di dalla @azure/core-lro v2 in modo che la superficie pubblica dell'API venga preservata mentre si utilizza internamente il poller v3.

Metodi

getOperationState()

Restituisce lo stato dell'operazione.
getResult()

Restituisce il valore del risultato dell'operazione, indipendentemente dallo stato del poller. Può restituire una forma indefinita o incompleta 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)

Invoca il callback fornito dopo ogni sondaggio, inviando lo stato attuale dell'operazione del poller.

Restituisce un metodo che può essere usato per interrompere la ricezione di aggiornamenti sulla funzione di callback data.
poll({ abortSignal?: AbortSignalLike })

Restituisce una promessa che si risolverà una volta terminata una singola richiesta di sondaggio. Lo fa chiamando il metodo di aggiornamento dell'operazione del Poller.
pollUntilDone({ abortSignal?: AbortSignalLike })

Restituisce una promessa che si risolverà una volta completata l'operazione sottostante.
stopPolling()

Impedisce al sondaggiste di continuare a sondare. Si prega di notare che questo fermerà solo il sondaggio lato client
toString()

Restituisce una rappresentazione della stringa dell'operazione del poller. Simile a serializzare ma restituisce una stringa.

Dettagli metodo

getOperationState()

Restituisce lo stato dell'operazione.

function getOperationState(): TState

Valori restituiti

TState

getResult()

Restituisce il valore del risultato dell'operazione, indipendentemente dallo stato del poller. Può restituire una forma indefinita o incompleta del valore TResult finale a seconda dell'implementazione.

function getResult(): undefined | TResult

Valori restituiti

undefined | TResult

isDone()

Restituisce true se il poller ha terminato il polling.

function isDone(): boolean

Valori restituiti

boolean

isStopped()

Restituisce true se il poller viene arrestato.

function isStopped(): boolean

Valori restituiti

boolean

onProgress((state: TState) => void)

Invoca il callback fornito dopo ogni sondaggio, inviando lo stato attuale dell'operazione del poller.

Restituisce un metodo che può essere usato per interrompere la ricezione di aggiornamenti sulla funzione di callback data.

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

Parametri

callback

(state: TState) => void

Valori restituiti

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Restituisce una promessa che si risolverà una volta terminata una singola richiesta di sondaggio. Lo fa chiamando il metodo di aggiornamento dell'operazione del Poller.

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

Parametri

options

{ abortSignal?: AbortSignalLike }

Valori restituiti

Promise<void>

pollUntilDone({ abortSignal?: AbortSignalLike })

Restituisce una promessa che si risolverà una volta completata l'operazione sottostante.

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

Parametri

pollOptions

{ abortSignal?: AbortSignalLike }

Valori restituiti

Promise<TResult>

stopPolling()

Impedisce al sondaggiste di continuare a sondare. Si prega di notare che questo fermerà solo il sondaggio lato client

function stopPolling()

toString()

Restituisce una rappresentazione della stringa dell'operazione del poller. Simile a serializzare ma restituisce una stringa.

function toString(): string

Valori restituiti

string