AnalysisResultPoller interface

一個用於分析操作的輪詢器。

屬性

作業標識碼。

繼承的屬性

isDone	如果民調員已經完成投票，這點就成立。
operationState	作業的狀態。如果投票者尚未提交，則可能是未定義的。
result	操作的結果值，無論輪詢器的狀態如何。根據實作不同，它可以是未定義或不完整的最終 TResult 值。
[toStringTag]

繼承的方法

catch<TResult>(null \| (reason: any) => TResult \| PromiseLike<TResult>)	只附上回撥，只針對拒絕承諾。
finally(null \| () => void)	附加一個回撥，當承諾達成（實現或拒絕）時會被啟動。解析後的值無法從回撥中被修改。
onProgress((state: AnalysisOperationState) => void)	每次輪詢完成後，會呼叫所提供的回撥，並傳送輪詢器操作的當前狀態。它會回傳一個方法，可用來停止接收對該回調函式的更新。
poll({ abortSignal?: AbortSignalLike })	回傳一個承諾，當單一輪詢請求結束後，該承諾就會被解決。它透過呼叫 polller 操作的更新方法來達成此目標。
pollUntilDone({ abortSignal?: AbortSignalLike })	回傳一個承諾，當底層操作完成後，該承諾將會被解決。
serialize()	回傳一個承諾，可透過呼叫序列化操作來實現輪詢操作序列化版本。
submitted()	回傳一個承諾，可用來檢查輪詢器是否已提交。
then<TResult1, TResult2>(null \| (value: AnalysisResult) => TResult1 \| PromiseLike<TResult1>, null \| (reason: any) => TResult2 \| PromiseLike<TResult2>)	附上回覆，以回應解決或拒絕承諾。

operationId

警告

此 API 現已淘汰。

Use operationState?.operationId instead.

作業標識碼。

operationId?: string

屬性值

string

isDone

如果民調員已經完成投票，這點就成立。

isDone: boolean

屬性值

boolean

繼承自 PollerLike.isDone

operationState

作業的狀態。如果投票者尚未提交，則可能是未定義的。

operationState: undefined | AnalysisOperationState

屬性值

undefined | AnalysisOperationState

繼承自 PollerLike.operationState

result

操作的結果值，無論輪詢器的狀態如何。根據實作不同，它可以是未定義或不完整的最終 TResult 值。

result: undefined | AnalysisResult

屬性值

undefined | AnalysisResult

繼承自 PollerLike.結果

[toStringTag]

[toStringTag]: string

屬性值

string

繼承自 PollerLike.__@toStringTag@335

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

只附上回撥，只針對拒絕承諾。

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

參數

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

當承諾被拒絕時，回調以執行。

傳回

Promise<AnalysisResult | TResult>

承諾完成回電。

繼承自 PollerLike.catch

finally(null | () => void)

附加一個回撥，當承諾達成（實現或拒絕）時會被啟動。解析後的值無法從回撥中被修改。

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

參數

onfinally: null | () => void

當承諾達成（實現或拒絕）時，回撥執行。

傳回

Promise<AnalysisResult>

承諾完成回電。

繼承自 終於像Poller一樣

onProgress((state: AnalysisOperationState) => void)

每次輪詢完成後，會呼叫所提供的回撥，並傳送輪詢器操作的當前狀態。

它會回傳一個方法，可用來停止接收對該回調函式的更新。

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

參數

callback: (state: AnalysisOperationState) => void

傳回

CancelOnProgress

繼承自 PollerLike.onProgress

poll({ abortSignal?: AbortSignalLike })

回傳一個承諾，當單一輪詢請求結束後，該承諾就會被解決。它透過呼叫 polller 操作的更新方法來達成此目標。

function poll(options?: { abortSignal?: AbortSignalLike }): Promise<AnalysisOperationState>

參數

options: { abortSignal?: AbortSignalLike }

傳回

Promise<AnalysisOperationState>

繼承自 PollerLike.poll

pollUntilDone({ abortSignal?: AbortSignalLike })

回傳一個承諾，當底層操作完成後，該承諾將會被解決。

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

參數

pollOptions: { abortSignal?: AbortSignalLike }

傳回

Promise<AnalysisResult>

繼承自 PollerLike.pollUntilDone

serialize()

回傳一個承諾，可透過呼叫序列化操作來實現輪詢操作序列化版本。

function serialize(): Promise<string>

傳回

Promise<string>

繼承自 PollerLike.serialize

submitted()

回傳一個承諾，可用來檢查輪詢器是否已提交。

function submitted(): Promise<void>

傳回

Promise<void>

繼承自 PollerLike。提交

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

附上回覆，以回應解決或拒絕承諾。

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

參數

onfulfilled: null | (value: AnalysisResult) => TResult1 | PromiseLike<TResult1>

當 Promise 解決時，回調執行。

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