PollerLike interface

Pakiet:

@azure/keyvault-admin

Prosty poller, który może służyć do sondowania długotrwałej operacji.

Metody

getOperationState()	Zwraca stan operacji.
getResult()	Zwraca wartość wynikową operacji, niezależnie od stanullera. Może zwrócić niezdefiniowaną lub niekompletną postać ostatecznej wartości TResult w zależności od implementacji.
isDone()	Zwraca wartość true, jeśli poller zakończył sondowanie.
isStopped()	Zwraca wartość true, jeśli element poller jest zatrzymany.
onProgress((state: TState) => void)	Wywołuje podane wywołanie zwrotne po zakończeniu każdego sondowania, wysyłając bieżący stan operacji poller. Zwraca metodę, która może służyć do zatrzymywania odbierania aktualizacji w danej funkcji wywołania zwrotnego.
poll({ abortSignal?: AbortSignalLike })	Zwraca obietnicę, która zostanie rozwiązana po zakończeniu pojedynczego żądania sondowania. Robi to, wywołując metodę aktualizacji operacji Pollera.
pollUntilDone({ abortSignal?: AbortSignalLike })	Zwraca obietnicę, która zostanie rozpoznana po zakończeniu operacji bazowej.
stopPolling()	Zatrzymuje poller od kontynuowania sondowania. Należy pamiętać, że spowoduje to zatrzymanie sondowania po stronie klienta
toString()	Zwraca reprezentację ciągu operacji pollera. Podobnie jak serializowanie, ale zwraca ciąg.

Szczegóły metody

getOperationState()

Zwraca stan operacji.

function getOperationState(): TState

Zwraca

TState

getResult()

Zwraca wartość wynikową operacji, niezależnie od stanullera. Może zwrócić niezdefiniowaną lub niekompletną postać ostatecznej wartości TResult w zależności od implementacji.

function getResult(): undefined | TResult

Zwraca

undefined | TResult

isDone()

Zwraca wartość true, jeśli poller zakończył sondowanie.

function isDone(): boolean

Zwraca

boolean

isStopped()

Zwraca wartość true, jeśli element poller jest zatrzymany.

function isStopped(): boolean

Zwraca

boolean

onProgress((state: TState) => void)

Wywołuje podane wywołanie zwrotne po zakończeniu każdego sondowania, wysyłając bieżący stan operacji poller.

Zwraca metodę, która może służyć do zatrzymywania odbierania aktualizacji w danej funkcji wywołania zwrotnego.

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

Parametry

callback

(state: TState) => void

Zwraca

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Zwraca obietnicę, która zostanie rozwiązana po zakończeniu pojedynczego żądania sondowania. Robi to, wywołując metodę aktualizacji operacji Pollera.

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

Parametry

options

{ abortSignal?: AbortSignalLike }

Zwraca

Promise<void>

pollUntilDone({ abortSignal?: AbortSignalLike })

Zwraca obietnicę, która zostanie rozpoznana po zakończeniu operacji bazowej.

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

Parametry

pollOptions

{ abortSignal?: AbortSignalLike }

Zwraca

Promise<TResult>

stopPolling()

Zatrzymuje poller od kontynuowania sondowania. Należy pamiętać, że spowoduje to zatrzymanie sondowania po stronie klienta

function stopPolling()

toString()

Zwraca reprezentację ciągu operacji pollera. Podobnie jak serializowanie, ale zwraca ciąg.

function toString(): string

Zwraca

string