PollerLike interface

Balíček:

@azure/keyvault-secrets

Abstraktní reprezentace polleru, která má vystavit pouze minimální rozhraní API, se kterým musí uživatel pracovat.

Metody

cancelOperation({ abortSignal?: AbortSignalLike })	Pokusí se zrušit základní operaci.
getOperationState()	Vrátí stav operace. TState definované v PollerLike může být podmnožinou TState definované v poller implementace.
getResult()	Vrátí výslednou hodnotu operace bez ohledu na stav vrtule. V závislosti na implementaci může vrátit nedefinovanou nebo neúplnou formu konečné hodnoty TResult.
isDone()	Vrátí hodnotu true, pokud poller dokončil dotazování.
isStopped()	Vrátí hodnotu true, pokud je poller zastaven.
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.
stopPolling()	Zastaví poller. Potom se nedají odesílat žádné ruční ani automatizované požadavky.
toString()	Vrátí serializovanou verzi operace poller vyvoláním metody toString operace.

Podrobnosti metody

cancelOperation({ abortSignal?: AbortSignalLike })

Upozornění

Toto rozhraní API je teď zastaralé.

cancelOperation has been deprecated because it was not implemented.

Pokusí se zrušit základní operaci.

function cancelOperation(options?: { abortSignal?: AbortSignalLike }): Promise<void>

Parametry

options

{ abortSignal?: AbortSignalLike }

Návraty

Promise<void>

getOperationState()

Vrátí stav operace. TState definované v PollerLike může být podmnožinou TState definované v poller implementace.

function getOperationState(): TState

Návraty

TState

getResult()

Vrátí výslednou hodnotu operace bez ohledu na stav vrtule. V závislosti na implementaci může vrátit nedefinovanou nebo neúplnou formu konečné hodnoty TResult.

function getResult(): undefined | TResult

Návraty

undefined | TResult

isDone()

Vrátí hodnotu true, pokud poller dokončil dotazování.

function isDone(): boolean

Návraty

boolean

isStopped()

Vrátí hodnotu true, pokud je poller zastaven.

function isStopped(): boolean

Návraty

boolean

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<void>

Parametry

options

{ abortSignal?: AbortSignalLike }

Návraty

Promise<void>

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>

stopPolling()

Zastaví poller. Potom se nedají odesílat žádné ruční ani automatizované požadavky.

function stopPolling()

toString()

Vrátí serializovanou verzi operace poller vyvoláním metody toString operace.

function toString(): string

Návraty

string