SimplePollerLike interface

操作の状態を返します。

function getOperationState(): TState

戻り値

ポーリングの状態に関係なく、操作の結果値を返します。 実装によっては、未定義または不完全な形式の最終的な TResult 値を返すことができます。

function getResult(): undefined | TResult

戻り値

ポーリングが完了した場合は true を返します。

function isDone(): boolean

戻り値

ポーリングが停止している場合は true を返します。

function isStopped(): boolean

戻り値

ポーリングの完了後に指定されたコールバックを呼び出し、ポーリング者の操作の現在の状態を送信します。

指定されたコールバック関数の更新プログラムの受信を停止するために使用できるメソッドを返します。

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

パラメーター

戻り値

1 回のポーリング要求が完了すると解決される Promise を返します。 これは、Poller の操作の更新メソッドを呼び出すことによって行われます。

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

パラメーター

戻り値

基になる操作が完了すると解決される Promise を返します。

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

パラメーター

戻り値

操作のシリアル化メソッドを呼び出すことによって、ポーリング者の操作のシリアル化されたバージョンに使用できる Promise を返します。

function serialize(): Promise<string>

戻り値

ポーリングを続行するポーリングを停止します。 これにより、クライアント側のポーリングのみが停止されることに注意してください

function stopPolling()

投票者が送信されるのを待ちます。

function submitted(): Promise<void>

戻り値

ポーリング者の操作の文字列形式を返します。 シリアル化に似ていますが、文字列を返します。

function toString(): string

戻り値