PollerLike interface

Пакет:

@azure/keyvault-keys

Абстрактное представление опроса, предназначенное для предоставления только минимального 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