PollerLike interface

Пакет:

@azure/keyvault-secrets

Абстрактное представление опроса, предназначенное для предоставления только минимального API, с которым должен работать пользователь.

Методы

cancelOperation({ abortSignal?: AbortSignalLike })	Пытается отменить базовую операцию.
getOperationState()	Возвращает состояние операции. TState, определенный в PollerLike, может быть подмножеством TState, определенного в реализации Poller.
getResult()	Возвращает значение результата операции независимо от состояния опроса. Он может возвращать неопределенную или неполную форму окончательного значения TResult в зависимости от реализации.
isDone()	Возвращает значение true, если опрашивание завершено.
isStopped()	Возвращает значение true, если опрашиватель остановлен.
onProgress((state: TState) => void)	Вызывает предоставленный обратный вызов после завершения каждого опроса, отправляя текущее состояние операции опроса. Он возвращает метод, который можно использовать для остановки получения обновлений для данной функции обратного вызова.
poll({ abortSignal?: AbortSignalLike })	Возвращает обещание, которое будет разрешаться после завершения одного запроса опроса. Это делается путем вызова метода обновления операции Poller.
pollUntilDone({ abortSignal?: AbortSignalLike })	Возвращает обещание, которое будет разрешаться после завершения базовой операции.
stopPolling()	Останавливает опрашиватель. После этого отправлять запросы вручную или автоматически не удастся.
toString()	Возвращает сериализованную версию операции опроса, вызвав метод toString операции.

Сведения о методе

cancelOperation({ abortSignal?: AbortSignalLike })

Предупреждение

Теперь этот API является нерекомендуемым.

cancelOperation has been deprecated because it was not implemented.

Пытается отменить базовую операцию.

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

Параметры

options

{ abortSignal?: AbortSignalLike }

Возвращаемое значение

Promise<void>

getOperationState()

Возвращает состояние операции. TState, определенный в PollerLike, может быть подмножеством TState, определенного в реализации Poller.

function getOperationState(): TState

Возвращаемое значение

TState

getResult()

Возвращает значение результата операции независимо от состояния опроса. Он может возвращать неопределенную или неполную форму окончательного значения TResult в зависимости от реализации.

function getResult(): undefined | TResult

Возвращаемое значение

undefined | TResult

isDone()

Возвращает значение true, если опрашивание завершено.

function isDone(): boolean

Возвращаемое значение

boolean

isStopped()

Возвращает значение true, если опрашиватель остановлен.

function isStopped(): boolean

Возвращаемое значение

boolean

onProgress((state: TState) => void)

Вызывает предоставленный обратный вызов после завершения каждого опроса, отправляя текущее состояние операции опроса.

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

function onProgress(callback: (state: TState) => void): CancelOnProgress

Параметры

callback

(state: TState) => void

Возвращаемое значение

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Возвращает обещание, которое будет разрешаться после завершения одного запроса опроса. Это делается путем вызова метода обновления операции Poller.

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

Параметры

options

{ abortSignal?: AbortSignalLike }

Возвращаемое значение

Promise<void>

pollUntilDone({ abortSignal?: AbortSignalLike })

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

function pollUntilDone(pollOptions?: { abortSignal?: AbortSignalLike }): Promise<TResult>

Параметры

pollOptions

{ abortSignal?: AbortSignalLike }

Возвращаемое значение

Promise<TResult>

stopPolling()

Останавливает опрашиватель. После этого отправлять запросы вручную или автоматически не удастся.

function stopPolling()

toString()

Возвращает сериализованную версию операции опроса, вызвав метод toString операции.

function toString(): string

Возвращаемое значение

string