Partager via

PollerLike interface

  • Référence
Paquet:
@azure/core-lro

Un polleur pour une opération.

Extends

Promise<TResult>

Propriétés

isDone

Est vrai si l’polleur a terminé l’interrogation.
operationState

État de l’opération. Il peut être non défini si l’polleur n’a pas encore été soumis.
result

Valeur de résultat de l’opération, quel que soit l’état de l’polleur. Il peut être non défini ou une forme incomplète de la valeur TResult finale en fonction de l’implémentation.

Propriétés héritées

[toStringTag]

Méthodes

onProgress((state: TState) => void)

Appelle le rappel fourni une fois chaque interrogation terminée, en envoyant l’état actuel de l’opération du polleur.

Elle retourne une méthode qui peut être utilisée pour arrêter la réception des mises à jour sur la fonction de rappel donnée.
poll({ abortSignal?: AbortSignalLike })

Retourne une promesse qui sera résolue une fois qu’une seule requête d’interrogation se termine. Pour ce faire, appelez la méthode de mise à jour de l’opération poller.
pollUntilDone({ abortSignal?: AbortSignalLike })

Retourne une promesse qui sera résolue une fois l’opération sous-jacente terminée.
serialize()

Retourne une promesse qui peut être utilisée pour la version sérialisée de l’opération du polleur en appelant la méthode sérialisée de l’opération.
submitted()

Retourne une promesse qui pourrait être utilisée pour vérifier si l’polleur a été soumis.

Méthodes héritées

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

Attache un rappel pour seulement le rejet de la Promesse.
finally(null | () => void)

Attache un rappel appelé lorsque la promesse est réglée (remplie ou rejetée). La valeur résolue ne peut pas être modifiée à partir du rappel.
then<TResult1, TResult2>(null | (value: TResult) => TResult1 | PromiseLike<TResult1>, null | (reason: any) => TResult2 | PromiseLike<TResult2>)

Attache des rappels pour la résolution et/ou le rejet de la promesse.

Détails de la propriété

isDone

Est vrai si l’polleur a terminé l’interrogation.

isDone: boolean

Valeur de propriété

boolean

operationState

État de l’opération. Il peut être non défini si l’polleur n’a pas encore été soumis.

operationState: undefined | TState

Valeur de propriété

undefined | TState

result

Valeur de résultat de l’opération, quel que soit l’état de l’polleur. Il peut être non défini ou une forme incomplète de la valeur TResult finale en fonction de l’implémentation.

result: undefined | TResult

Valeur de propriété

undefined | TResult

Détails de la propriété héritée

[toStringTag] 

[toStringTag]: string

Valeur de propriété

string

héritée de Promise.__@toStringTag@68

Détails de la méthode

onProgress((state: TState) => void)

Appelle le rappel fourni une fois chaque interrogation terminée, en envoyant l’état actuel de l’opération du polleur.

Elle retourne une méthode qui peut être utilisée pour arrêter la réception des mises à jour sur la fonction de rappel donnée.

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

Paramètres

callback

(state: TState) => void

Retours

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Retourne une promesse qui sera résolue une fois qu’une seule requête d’interrogation se termine. Pour ce faire, appelez la méthode de mise à jour de l’opération poller.

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

Paramètres

options

{ abortSignal?: AbortSignalLike }

Retours

Promise<TState>

pollUntilDone({ abortSignal?: AbortSignalLike })

Retourne une promesse qui sera résolue une fois l’opération sous-jacente terminée.

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

Paramètres

pollOptions

{ abortSignal?: AbortSignalLike }

Retours

Promise<TResult>

serialize()

Retourne une promesse qui peut être utilisée pour la version sérialisée de l’opération du polleur en appelant la méthode sérialisée de l’opération.

function serialize(): Promise<string>

Retours

Promise<string>

submitted()

Retourne une promesse qui pourrait être utilisée pour vérifier si l’polleur a été soumis.

function submitted(): Promise<void>

Retours

Promise<void>

Détails de la méthode héritée

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

Attache un rappel pour seulement le rejet de la Promesse.

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

Paramètres

onrejected

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

Rappel à exécuter lorsque la promesse est rejetée.

Retours

Promise<TResult | TResult>

Promesse d’achèvement du rappel.

héritée de Promise.catch

finally(null | () => void)

Attache un rappel appelé lorsque la promesse est réglée (remplie ou rejetée). La valeur résolue ne peut pas être modifiée à partir du rappel.

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

Paramètres

onfinally

null | () => void

Rappel à exécuter lorsque la promesse est réglée (remplie ou rejetée).

Retours

Promise<TResult>

Promesse d’achèvement du rappel.

héritée de Promise.enfin

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

Attache des rappels pour la résolution et/ou le rejet de la promesse.

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

Paramètres

onfulfilled

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

Rappel à exécuter lorsque la promesse est résolue.

onrejected

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

Rappel à exécuter lorsque la promesse est rejetée.

Retours

Promise<TResult1 | TResult2>

Promesse pour l’achèvement de laquelle le rappel est exécuté.

héritée de la promesse de.puis