PollOperationState interface

Пакет:

@azure/keyvault-secrets

PollOperationState содержит список с мнением наименьшего набора свойств, необходимых для определения любого длительного опроса операций.

Хотя класс Poller работает в качестве локального механизма управления для запуска, ожидания и потенциальной отмены длительной операции, pollOperationState документирует состояние удаленной длительной операции.

Он должен обновляться по крайней мере после запуска операции, когда она завершится и когда она отменена. Хотя реализации могут иметь любое другое количество свойств, которые могут быть обновлены другими причинами.

Свойства

error	Будет существовать, если операция столкнулась с какой-либо ошибкой.
isCancelled	Значение true, если операция отменена.
isCompleted	Значение true, если операция завершена.
isStarted	Значение true, если операция запущена.
result	Будет существовать, если операция завершилась в результате ожидаемого типа.

Сведения о свойстве

error

Будет существовать, если операция столкнулась с какой-либо ошибкой.

error?: Error

Значение свойства

Error

isCancelled

Значение true, если операция отменена.

isCancelled?: boolean

Значение свойства

boolean

isCompleted

Значение true, если операция завершена.

isCompleted?: boolean

Значение свойства

boolean

isStarted

Значение true, если операция запущена.

isStarted?: boolean

Значение свойства

boolean

result

Будет существовать, если операция завершилась в результате ожидаемого типа.

result?: TResult

Значение свойства

TResult