SimplePollerLike interface

套件:

@azure-rest/maps-route

簡單的輪詢器，可用來輪詢長時間執行的作業。

方法

getOperationState()	傳回作業的狀態。
getResult()	傳回作業的結果值，不論輪詢器的狀態為何。 視實作而定，它可以傳回未定義或不完整的 TResult 值形式。
isDone()	如果輪詢器已完成輪詢，則傳回 true。
isStopped()	如果輪詢器已停止，則傳回 true。
onProgress((state: TState) => void)	在每個輪詢完成之後，叫用提供的回呼，並傳送輪詢器作業的目前狀態。 它會傳回方法，可用來停止接收指定回呼函式上的更新。
poll({ abortSignal?: AbortSignalLike })	傳回承諾，一旦單一輪詢要求完成，就會解決。 其做法是呼叫 Poller 作業的 update 方法。
pollUntilDone({ abortSignal?: AbortSignalLike })	傳回承諾，此承諾會在基礎作業完成之後解決。
serialize()	傳回承諾，這個承諾可藉由叫用作業的串行化方法來串行化輪詢程序的作業版本。
stopPolling()	阻止投票者繼續輪詢。 請注意，這隻會停止用戶端輪詢
submitted()	等候投票器提交。
toString()	傳迴輪詢器作業的字串表示。 類似於串行化，但會傳回字串。

方法詳細資料

getOperationState()

傳回作業的狀態。

function getOperationState(): TState

傳回

TState

getResult()

傳回作業的結果值，不論輪詢器的狀態為何。 視實作而定，它可以傳回未定義或不完整的 TResult 值形式。

function getResult(): undefined | TResult

傳回

undefined | TResult

isDone()

如果輪詢器已完成輪詢，則傳回 true。

function isDone(): boolean

傳回

boolean

isStopped()

警告

此 API 現已淘汰。

Use abortSignal status to track this instead.

如果輪詢器已停止，則傳回 true。

function isStopped(): boolean

傳回

boolean

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>

stopPolling()

警告

此 API 現已淘汰。

Use abortSignal to stop polling instead.

阻止投票者繼續輪詢。 請注意，這隻會停止用戶端輪詢

function stopPolling()

submitted()

等候投票器提交。

function submitted(): Promise<void>

傳回

Promise<void>

toString()

警告

此 API 現已淘汰。

Use serialize() instead.

傳迴輪詢器作業的字串表示。 類似於串行化，但會傳回字串。

function toString(): string

傳回

string