PollOperationState interface

Balíček:

@azure/keyvault-secrets

PollOperationState obsahuje názorný seznam nejmenší sady vlastností potřebných k definování jakékoli dlouhotrvající operace poller.

Zatímco Poller třída funguje jako místní řídicí mechanismus pro spuštění aktivace, čekání a potenciálně zrušení dlouhotrvající operace, PollOperationState dokumentuje stav vzdálené dlouhotrvající operace.

Měla by se aktualizovat aspoň po spuštění operace, po jeho dokončení a po zrušení. Implementace ale můžou mít jakýkoli jiný počet vlastností, které je možné aktualizovat z jiných důvodů.

Vlastnosti

error	Pokud operace zjistila nějakou chybu, bude existovat.
isCancelled	Hodnota True, pokud byla operace zrušena.
isCompleted	Hodnota True, pokud byla operace dokončena.
isStarted	Hodnota True, pokud byla operace spuštěna.
result	Pokud operace skončila v důsledku očekávaného typu, bude existovat.

Podrobnosti vlastnosti

error

Pokud operace zjistila nějakou chybu, bude existovat.

error?: Error

Hodnota vlastnosti

Error

isCancelled

Hodnota True, pokud byla operace zrušena.

isCancelled?: boolean

Hodnota vlastnosti

boolean

isCompleted

Hodnota True, pokud byla operace dokončena.

isCompleted?: boolean

Hodnota vlastnosti

boolean

isStarted

Hodnota True, pokud byla operace spuštěna.

isStarted?: boolean

Hodnota vlastnosti

boolean

result

Pokud operace skončila v důsledku očekávaného typu, bude existovat.

result?: TResult

Hodnota vlastnosti

TResult