Udostępnij za pośrednictwem

PollerLike interface

  • Odwołanie
Pakiet:
@azure/core-lro

Poller dla operacji.

Rozszerzenie

Promise<TResult>

Właściwości

isDone

To prawda, jeśli poller zakończył sondowanie.
operationState

Stan operacji. Może to być niezdefiniowane, jeśli poller nie został jeszcze przesłany.
result

Wartość wynikowa operacji, niezależnie od stanullera. Może być niezdefiniowana lub niekompletna forma ostatecznej wartości TResult w zależności od implementacji.

Właściwości dziedziczone

[toStringTag]

Metody

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.
serialize()

Zwraca obietnicę, która może być używana do serializacji wersji operacji poller, wywołując metodę serializacji operacji.
submitted()

Zwraca obietnicę, która może służyć do sprawdzania, czy poller został przesłany.

Metody dziedziczone

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

Dołącza wywołanie zwrotne tylko do odrzucenia obietnicy.
finally(null | () => void)

Dołącza wywołanie zwrotne wywoływane po rozliczeniu obietnicy (spełnione lub odrzucone). Nie można zmodyfikować rozpoznanej wartości z wywołania zwrotnego.
then<TResult1, TResult2>(null | (value: TResult) => TResult1 | PromiseLike<TResult1>, null | (reason: any) => TResult2 | PromiseLike<TResult2>)

Dołącza wywołania zwrotne do rozwiązania i/lub odrzucenia obietnicy.

Szczegóły właściwości

isDone

To prawda, jeśli poller zakończył sondowanie.

isDone: boolean

Wartość właściwości

boolean

operationState

Stan operacji. Może to być niezdefiniowane, jeśli poller nie został jeszcze przesłany.

operationState: undefined | TState

Wartość właściwości

undefined | TState

result

Wartość wynikowa operacji, niezależnie od stanullera. Może być niezdefiniowana lub niekompletna forma ostatecznej wartości TResult w zależności od implementacji.

result: undefined | TResult

Wartość właściwości

undefined | TResult

Szczegóły właściwości dziedziczonej

[toStringTag] 

[toStringTag]: string

Wartość właściwości

string

dziedziczone z Promise.__@toStringTag@68

Szczegóły metody

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

Parametry

options

{ abortSignal?: AbortSignalLike }

Zwraca

Promise<TState>

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>

serialize()

Zwraca obietnicę, która może być używana do serializacji wersji operacji poller, wywołując metodę serializacji operacji.

function serialize(): Promise<string>

Zwraca

Promise<string>

submitted()

Zwraca obietnicę, która może służyć do sprawdzania, czy poller został przesłany.

function submitted(): Promise<void>

Zwraca

Promise<void>

Szczegóły metody dziedziczonej

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

Dołącza wywołanie zwrotne tylko do odrzucenia obietnicy.

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

Parametry

onrejected

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

Wywołanie zwrotne do wykonania po odrzuceniu obietnicy.

Zwraca

Promise<TResult | TResult>

Obietnica ukończenia wywołania zwrotnego.

dziedziczone z Promise.catch

finally(null | () => void)

Dołącza wywołanie zwrotne wywoływane po rozliczeniu obietnicy (spełnione lub odrzucone). Nie można zmodyfikować rozpoznanej wartości z wywołania zwrotnego.

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

Parametry

onfinally

null | () => void

Wywołanie zwrotne do wykonania po rozliczeniu obietnicy (spełnione lub odrzucone).

Zwraca

Promise<TResult>

Obietnica ukończenia wywołania zwrotnego.

dziedziczone z Promise.finally

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

Dołącza wywołania zwrotne do rozwiązania i/lub odrzucenia obietnicy.

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>

Wywołanie zwrotne do wykonania po rozwiązaniu obietnicy.

onrejected

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

Wywołanie zwrotne do wykonania po odrzuceniu obietnicy.

Zwraca

Promise<TResult1 | TResult2>

Obietnica ukończenia, z którego kiedykolwiek jest wykonywane wywołanie zwrotne.

dziedziczone z obietnicy.then