PollerLike interface

Пакет:

@azure/core-lro

Опрос для операции.

Extends

Promise<TResult>

Свойства

isDone	Значение true, если опрашиватель закончил опрос.
operationState	Состояние операции. Оно может быть неопределенным, если опрашиватель еще не отправлен.
result	Значение результата операции независимо от состояния опроса. Она может быть не определена или неполная форма окончательного значения TResult в зависимости от реализации.

Унаследованные свойства

[toStringTag]

Методы

onProgress((state: TState) => void)	Вызывает предоставленный обратный вызов после завершения каждого опроса, отправляя текущее состояние операции опроса. Он возвращает метод, который можно использовать для остановки получения обновлений для данной функции обратного вызова.
poll({ abortSignal?: AbortSignalLike })	Возвращает обещание, которое будет разрешаться после завершения одного запроса опроса. Это делается путем вызова метода обновления операции Poller.
pollUntilDone({ abortSignal?: AbortSignalLike })	Возвращает обещание, которое будет разрешаться после завершения базовой операции.
serialize()	Возвращает обещание, которое можно использовать для сериализованной версии операции опроса путем вызова метода сериализации операции.
submitted()	Возвращает обещание, которое можно использовать для проверки того, был ли отправлен опрашиватель.

Наследуемые методы

catch<TResult>((reason: any) => TResult | PromiseLike<TResult> | null)	Присоединяет обратный вызов только для отказа от обещания.
finally(() => void | null)	Присоединяет обратный вызов, который вызывается, когда обещание урегулировано (выполнено или отклонено). Разрешенное значение нельзя изменить из обратного вызова.
then<TResult1, TResult2>((value: TResult) => TResult1 | PromiseLike<TResult1> | null, (reason: any) => TResult2 | PromiseLike<TResult2> | null)	Присоединяет обратные вызовы для разрешения и /или отказа от обещания.

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

isDone

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

isDone: boolean

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

boolean

operationState

Состояние операции. Оно может быть неопределенным, если опрашиватель еще не отправлен.

operationState: TState | undefined

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

TState | undefined

result

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

result: TResult | undefined

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

TResult | undefined

Сведения об унаследованном свойстве

[toStringTag]

[toStringTag]: string

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

string

Унаследовано от Обещания. [toStringTag]

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

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<TState>

Параметры

options

{ abortSignal?: AbortSignalLike }

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

Promise<TState>

pollUntilDone({ abortSignal?: AbortSignalLike })

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

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

Параметры

pollOptions

{ abortSignal?: AbortSignalLike }

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

Promise<TResult>

serialize()

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

function serialize(): Promise<string>

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

Promise<string>

submitted()

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

function submitted(): Promise<void>

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

Promise<void>

Сведения о наследуемом методе

catch<TResult>((reason: any) => TResult | PromiseLike<TResult> | null)

Присоединяет обратный вызов только для отказа от обещания.

function catch<TResult>(onrejected?: (reason: any) => TResult | PromiseLike<TResult> | null): Promise<TResult | TResult>

Параметры

onrejected

(reason: any) => TResult | PromiseLike<TResult> | null

Обратный вызов, выполняемый при отклонении обещания.

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

Promise<TResult | TResult>

Обещание завершения обратного вызова.

унаследован от Promise.catch

finally(() => void | null)

Присоединяет обратный вызов, который вызывается, когда обещание урегулировано (выполнено или отклонено). Разрешенное значение нельзя изменить из обратного вызова.

function finally(onfinally?: () => void | null): Promise<TResult>

Параметры

onfinally

() => void | null

Обратный вызов для выполнения, когда обещание будет урегулировано (выполнено или отклонено).

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

Promise<TResult>

Обещание завершения обратного вызова.

унаследован от Promise.finally

then<TResult1, TResult2>((value: TResult) => TResult1 | PromiseLike<TResult1> | null, (reason: any) => TResult2 | PromiseLike<TResult2> | null)

Присоединяет обратные вызовы для разрешения и /или отказа от обещания.

function then<TResult1, TResult2>(onfulfilled?: (value: TResult) => TResult1 | PromiseLike<TResult1> | null, onrejected?: (reason: any) => TResult2 | PromiseLike<TResult2> | null): Promise<TResult1 | TResult2>

Параметры

onfulfilled

(value: TResult) => TResult1 | PromiseLike<TResult1> | null

Обратный вызов, выполняемый при разрешении обещания.

onrejected

(reason: any) => TResult2 | PromiseLike<TResult2> | null

Обратный вызов, выполняемый при отклонении обещания.

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

Promise<TResult1 | TResult2>

Обещание для завершения которого когда-либо выполняется обратный вызов.

наследуется от Promise.затем