SimplePollerLike interface

Pakiet:

@azure/arm-elasticsan

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 stanu pollera. Może zwracać niezdefiniowaną lub niepełną formę końcowej wartości TResult, w zależności od implementacji.
isDone()	Zwraca się prawda, jeśli spółka skończyła odpytywanie.
isStopped()	Zwraca wartość true, jeśli pyler zostanie zatrzymany.
onProgress((state: TState) => void)	Wywołuje dostarczone callback po zakończeniu każdego odpytywania, wysyłając aktualny stan operacji pollera. Zwraca metodę, którą można użyć do zaprzestania otrzymywania aktualizacji danej funkcji callback.
poll({ abortSignal?: AbortSignalLike })	Zwraca obietnicę, która zostanie rozwiązana, gdy zakończy się pojedyncze zgłoszenie. Robi to, wywołując metodę aktualizacji operacji Pollera.
pollUntilDone({ abortSignal?: AbortSignalLike })	Zwraca obietnicę, która zostanie rozwiązana po zakończeniu operacji bazowej.
serialize()	Zwraca obietnicę, którą można użyć w serializowanej wersji operacji Pollera poprzez wywołanie metody serializacji operacji.
stopPolling()	Powstrzymuje ankieterów przed dalszym sondażem. Proszę pamiętać, że to zatrzyma jedynie ankiety po stronie klienta
submitted()	Poczekaj na przesłanie ankiety.
toString()	Zwraca reprezentację ciągu operacji Pollera. Podobnie jak serializacja, ale zwraca ciąg znaków.

Szczegóły metody

getOperationState()

Zwraca stan operacji.

function getOperationState(): TState

Zwraca

TState

getResult()

Zwraca wartość wynikową operacji, niezależnie od stanu pollera. Może zwracać niezdefiniowaną lub niepełną formę końcowej wartości TResult, w zależności od implementacji.

function getResult(): undefined | TResult

Zwraca

undefined | TResult

isDone()

Zwraca się prawda, jeśli spółka skończyła odpytywanie.

function isDone(): boolean

Zwraca

boolean

isStopped()

Ostrzeżenie

To API jest obecnie wycofane.

Use abortSignal status to track this instead.

Zwraca wartość true, jeśli pyler zostanie zatrzymany.

function isStopped(): boolean

Zwraca

boolean

onProgress((state: TState) => void)

Wywołuje dostarczone callback po zakończeniu każdego odpytywania, wysyłając aktualny stan operacji pollera.

Zwraca metodę, którą można użyć do zaprzestania otrzymywania aktualizacji danej funkcji callback.

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

Parametry

callback

(state: TState) => void

Zwraca

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Zwraca obietnicę, która zostanie rozwiązana, gdy zakończy się pojedyncze zgłoszenie. Robi to, wywołując metodę aktualizacji operacji Pollera.

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

Parametry

options

{ abortSignal?: AbortSignalLike }

Zwraca

Promise<TState>

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>

serialize()

Zwraca obietnicę, którą można użyć w serializowanej wersji operacji Pollera poprzez wywołanie metody serializacji operacji.

function serialize(): Promise<string>

Zwraca

Promise<string>

stopPolling()

Ostrzeżenie

To API jest obecnie wycofane.

Use abortSignal to stop polling instead.

Powstrzymuje ankieterów przed dalszym sondażem. Proszę pamiętać, że to zatrzyma jedynie ankiety po stronie klienta

function stopPolling()

submitted()

Poczekaj na przesłanie ankiety.

function submitted(): Promise<void>

Zwraca

Promise<void>

toString()

Ostrzeżenie

To API jest obecnie wycofane.

Use serialize() instead.

Zwraca reprezentację ciągu operacji Pollera. Podobnie jak serializacja, ale zwraca ciąg znaków.

function toString(): string

Zwraca

string