PollerLike interface

  • Riferimento
Pacchetto:
@azure/core-lro

Un poller per un'operazione.

Extends

Promise<TResult>

Proprietà

isDone

È true se il poller ha terminato il polling.
operationState

Stato dell'operazione. Può essere indefinito se il poller non è ancora stato inviato.
result

Valore del risultato dell'operazione, indipendentemente dallo stato del poller. Può essere indefinito o una forma incompleta del valore TResult finale a seconda dell'implementazione.

Proprietà ereditate

[toStringTag]

Metodi

onProgress((state: TState) => void)

Richiama il callback fornito 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 di 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 update dell'operazione di Poller.
pollUntilDone({ abortSignal?: AbortSignalLike })

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

Restituisce una promessa che può essere utilizzata per la versione serializzata dell'operazione del poller richiamando il metodo serialize dell'operazione.
submitted()

Restituisce una promessa che può essere utilizzata per verificare se il poller è stato inviato.

Metodi ereditati

catch<TResult>(null | (reason: any) => TResult | PromiseLike<TResult>)

Associa un callback solo per il rifiuto della promessa.
finally(null | () => void)

Allega un callback richiamato quando la promessa viene risolta (soddisfatta o rifiutata). Il valore risolto non può essere modificato dal callback.
then<TResult1, TResult2>(null | (value: TResult) => TResult1 | PromiseLike<TResult1>, null | (reason: any) => TResult2 | PromiseLike<TResult2>)

Allega i callback per la risoluzione e/o il rifiuto della promessa.

Dettagli proprietà

isDone

È true se il poller ha terminato il polling.

isDone: boolean

Valore della proprietà

boolean

operationState

Stato dell'operazione. Può essere indefinito se il poller non è ancora stato inviato.

operationState: undefined | TState

Valore della proprietà

undefined | TState

result

Valore del risultato dell'operazione, indipendentemente dallo stato del poller. Può essere indefinito o una forma incompleta del valore TResult finale a seconda dell'implementazione.

result: undefined | TResult

Valore della proprietà

undefined | TResult

Dettagli proprietà ereditate

[toStringTag] 

[toStringTag]: string

Valore della proprietà

string

ereditato da Promise.__@toStringTag@68

Dettagli metodo

onProgress((state: TState) => void)

Richiama il callback fornito 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 di 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 update dell'operazione di Poller.

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

Parametri

options

{ abortSignal?: AbortSignalLike }

Restituisce

Promise<TState>

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>

serialize()

Restituisce una promessa che può essere utilizzata per la versione serializzata dell'operazione del poller richiamando il metodo serialize dell'operazione.

function serialize(): Promise<string>

Restituisce

Promise<string>

submitted()

Restituisce una promessa che può essere utilizzata per verificare se il poller è stato inviato.

function submitted(): Promise<void>

Restituisce

Promise<void>

Dettagli dei metodi ereditati

catch<TResult>(null | (reason: any) => TResult | PromiseLike<TResult>)

Associa un callback solo per il rifiuto della promessa.

function catch<TResult>(onrejected?: null | (reason: any) => TResult | PromiseLike<TResult>): Promise<TResult | TResult>

Parametri

onrejected

null | (reason: any) => TResult | PromiseLike<TResult>

Callback da eseguire quando la promessa viene rifiutata.

Restituisce

Promise<TResult | TResult>

Promessa per il completamento del callback.

ereditato da promise.catch

finally(null | () => void)

Allega un callback richiamato quando la promessa viene risolta (soddisfatta o rifiutata). Il valore risolto non può essere modificato dal callback.

function finally(onfinally?: null | () => void): Promise<TResult>

Parametri

onfinally

null | () => void

Callback da eseguire quando la promessa viene risolta (soddisfatta o rifiutata).

Restituisce

Promise<TResult>

Promessa per il completamento del callback.

Ereditato da Promise.finally

then<TResult1, TResult2>(null | (value: TResult) => TResult1 | PromiseLike<TResult1>, null | (reason: any) => TResult2 | PromiseLike<TResult2>)

Allega i callback per la risoluzione e/o il rifiuto della promessa.

function then<TResult1, TResult2>(onfulfilled?: null | (value: TResult) => TResult1 | PromiseLike<TResult1>, onrejected?: null | (reason: any) => TResult2 | PromiseLike<TResult2>): Promise<TResult1 | TResult2>

Parametri

onfulfilled

null | (value: TResult) => TResult1 | PromiseLike<TResult1>

Callback da eseguire quando la promessa viene risolta.

onrejected

null | (reason: any) => TResult2 | PromiseLike<TResult2>

Callback da eseguire quando la promessa viene rifiutata.

Restituisce

Promise<TResult1 | TResult2>

Promessa per il completamento del quale viene eseguito un callback.

Ereditato da Promise.then