PollerLike interface
Ein Poller für einen Vorgang.
- Extends
-
Promise<TResult>
Eigenschaften
| is |
Ist "true", wenn der Abrufer die Abfrage abgeschlossen hat. |
| operation |
Der Status des Vorgangs. Sie kann nicht definiert werden, wenn der Poller noch nicht übermittelt wurde. |
| result | Der Ergebniswert des Vorgangs, unabhängig vom Status des Pollers. Je nach Implementierung kann er nicht definiert oder unvollständig sein. |
Geerbte Eigenschaften
| [to |
Methoden
| on |
Ruft den bereitgestellten Rückruf auf, nachdem jede Abfrage abgeschlossen wurde, und sendet den aktuellen Status des Abrufvorgangs. 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 rufen Sie die Updatemethode des Poller-Vorgangs auf. |
| poll |
Gibt eine Zusage zurück, die nach Abschluss des zugrunde liegenden Vorgangs aufgelöst wird. |
| serialize() | Gibt eine Zusage zurück, die für serialisierte Version des Pollers-Vorgangs verwendet werden kann, indem die Serialisierungsmethode des Vorgangs abgerufen wird. |
| submitted() | Gibt eine Zusage zurück, mit der überprüft werden kann, ob der Poller übermittelt wurde. |
Geerbte Methoden
| catch<TResult>((reason: any) => TResult | Promise |
Fügt einen Rückruf nur für die Ablehnung der Zusage an. |
| finally(() => void | null) | Fügt einen Rückruf an, der aufgerufen wird, wenn die Zusage abgerechnet wird (erfüllt oder abgelehnt). Der aufgelöste Wert kann nicht aus dem Rückruf geändert werden. |
| then<TResult1, TResult2>((value: TResult) => TResult1 | Promise |
Fügt Rückrufe für die Auflösung und/oder Ablehnung der Zusage an. |
Details zur Eigenschaft
isDone
Ist "true", wenn der Abrufer die Abfrage abgeschlossen hat.
isDone: booleanEigenschaftswert
boolean
operationState
Der Status des Vorgangs. Sie kann nicht definiert werden, wenn der Poller noch nicht übermittelt wurde.
operationState: TState | undefinedEigenschaftswert
TState | undefined
result
Der Ergebniswert des Vorgangs, unabhängig vom Status des Pollers. Je nach Implementierung kann er nicht definiert oder unvollständig sein.
result: TResult | undefinedEigenschaftswert
TResult | undefined
Geerbte Eigenschaftsdetails
[toStringTag]
[toStringTag]: stringEigenschaftswert
string
Geerbt von Versprochen. [toStringTag]
Details zur Methode
onProgress((state: TState) => void)
Ruft den bereitgestellten Rückruf auf, nachdem jede Abfrage abgeschlossen wurde, und sendet den aktuellen Status des Abrufvorgangs.
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): CancelOnProgressParameter
- 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 rufen Sie die Updatemethode des Poller-Vorgangs auf.
function poll(options?: { abortSignal?: AbortSignalLike }): Promise<TState>Parameter
- options
-
{ abortSignal?: AbortSignalLike }
Gibt zurück
Promise<TState>
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>
serialize()
Gibt eine Zusage zurück, die für serialisierte Version des Pollers-Vorgangs verwendet werden kann, indem die Serialisierungsmethode des Vorgangs abgerufen wird.
function serialize(): Promise<string>Gibt zurück
Promise<string>
submitted()
Gibt eine Zusage zurück, mit der überprüft werden kann, ob der Poller übermittelt wurde.
function submitted(): Promise<void>Gibt zurück
Promise<void>
Details zur geerbten Methode
catch<TResult>((reason: any) => TResult | PromiseLike<TResult> | null)
Fügt einen Rückruf nur für die Ablehnung der Zusage an.
function catch<TResult>(onrejected?: (reason: any) => TResult | PromiseLike<TResult> | null): Promise<TResult | TResult>Parameter
- onrejected
-
(reason: any) => TResult | PromiseLike<TResult> | null
Der Rückruf, der ausgeführt werden soll, wenn die Zusage abgelehnt wird.
Gibt zurück
Promise<TResult | TResult>
Eine Zusage für den Abschluss des Rückrufs.
Geerbt von Promise.catch
finally(() => void | null)
Fügt einen Rückruf an, der aufgerufen wird, wenn die Zusage abgerechnet wird (erfüllt oder abgelehnt). Der aufgelöste Wert kann nicht aus dem Rückruf geändert werden.
function finally(onfinally?: () => void | null): Promise<TResult>Parameter
- onfinally
-
() => void | null
Der Rückruf, der ausgeführt werden soll, wenn die Zusage abgerechnet wird (erfüllt oder abgelehnt).
Gibt zurück
Promise<TResult>
Eine Zusage für den Abschluss des Rückrufs.
geerbt von Promise.finally
then<TResult1, TResult2>((value: TResult) => TResult1 | PromiseLike<TResult1> | null, (reason: any) => TResult2 | PromiseLike<TResult2> | null)
Fügt Rückrufe für die Auflösung und/oder Ablehnung der Zusage an.
function then<TResult1, TResult2>(onfulfilled?: (value: TResult) => TResult1 | PromiseLike<TResult1> | null, onrejected?: (reason: any) => TResult2 | PromiseLike<TResult2> | null): Promise<TResult1 | TResult2>Parameter
- onfulfilled
-
(value: TResult) => TResult1 | PromiseLike<TResult1> | null
Der Rückruf, der ausgeführt werden soll, wenn die Zusage aufgelöst wird.
- onrejected
-
(reason: any) => TResult2 | PromiseLike<TResult2> | null
Der Rückruf, der ausgeführt werden soll, wenn die Zusage abgelehnt wird.
Gibt zurück
Promise<TResult1 | TResult2>
Eine Zusage für den Abschluss, von dem immer ein Rückruf ausgeführt wird.
von Promise geerbt.then