PollerLike interface

Paquet:

@azure/keyvault-secrets

Représentation abstraite d’un polleur, destinée à exposer uniquement l’API minimale avec laquelle l’utilisateur doit travailler.

Méthodes

cancelOperation({ abortSignal?: AbortSignalLike })	Tente d’annuler l’opération sous-jacente.
getOperationState()	Retourne l’état de l’opération. Le TState défini dans PollerLike peut être un sous-ensemble du TState défini dans l’implémentation poller.
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’interrogation 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 se résout une fois qu’une seule demande d’interrogation est terminée. Pour ce faire, il appelle la méthode de mise à jour de l’opération Poller.
pollUntilDone({ abortSignal?: AbortSignalLike })	Retourne une promesse qui se résout une fois l’opération sous-jacente terminée.
stopPolling()	Arrête l’polleur. Après cela, aucune demande manuelle ou automatisée ne peut être envoyée.
toString()	Retourne une version sérialisée de l’opération du polleur en appelant la méthode toString de l’opération.

Détails de la méthode

cancelOperation({ abortSignal?: AbortSignalLike })

Avertissement

Cette API est à présent déconseillée.

cancelOperation has been deprecated because it was not implemented.

Tente d’annuler l’opération sous-jacente.

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

Paramètres

options

{ abortSignal?: AbortSignalLike }

Retours

Promise<void>

getOperationState()

Retourne l’état de l’opération. Le TState défini dans PollerLike peut être un sous-ensemble du TState défini dans l’implémentation poller.

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’interrogation 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 se résout une fois qu’une seule demande d’interrogation est terminée. Pour ce faire, il appelle 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 se résout 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()

Arrête l’polleur. Après cela, aucune demande manuelle ou automatisée ne peut être envoyée.

function stopPolling()

toString()

Retourne une version sérialisée de l’opération du polleur en appelant la méthode toString de l’opération.

function toString(): string

Retours

string