SimplePollerLike interface

Egy egyszerű beporzó, amely egy hosszú ideig futó művelet lekérdezésére használható.

Metódusok

getOperationState()

A művelet állapotát adja vissza.

getResult()

A művelet eredményértékét adja vissza a lekérdezés állapotától függetlenül. A végleges TResult érték nem definiált vagy hiányos formáját is visszaadhatja a megvalósítástól függően.

isDone()

Igaz értéket ad vissza, ha a lekérdezés befejeződött.

isStopped()

Igaz értéket ad vissza, ha a lekérdezés leáll.

onProgress((state: TState) => void)

Minden szavazás után behívja a megadott visszahívást, elküldve a poller aktuális működési állapotát.

Egy olyan módszert ad vissza, amellyel megállítható a megadott visszahívási függvény frissítések megszűnésére.

poll({ abortSignal?: AbortSignalLike })

Ígéretet ad, ami megoldódik, amint egyetlen szavazási kérelem befejeződik. Ezt úgy éri el, hogy meghívja a Poller műveletének update metódusát.

pollUntilDone({ abortSignal?: AbortSignalLike })

Ígéretet ad, amely megoldódik, amint az alapul szolgáló művelet befejeződik.

serialize()

Olyan ígéretet ad, amely a poller műveletének sorializált változatához használható a művelet serializáló módszerének behívásával.

stopPolling()

Megakadályozza, hogy a közvélemény-kutatás folytatja. Kérjük, vegye figyelembe, hogy ez csak az ügyféloldali szavazást állítja meg.

submitted()

Várja meg, hogy a szavazó benyújtásra kerüljön.

toString()

A poller műveletének string reprezentációját adja vissza. Hasonló a serializációhoz, de visszaad egy stringet.

Metódus adatai

getOperationState()

A művelet állapotát adja vissza.

function getOperationState(): TState

Válaszok

TState

getResult()

A művelet eredményértékét adja vissza a lekérdezés állapotától függetlenül. A végleges TResult érték nem definiált vagy hiányos formáját is visszaadhatja a megvalósítástól függően.

function getResult(): undefined | TResult

Válaszok

undefined | TResult

isDone()

Igaz értéket ad vissza, ha a lekérdezés befejeződött.

function isDone(): boolean

Válaszok

boolean

isStopped()

Figyelmeztetés

Ez az API már elavult.

Use abortSignal status to track this instead.

Igaz értéket ad vissza, ha a lekérdezés leáll.

function isStopped(): boolean

Válaszok

boolean

onProgress((state: TState) => void)

Minden szavazás után behívja a megadott visszahívást, elküldve a poller aktuális működési állapotát.

Egy olyan módszert ad vissza, amellyel megállítható a megadott visszahívási függvény frissítések megszűnésére.

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

Paraméterek

callback

(state: TState) => void

Válaszok

poll({ abortSignal?: AbortSignalLike })

Ígéretet ad, ami megoldódik, amint egyetlen szavazási kérelem befejeződik. Ezt úgy éri el, hogy meghívja a Poller műveletének update metódusát.

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

Paraméterek

options

{ abortSignal?: AbortSignalLike }

Válaszok

Promise<TState>

pollUntilDone({ abortSignal?: AbortSignalLike })

Ígéretet ad, amely megoldódik, amint az alapul szolgáló művelet befejeződik.

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

Paraméterek

pollOptions

{ abortSignal?: AbortSignalLike }

Válaszok

Promise<TResult>

serialize()

Olyan ígéretet ad, amely a poller műveletének sorializált változatához használható a művelet serializáló módszerének behívásával.

function serialize(): Promise<string>

Válaszok

Promise<string>

stopPolling()

Figyelmeztetés

Ez az API már elavult.

Use abortSignal to stop polling instead.

Megakadályozza, hogy a közvélemény-kutatás folytatja. Kérjük, vegye figyelembe, hogy ez csak az ügyféloldali szavazást állítja meg.

function stopPolling()

submitted()

Várja meg, hogy a szavazó benyújtásra kerüljön.

function submitted(): Promise<void>

Válaszok

Promise<void>

toString()

Figyelmeztetés

Ez az API már elavult.

Use serialize() instead.

A poller műveletének string reprezentációját adja vissza. Hasonló a serializációhoz, de visszaad egy stringet.

function toString(): string

Válaszok

string