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)	附加在 Promise 解決時叫用的回呼（已履行或拒絕）。 解析的值無法從回呼修改。
then<TResult1, TResult2>(null | (value: TResult) => TResult1 | PromiseLike<TResult1>, null | (reason: any) => TResult2 | PromiseLike<TResult2>)	附加 Promise 解析和/或拒絕承諾的回呼。

屬性詳細資料

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。

繼承自 Promise.catch

finally(null | () => void)

附加在 Promise 解決時叫用的回呼（已履行或拒絕）。 解析的值無法從回呼修改。

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

參數

onfinally

null | () => void

當 Promise 解決時要執行的回呼（已履行或拒絕）。

傳回

Promise<TResult>

完成回呼的 Promise。

繼承自 Promise。finally

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

附加 Promise 解析和/或拒絕承諾的回呼。

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。

繼承自 Promise.then