PollerLike interface

Paquet:

@azure/keyvault-admin

Un polleur simple qui peut être utilisé pour interroger une opération de longue durée.

Méthodes

getOperationState()	Retourne l’état de l’opération.
getResult()	Retourne la valeur de résultat de l’opération, quel que soit l’état de l’polleur. Elle peut retourner une forme non définie ou incomplète de la valeur TResult finale en fonction de l’implémentation.
isDone()	Retourne true si l’polleur a terminé l’interrogation.
isStopped()	Retourne true si l’polleur est arrêté.
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.
stopPolling()	Empêche le polleur de continuer à interroger. Notez que cela arrête uniquement l’interrogation côté client
toString()	Retourne une représentation sous forme de chaîne de l’opération de l’polleur. Similaire à sérialiser, mais retourne une chaîne.

Détails de la méthode

getOperationState()

Retourne l’état de l’opération.

function getOperationState(): TState

Retours

TState

getResult()

Retourne la valeur de résultat de l’opération, quel que soit l’état de l’polleur. Elle peut retourner une forme non définie ou incomplète de la valeur TResult finale en fonction de l’implémentation.

function getResult(): undefined | TResult

Retours

undefined | TResult

isDone()

Retourne true si l’polleur a terminé l’interrogation.

function isDone(): boolean

Retours

boolean

isStopped()

Retourne true si l’polleur est arrêté.

function isStopped(): boolean

Retours

boolean

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<void>

Paramètres

options

{ abortSignal?: AbortSignalLike }

Retours

Promise<void>

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>

stopPolling()

Empêche le polleur de continuer à interroger. Notez que cela arrête uniquement l’interrogation côté client

function stopPolling()

toString()

Retourne une représentation sous forme de chaîne de l’opération de l’polleur. Similaire à sérialiser, mais retourne une chaîne.

function toString(): string

Retours

string