PollerLike interface
Abstrakte Darstellung eines Pollers, der nur die minimale API verfügbar machen soll, mit der der Benutzer arbeiten muss.
Methoden
cancel |
Versucht, den zugrunde liegenden Vorgang abzubrechen. |
get |
Gibt den Status des Vorgangs zurück. Der in PollerLike definierte TState kann eine Teilmenge des in der Poller-Implementierung definierten TState sein. |
get |
Gibt den Ergebniswert des Vorgangs zurück, unabhängig vom Zustand des Pollers. Je nach Implementierung kann der endgültige TResult-Wert nicht definiert oder unvollständig zurückgegeben werden. |
is |
Gibt true zurück, wenn der Poller die Abfrage abgeschlossen hat. |
is |
Gibt true zurück, wenn der Poller beendet wurde. |
on |
Ruft den bereitgestellten Rückruf auf, nachdem jede Abfrage abgeschlossen ist, und sendet den aktuellen Zustand des Abfragevorgangs. Es gibt eine Methode zurück, die verwendet werden kann, um den Empfang von Updates für die angegebene Rückruffunktion zu beenden. |
poll({ abort |
Gibt eine Zusage zurück, die aufgelöst wird, sobald eine einzelne Abfrageanforderung abgeschlossen ist. Dazu wird die Updatemethode des Pollers-Vorgangs aufgerufen. |
poll |
Gibt eine Zusage zurück, die nach Abschluss des zugrunde liegenden Vorgangs aufgelöst wird. |
stop |
Beendet den Poller. Danach können keine manuellen oder automatisierten Anforderungen mehr gesendet werden. |
to |
Gibt eine serialisierte Version des Abrufvorgangs zurück, indem die toString-Methode des Vorgangs aufgerufen wird. |
Details zur Methode
cancelOperation({ abortSignal?: AbortSignalLike })
Warnung
Diese API ist nun veraltet.
cancelOperation
has been deprecated because it was not implemented.
Versucht, den zugrunde liegenden Vorgang abzubrechen.
function cancelOperation(options?: { abortSignal?: AbortSignalLike }): Promise<void>
Parameter
- options
-
{ abortSignal?: AbortSignalLike }
Gibt zurück
Promise<void>
getOperationState()
Gibt den Status des Vorgangs zurück. Der in PollerLike definierte TState kann eine Teilmenge des in der Poller-Implementierung definierten TState sein.
function getOperationState(): TState
Gibt zurück
TState
getResult()
Gibt den Ergebniswert des Vorgangs zurück, unabhängig vom Zustand des Pollers. Je nach Implementierung kann der endgültige TResult-Wert nicht definiert oder unvollständig zurückgegeben werden.
function getResult(): undefined | TResult
Gibt zurück
undefined | TResult
isDone()
Gibt true zurück, wenn der Poller die Abfrage abgeschlossen hat.
function isDone(): boolean
Gibt zurück
boolean
isStopped()
Gibt true zurück, wenn der Poller beendet wurde.
function isStopped(): boolean
Gibt zurück
boolean
onProgress((state: TState) => void)
Ruft den bereitgestellten Rückruf auf, nachdem jede Abfrage abgeschlossen ist, und sendet den aktuellen Zustand des Abfragevorgangs.
Es gibt eine Methode zurück, die verwendet werden kann, um den Empfang von Updates für die angegebene Rückruffunktion zu beenden.
function onProgress(callback: (state: TState) => void): CancelOnProgress
Parameter
- callback
-
(state: TState) => void
Gibt zurück
poll({ abortSignal?: AbortSignalLike })
Gibt eine Zusage zurück, die aufgelöst wird, sobald eine einzelne Abfrageanforderung abgeschlossen ist. Dazu wird die Updatemethode des Pollers-Vorgangs aufgerufen.
function poll(options?: { abortSignal?: AbortSignalLike }): Promise<void>
Parameter
- options
-
{ abortSignal?: AbortSignalLike }
Gibt zurück
Promise<void>
pollUntilDone({ abortSignal?: AbortSignalLike })
Gibt eine Zusage zurück, die nach Abschluss des zugrunde liegenden Vorgangs aufgelöst wird.
function pollUntilDone(pollOptions?: { abortSignal?: AbortSignalLike }): Promise<TResult>
Parameter
- pollOptions
-
{ abortSignal?: AbortSignalLike }
Gibt zurück
Promise<TResult>
stopPolling()
Beendet den Poller. Danach können keine manuellen oder automatisierten Anforderungen mehr gesendet werden.
function stopPolling()
toString()
Gibt eine serialisierte Version des Abrufvorgangs zurück, indem die toString-Methode des Vorgangs aufgerufen wird.
function toString(): string
Gibt zurück
string