PollerLike interface
Poller dla operacji.
- Rozszerzenie
-
Promise<TResult>
Właściwości
| is |
To prawda, jeśli poller zakończył sondowanie. |
| operation |
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
| [to |
Metody
| on |
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({ abort |
Zwraca obietnicę, która zostanie rozwiązana po zakończeniu pojedynczego żądania sondowania. Robi to, wywołując metodę aktualizacji operacji Pollera. |
| poll |
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>((reason: any) => TResult | Promise |
Dołącza wywołanie zwrotne tylko do odrzucenia obietnicy. |
| finally(() => void | null) | 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>((value: TResult) => TResult1 | Promise |
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: booleanWartość właściwości
boolean
operationState
Stan operacji. Może to być niezdefiniowane, jeśli poller nie został jeszcze przesłany.
operationState: TState | undefinedWartość właściwości
TState | undefined
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: TResult | undefinedWartość właściwości
TResult | undefined
Szczegóły właściwości dziedziczonej
[toStringTag]
[toStringTag]: stringWartość właściwości
string
Odziedziczone od Obietnicy. [toStringTag]
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): CancelOnProgressParametry
- callback
-
(state: TState) => void
Zwraca
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>((reason: any) => TResult | PromiseLike<TResult> | null)
Dołącza wywołanie zwrotne tylko do odrzucenia obietnicy.
function catch<TResult>(onrejected?: (reason: any) => TResult | PromiseLike<TResult> | null): Promise<TResult | TResult>Parametry
- onrejected
-
(reason: any) => TResult | PromiseLike<TResult> | null
Wywołanie zwrotne do wykonania po odrzuceniu obietnicy.
Zwraca
Promise<TResult | TResult>
Obietnica ukończenia wywołania zwrotnego.
dziedziczone z Promise.catch
finally(() => void | null)
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?: () => void | null): Promise<TResult>Parametry
- onfinally
-
() => void | null
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>((value: TResult) => TResult1 | PromiseLike<TResult1> | null, (reason: any) => TResult2 | PromiseLike<TResult2> | null)
Dołącza wywołania zwrotne do rozwiązania i/lub odrzucenia obietnicy.
function then<TResult1, TResult2>(onfulfilled?: (value: TResult) => TResult1 | PromiseLike<TResult1> | null, onrejected?: (reason: any) => TResult2 | PromiseLike<TResult2> | null): Promise<TResult1 | TResult2>Parametry
- onfulfilled
-
(value: TResult) => TResult1 | PromiseLike<TResult1> | null
Wywołanie zwrotne do wykonania po rozwiązaniu obietnicy.
- onrejected
-
(reason: any) => TResult2 | PromiseLike<TResult2> | null
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
