你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

PollerLike interface

  • 参考
包:
@azure/core-lro

操作的轮询器。

Extends

Promise<TResult>

属性

isDone

如果轮询程序已完成轮询，则为 true。
operationState

操作的状态。 如果尚未提交轮询程序，则它可能是未定义的。
result

无论轮询器的状态如何，操作的结果值。 它可以是未定义或最终 TResult 值的不完整形式，具体取决于实现。

继承属性

[toStringTag]

方法

onProgress((state: TState) => void)

在完成每次轮询后调用提供的回调，并发送轮询程序操作的当前状态。

它返回一个方法，该方法可用于停止接收给定回调函数的更新。
poll({ abortSignal?: AbortSignalLike })

返回一个承诺，该承诺将在单个轮询请求完成后解析。 它通过调用 Poller 操作的 update 方法执行此操作。
pollUntilDone({ abortSignal?: AbortSignalLike })

返回一个承诺，该承诺将在基础操作完成后解析。
serialize()

返回一个承诺，它可以通过调用操作的序列化方法，用于轮询器操作的序列化版本。
submitted()

如果已提交投票器，则返回可用于检查的承诺。

继承的方法

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

仅对 Promise 的拒绝附加回调。
finally(null | () => void)

附加在解决承诺 (满足或拒绝) 时调用的回调。 无法从回调修改已解析的值。
then<TResult1, TResult2>(null | (value: TResult) => TResult1 | PromiseLike<TResult1>, null | (reason: any) => TResult2 | PromiseLike<TResult2>)

附加用于解决和/或拒绝承诺的回调。

属性详细信息

isDone

如果轮询程序已完成轮询，则为 true。

isDone: boolean

属性值

boolean

operationState

操作的状态。 如果尚未提交轮询程序，则它可能是未定义的。

operationState: undefined | TState

属性值

undefined | TState

result

无论轮询器的状态如何，操作的结果值。 它可以是未定义或最终 TResult 值的不完整形式，具体取决于实现。

result: undefined | TResult

属性值

undefined | TResult

继承属性详细信息

[toStringTag] 

[toStringTag]: string

属性值

string

继承自 Promise.__@toStringTag@68

方法详细信息

onProgress((state: TState) => void)

在完成每次轮询后调用提供的回调，并发送轮询程序操作的当前状态。

它返回一个方法，该方法可用于停止接收给定回调函数的更新。

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

参数

callback

(state: TState) => void

返回

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

返回一个承诺，该承诺将在单个轮询请求完成后解析。 它通过调用 Poller 操作的 update 方法执行此操作。

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>(null | (reason: any) => TResult | PromiseLike<TResult>)

仅对 Promise 的拒绝附加回调。

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

参数

onrejected

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

在拒绝 Promise 时执行的回调。

返回

Promise<TResult | TResult>

完成回调的承诺。

继承自 Promise.catch

finally(null | () => void)

附加在解决承诺 (满足或拒绝) 时调用的回调。 无法从回调修改已解析的值。

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

参数

onfinally

null | () => void

在解决承诺时要执行的回调 (履行或拒绝) 。

返回

Promise<TResult>

完成回调的承诺。

继承自 Promise.finally

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

附加用于解决和/或拒绝承诺的回调。

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

参数

onfulfilled

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

解析 Promise 时要执行的回调。

onrejected

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

在拒绝 Promise 时执行的回调。

返回

Promise<TResult1 | TResult2>

执行回调的完成承诺。

继承自 Promise.then