SimplePollerLike interface

套件:

@azure/arm-elasticsan

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

方法

getOperationState()	回傳操作狀態。
getResult()	回傳操作的結果值，無論輪詢器的狀態如何。 根據實作不同，它可能回傳未定義或不完整的最終 TResult 值。
isDone()	如果民調器已完成投票，則回傳為真。
isStopped()	如果輪詢器被停止，則回傳為真。
onProgress((state: TState) => void)	每次輪詢完成後，會呼叫所提供的回撥，並傳送輪詢器操作的當前狀態。 它會回傳一個方法，可用來停止接收對該回調函式的更新。
poll({ abortSignal?: AbortSignalLike })	回傳一個承諾，當單一輪詢請求結束後，該承諾就會被解決。 它透過呼叫 polller 操作的更新方法來達成此目標。
pollUntilDone({ abortSignal?: AbortSignalLike })	回傳一個承諾，當底層操作完成後，該承諾將會被解決。
serialize()	回傳一個承諾，可透過呼叫序列化操作來實現輪詢操作序列化版本。
stopPolling()	阻止投票者繼續投票。 請注意，這只會停止用戶端輪詢
submitted()	等待投票者提交。
toString()	回傳輪詢器操作的字串表示。 類似於序列化，但會回傳一個字串。

方法詳細資料

getOperationState()

回傳操作狀態。

function getOperationState(): TState

傳回

TState

getResult()

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

function getResult(): undefined | TResult

傳回

undefined | TResult

isDone()

如果民調器已完成投票，則回傳為真。

function isDone(): boolean

傳回

boolean

isStopped()

警告

此 API 現已淘汰。

Use abortSignal status to track this instead.

如果輪詢器被停止，則回傳為真。

function isStopped(): boolean

傳回

boolean

onProgress((state: TState) => void)

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

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

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

參數

callback

(state: TState) => void

傳回

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

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

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