次の方法で共有

PollerLike interface

  • リファレンス
パッケージ:
@azure/core-lro

操作のポーリング者。

Extends

Promise<TResult>

プロパティ

isDone

ポーリングが終了した場合は true です。
operationState

操作の状態。 ポーリング者がまだ送信されていない場合は、未定義にすることができます。
result

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

継承されたプロパティ

[toStringTag]

メソッド

onProgress((state: TState) => void)

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

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

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

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

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

投票者が送信されたかどうかを確認するために使用できる約束を返します。

継承されたメソッド

catch<TResult>(null | (reason: any) => TResult | PromiseLike<TResult>)

Promise の拒否に対してのみコールバックをアタッチします。
finally(null | () => void)

Promise が解決 (フルフィルメントまたは拒否) されたときに呼び出されるコールバックをアタッチします。 解決された値はコールバックから変更できません。
then<TResult1, TResult2>(null | (value: TResult) => TResult1 | PromiseLike<TResult1>, null | (reason: any) => TResult2 | PromiseLike<TResult2>)

Promise の解決または拒否のコールバックをアタッチします。

プロパティの詳細

isDone

ポーリングが終了した場合は true です。

isDone: boolean

プロパティ値

boolean

operationState

操作の状態。 ポーリング者がまだ送信されていない場合は、未定義にすることができます。

operationState: undefined | TState

プロパティ値

undefined | TState

result

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

result: undefined | TResult

プロパティ値

undefined | TResult

継承されたプロパティの詳細

[toStringTag] 

[toStringTag]: string

プロパティ値

string

Promise.__@toStringTag@68 から継承された

メソッドの詳細

onProgress((state: TState) => void)

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

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

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

パラメーター

callback

(state: TState) => void

戻り値

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

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

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

パラメーター

options

{ abortSignal?: AbortSignalLike }

戻り値

Promise<TState>

pollUntilDone({ abortSignal?: AbortSignalLike })

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

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

パラメーター

pollOptions

{ abortSignal?: AbortSignalLike }

戻り値

Promise<TResult>

serialize()

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

function serialize(): Promise<string>

戻り値

Promise<string>

submitted()

投票者が送信されたかどうかを確認するために使用できる約束を返します。

function submitted(): Promise<void>

戻り値

Promise<void>

継承済みメソッドの詳細

catch<TResult>(null | (reason: any) => TResult | PromiseLike<TResult>)

Promise の拒否に対してのみコールバックをアタッチします。

function catch<TResult>(onrejected?: null | (reason: any) => TResult | PromiseLike<TResult>): Promise<TResult | TResult>

パラメーター

onrejected

null | (reason: any) => TResult | PromiseLike<TResult>

Promise が拒否されたときに実行するコールバック。

戻り値

Promise<TResult | TResult>

コールバックの完了を示す Promise。

Promise.catch から継承された

finally(null | () => void)

Promise が解決 (フルフィルメントまたは拒否) されたときに呼び出されるコールバックをアタッチします。 解決された値はコールバックから変更できません。

function finally(onfinally?: null | () => void): Promise<TResult>

パラメーター

onfinally

null | () => void

Promise が決済 (フルフィルメントまたは拒否) されたときに実行するコールバック。

戻り値

Promise<TResult>

コールバックの完了を示す Promise。

Promise から継承された .finally

then<TResult1, TResult2>(null | (value: TResult) => TResult1 | PromiseLike<TResult1>, null | (reason: any) => TResult2 | PromiseLike<TResult2>)

Promise の解決または拒否のコールバックをアタッチします。

function then<TResult1, TResult2>(onfulfilled?: null | (value: TResult) => TResult1 | PromiseLike<TResult1>, onrejected?: null | (reason: any) => TResult2 | PromiseLike<TResult2>): Promise<TResult1 | TResult2>

パラメーター

onfulfilled

null | (value: TResult) => TResult1 | PromiseLike<TResult1>

Promise が解決されたときに実行するコールバック。

onrejected

null | (reason: any) => TResult2 | PromiseLike<TResult2>

Promise が拒否されたときに実行するコールバック。

戻り値

Promise<TResult1 | TResult2>

コールバックが実行される完了の Promise。

promise から継承された します。その後