@azure/core-lro package

介面

CreateHttpPollerOptions	createPoller的選項。
OperationConfig	如何輪詢作業及檢查作業是否已終止的設定。
OperationResponse	LRO 回應的類型。
OperationState	當輪詢器當做本機控制機制來開始觸發並等候長時間執行的作業時，OperationState 會記錄遠端長時間執行作業的狀態。 它會在每個輪詢之後更新。
PollerLike	作業的輪詢器。
RawRequest	原始要求的簡單類型。
RawResponse	原始回應的簡單類型。
RunningOperation	長時間執行作業的描述。

類型別名

CancelOnProgress	CancelOnProgress 會當做 Poller onProgress 方法的傳回值使用。 當使用者叫用 onProgress 時，必須傳入函式，以回呼的形式呼叫，並在每次更新輪詢作業時收到新的數據。 onProgress 會傳回函式，以防止任何進一步的更新到達原始回呼。
OperationStatus	作業隨時都可以處於的可能狀態集合。
ResourceLocationConfig	如果由 Swagger 中的 LRO 延伸模組所指定，則為 LRO 結果的潛在位置。
RestorableOperationState	可還原長時間執行的作業類型。

函式

createHttpPoller<TResult, TState>(RunningOperation<unknown>, CreateHttpPollerOptions<TResult, TState>)	建立輪詢器，可用來輪詢長時間執行的作業。
deserializeState<TResult, TState>(string)	還原串行化狀態

函式詳細資料

createHttpPoller<TResult, TState>(RunningOperation<unknown>, CreateHttpPollerOptions<TResult, TState>)

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

function createHttpPoller<TResult, TState>(lro: RunningOperation<unknown>, options?: CreateHttpPollerOptions<TResult, TState>): PollerLike<TState, TResult>

參數

lro

RunningOperation<unknown>

長時間執行作業的描述

options

CreateHttpPollerOptions<TResult, TState>

設定輪詢器的選項

傳回

PollerLike<TState, TResult>

初始化的輪詢器

deserializeState<TResult, TState>(string)

還原串行化狀態

function deserializeState<TResult, TState>(serializedState: string): RestorableOperationState<TResult, TState>

參數

serializedState

string

傳回

RestorableOperationState<TResult, TState>