PollerLike interface
Jednoduchý poller, který lze použít k dotazování dlouhotrvající operace.
Metody
| get |
Vrátí stav operace. |
| get |
Vrátí výslednou hodnotu operace bez ohledu na stav vrtule. V závislosti na implementaci může vrátit nedefinovanou nebo neúplnou formu konečné hodnoty TResult. |
| is |
Vrátí hodnotu true, pokud poller dokončil dotazování. |
| is |
Vrátí hodnotu true, pokud je poller zastaven. |
| on |
Vyvolá poskytnuté zpětné volání po dokončení každého dotazování a odešle aktuální stav operace poller. Vrátí metodu, která se dá použít k zastavení příjmu aktualizací dané funkce zpětného volání. |
| poll({ abort |
Vrátí příslib, který se vyřeší po dokončení jednoho požadavku na dotazování. Provede to voláním metody aktualizace operace Poller. |
| poll |
Vrátí příslib, který se vyřeší po dokončení základní operace. |
| stop |
Zastaví poller pokračovat v hlasování. Upozorňujeme, že toto nastavení zastaví pouze dotazování na straně klienta. |
| to |
Vrátí řetězcovou reprezentaci operace vrtule. Podobá se serializaci, ale vrací řetězec. |
Podrobnosti metody
getOperationState()
Vrátí stav operace.
function getOperationState(): TState
Návraty
TState
getResult()
Vrátí výslednou hodnotu operace bez ohledu na stav vrtule. V závislosti na implementaci může vrátit nedefinovanou nebo neúplnou formu konečné hodnoty TResult.
function getResult(): undefined | TResult
Návraty
undefined | TResult
isDone()
Vrátí hodnotu true, pokud poller dokončil dotazování.
function isDone(): boolean
Návraty
boolean
isStopped()
Vrátí hodnotu true, pokud je poller zastaven.
function isStopped(): boolean
Návraty
boolean
onProgress((state: TState) => void)
Vyvolá poskytnuté zpětné volání po dokončení každého dotazování a odešle aktuální stav operace poller.
Vrátí metodu, která se dá použít k zastavení příjmu aktualizací dané funkce zpětného volání.
function onProgress(callback: (state: TState) => void): CancelOnProgress
Parametry
- callback
-
(state: TState) => void
Návraty
poll({ abortSignal?: AbortSignalLike })
Vrátí příslib, který se vyřeší po dokončení jednoho požadavku na dotazování. Provede to voláním metody aktualizace operace Poller.
function poll(options?: { abortSignal?: AbortSignalLike }): Promise<void>
Parametry
- options
-
{ abortSignal?: AbortSignalLike }
Návraty
Promise<void>
pollUntilDone({ abortSignal?: AbortSignalLike })
Vrátí příslib, který se vyřeší po dokončení základní operace.
function pollUntilDone(pollOptions?: { abortSignal?: AbortSignalLike }): Promise<TResult>
Parametry
- pollOptions
-
{ abortSignal?: AbortSignalLike }
Návraty
Promise<TResult>
stopPolling()
Zastaví poller pokračovat v hlasování. Upozorňujeme, že toto nastavení zastaví pouze dotazování na straně klienta.
function stopPolling()
toString()
Vrátí řetězcovou reprezentaci operace vrtule. Podobá se serializaci, ale vrací řetězec.
function toString(): string
Návraty
string