PollOperationState interface

Paquet:

@azure/keyvault-keys

PollOperationState contient une liste opinionnée du plus petit ensemble de propriétés nécessaire pour définir un pollueur d’opérations de longue durée.

Alors que la classe Poller fonctionne comme le mécanisme de contrôle local pour démarrer le déclenchement, attendre et potentiellement annuler une opération de longue durée, pollOperationState documente l’état de l’opération distante de longue durée.

Il doit être mis à jour au moins lorsque l’opération démarre, quand elle est terminée et quand elle est annulée. Toutefois, les implémentations peuvent avoir n’importe quel autre nombre de propriétés qui peuvent être mises à jour pour d’autres raisons.

Propriétés

error	Existe si l’opération a rencontré une erreur.
isCancelled	True si l’opération a été annulée.
isCompleted	True si l’opération est terminée.
isStarted	True si l’opération a démarré.
result	Existe si l’opération s’est terminée dans un résultat d’un type attendu.

Détails de la propriété

error

Existe si l’opération a rencontré une erreur.

error?: Error

Valeur de propriété

Error

isCancelled

True si l’opération a été annulée.

isCancelled?: boolean

Valeur de propriété

boolean

isCompleted

True si l’opération est terminée.

isCompleted?: boolean

Valeur de propriété

boolean

isStarted

True si l’opération a démarré.

isStarted?: boolean

Valeur de propriété

boolean

result

Existe si l’opération s’est terminée dans un résultat d’un type attendu.

result?: TResult

Valeur de propriété

TResult