PollerLike interface

參考

套件:: @azure/storage-blob

輪詢器的抽象標記法，旨在只公開使用者需要使用的最小 API。

方法

cancelOperation({ abortSignal?: AbortSignalLike })	嘗試取消基礎作業。
getOperationState()	傳回作業的狀態。 PollerLike 中定義的 TState 可以是 Poller 實作中定義的 TState 子集。
getResult()	傳回作業的結果值，不論輪詢器的狀態為何。它可以根據實作傳回未定義的或不完整形式的最終 TResult 值。
isDone()	如果輪詢器已完成輪詢，則會傳回 true。
isStopped()	如果輪詢器已停止，則會傳回 true。
onProgress((state: TState) => void)	在每個輪詢完成之後叫用提供的回呼，並傳送輪詢器作業的目前狀態。它會傳回方法，可用來停止接收指定回呼函式上的更新。
poll({ abortSignal?: AbortSignalLike })	傳回承諾，一旦單一輪詢要求完成，就會解決。其做法是呼叫 Poller 作業的 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

傳回

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

傳回承諾，一旦單一輪詢要求完成，就會解決。其做法是呼叫 Poller 作業的 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