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

PollerLike interface

轮询器抽象表示形式,旨在公开用户需要使用的最小 API。

方法

cancelOperation({ abortSignal?: AbortSignalLike })

尝试取消基础操作。

getOperationState()

返回操作的状态。 PollerLike 中定义的 TState 可以是 Poller 实现中定义的 TState 的子集。

getResult()

返回操作的结果值,而不考虑轮询器的状态。 它可以返回未定义或不完整形式的最终 TResult 值,具体取决于实现。

isDone()

如果轮询器已完成轮询,则返回 true。

isStopped()

如果停止轮询器,则返回 true。

onProgress((state: TState) => void)

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

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

poll({ abortSignal?: AbortSignalLike })

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

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()

返回操作的状态。 PollerLike 中定义的 TState 可以是 Poller 实现中定义的 TState 的子集。

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

返回

poll({ abortSignal?: AbortSignalLike })

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

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