PollerLike interface

  • Reference
Balíček:
@azure/core-lro

A poller for an operation.

Extends

Promise<TResult>

Vlastnosti

isDone

Je pravda, pokud poller dokončil dotazování.
operationState

Stav operace. Může být nedefinováno, pokud ještě nebyla odeslána poller.
result

Výsledná hodnota operace bez ohledu na stav vrtu. V závislosti na implementaci může být nedefinovaná nebo neúplná forma konečné hodnoty TResult.

Zděděné vlastnosti

[toStringTag]

Metody

onProgress((state: TState) => void)

Vyvolá poskytnuté zpětné volání po dokončení každého dotazování a odešle aktuální stav operace poller.

Vrátí metodu, která se dá použít k zastavení příjmu aktualizací dané funkce zpětného volání.
poll({ abortSignal?: AbortSignalLike })

Vrátí příslib, který se vyřeší po dokončení jednoho požadavku na dotazování. Provede to voláním metody aktualizace operace Poller.
pollUntilDone({ abortSignal?: AbortSignalLike })

Vrátí příslib, který se vyřeší po dokončení základní operace.
serialize()

Vrátí příslib, který lze použít pro serializovanou verzi operace poller vyvoláním metody serializace operace.
submitted()

Vrátí příslib, který lze použít ke kontrole, jestli byla odeslána poller.

Zděděné metody

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

Připojí zpětné volání pouze pro odmítnutí příslibu.
finally(null | () => void)

Připojí zpětné volání, které se vyvolá při vyrovnání příslibu (splněno nebo odmítnuto). Přeloženou hodnotu nelze změnit z zpětného volání.
then<TResult1, TResult2>(null | (value: TResult) => TResult1 | PromiseLike<TResult1>, null | (reason: any) => TResult2 | PromiseLike<TResult2>)

Připojí zpětná volání pro řešení a/nebo odmítnutí příslibu.

Podrobnosti vlastnosti

isDone

Je pravda, pokud poller dokončil dotazování.

isDone: boolean

Hodnota vlastnosti

boolean

operationState

Stav operace. Může být nedefinováno, pokud ještě nebyla odeslána poller.

operationState: undefined | TState

Hodnota vlastnosti

undefined | TState

result

Výsledná hodnota operace bez ohledu na stav vrtu. V závislosti na implementaci může být nedefinovaná nebo neúplná forma konečné hodnoty TResult.

result: undefined | TResult

Hodnota vlastnosti

undefined | TResult

Podrobnosti zděděných vlastností

[toStringTag] 

[toStringTag]: string

Hodnota vlastnosti

string

zděděno ze Promise.__@toStringTag@68

Podrobnosti metody

onProgress((state: TState) => void)

Vyvolá poskytnuté zpětné volání po dokončení každého dotazování a odešle aktuální stav operace poller.

Vrátí metodu, která se dá použít k zastavení příjmu aktualizací dané funkce zpětného volání.

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

Parametry

callback

(state: TState) => void

Návraty

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Vrátí příslib, který se vyřeší po dokončení jednoho požadavku na dotazování. Provede to voláním metody aktualizace operace Poller.

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

Parametry

options

{ abortSignal?: AbortSignalLike }

Návraty

Promise<TState>

pollUntilDone({ abortSignal?: AbortSignalLike })

Vrátí příslib, který se vyřeší po dokončení základní operace.

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

Parametry

pollOptions

{ abortSignal?: AbortSignalLike }

Návraty

Promise<TResult>

serialize()

Vrátí příslib, který lze použít pro serializovanou verzi operace poller vyvoláním metody serializace operace.

function serialize(): Promise<string>

Návraty

Promise<string>

submitted()

Vrátí příslib, který lze použít ke kontrole, jestli byla odeslána poller.

function submitted(): Promise<void>

Návraty

Promise<void>

Podrobnosti zděděných metod

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

Připojí zpětné volání pouze pro odmítnutí příslibu.

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

Parametry

onrejected

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

Zpětné volání, které se má provést při odmítnutí příslibu.

Návraty

Promise<TResult | TResult>

Příslib dokončení zpětného volání.

zděděno ze souboru Promise.catch

finally(null | () => void)

Připojí zpětné volání, které se vyvolá při vyrovnání příslibu (splněno nebo odmítnuto). Přeloženou hodnotu nelze změnit z zpětného volání.

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

Parametry

onfinally

null | () => void

Zpětné volání, které se má provést při vyrovnání příslibu (splněno nebo odmítnuto).

Návraty

Promise<TResult>

Příslib dokončení zpětného volání.

zděděno z Promise.finally

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

Připojí zpětná volání pro řešení a/nebo odmítnutí příslibu.

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

Parametry

onfulfilled

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

Zpětné volání, které se má provést při vyřešení příslibu.

onrejected

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

Zpětné volání, které se má provést při odmítnutí příslibu.

Návraty

Promise<TResult1 | TResult2>

Příslib dokončení, jehož zpětné volání se spustí.

zděděno ze Promise.then