PollerLike interface

  • Odwołanie
Pakiet:
@azure/keyvault-secrets

Abstrakcyjna reprezentacja narzędzia poller, która ma na celu uwidocznienie tylko minimalnego interfejsu API, z którymi użytkownik musi pracować.

Metody

cancelOperation({ abortSignal?: AbortSignalLike })

Próbuje anulować operację bazową.
getOperationState()

Zwraca stan operacji. Wartość TState zdefiniowana w języku PollerLike może być podzbiorem wartości TState zdefiniowanej w implementacji języka Poller.
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 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 firmy 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 przez wywołanie metody aktualizacji operacji poller.
pollUntilDone({ abortSignal?: AbortSignalLike })

Zwraca obietnicę, która zostanie rozwiązana po zakończeniu operacji bazowej.
stopPolling()

Zatrzymuje poller. Po tym nie można wysyłać żadnych żądań ręcznych ani automatycznych.
toString()

Zwraca serializowaną wersję operacji poller, wywołując metodę toString operacji.

Szczegóły metody

cancelOperation({ abortSignal?: AbortSignalLike })

Ostrzeżenie

Ten interfejs API jest już przestarzały.

cancelOperation has been deprecated because it was not implemented.

Próbuje anulować operację bazową.

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

Parametry

options

{ abortSignal?: AbortSignalLike }

Zwraca

Promise<void>

getOperationState()

Zwraca stan operacji. Wartość TState zdefiniowana w języku PollerLike może być podzbiorem wartości TState zdefiniowanej w implementacji języka Poller.

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 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 firmy 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 przez wywołanie metody aktualizacji operacji poller.

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

Parametry

options

{ abortSignal?: AbortSignalLike }

Zwraca

Promise<void>

pollUntilDone({ abortSignal?: AbortSignalLike })

Zwraca obietnicę, która zostanie rozwiązana po zakończeniu operacji bazowej.

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

Parametry

pollOptions

{ abortSignal?: AbortSignalLike }

Zwraca

Promise<TResult>

stopPolling()

Zatrzymuje poller. Po tym nie można wysyłać żadnych żądań ręcznych ani automatycznych.

function stopPolling()

toString()

Zwraca serializowaną wersję operacji poller, wywołując metodę toString operacji.

function toString(): string

Zwraca

string