PollerLike interface

Paket:

@azure/core-lro

Ein Poller für einen Vorgang.

Extends

Promise<TResult>

Eigenschaften

isDone	Ist true, wenn der Poller die Abfrage abgeschlossen hat.
operationState	Der Zustand des Vorgangs. Sie kann nicht definiert werden, wenn der Poller noch nicht übermittelt wurde.
result	Der Ergebniswert des Vorgangs, unabhängig vom Zustand des Pollers. Je nach Implementierung kann es sich um eine nicht definierte oder unvollständige Form des endgültigen TResult-Werts sein.

Geerbte Eigenschaften

[toStringTag]

Methoden

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.
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.
pollUntilDone({ abortSignal?: AbortSignalLike })	Gibt eine Zusage zurück, die nach Abschluss des zugrunde liegenden Vorgangs aufgelöst wird.
serialize()	Gibt eine Zusage zurück, die für die serialisierte Version des Abfragevorgangs verwendet werden könnte, indem die Serialisierungsmethode des Vorgangs aufgerufen wird.
submitted()	Gibt eine Zusage zurück, mit der überprüft werden kann, ob der Poller übermittelt wurde.

Geerbte Methoden

catch<TResult>(null | (reason: any) => TResult | PromiseLike<TResult>)	Fügt einen Rückruf nur für die Ablehnung der Zusage an.
finally(null | () => void)	Fügt einen Rückruf an, der aufgerufen wird, wenn die Zusage abgeschlossen (erfüllt oder abgelehnt) wird. Der aufgelöste Wert kann nicht über den Rückruf geändert werden.
then<TResult1, TResult2>(null | (value: TResult) => TResult1 | PromiseLike<TResult1>, null | (reason: any) => TResult2 | PromiseLike<TResult2>)	Fügt Rückrufe für die Lösung und/oder Ablehnung der Zusage an.

Details zur Eigenschaft

isDone

Ist true, wenn der Poller die Abfrage abgeschlossen hat.

isDone: boolean

Eigenschaftswert

boolean

operationState

Der Zustand des Vorgangs. Sie kann nicht definiert werden, wenn der Poller noch nicht übermittelt wurde.

operationState: undefined | TState

Eigenschaftswert

undefined | TState

result

Der Ergebniswert des Vorgangs, unabhängig vom Zustand des Pollers. Je nach Implementierung kann es sich um eine nicht definierte oder unvollständige Form des endgültigen TResult-Werts sein.

result: undefined | TResult

Eigenschaftswert

undefined | TResult

Geerbte Eigenschaftsdetails

[toStringTag]

[toStringTag]: string

Eigenschaftswert

string

Geerbt von Promise.__@toStringTag@68

Details zur Methode

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

CancelOnProgress

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<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 die serialisierte Version des Abfragevorgangs verwendet werden könnte, indem die Serialisierungsmethode des Vorgangs aufgerufen 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>(null | (reason: any) => TResult | PromiseLike<TResult>)

Fügt einen Rückruf nur für die Ablehnung der Zusage an.

function catch<TResult>(onrejected?: null | (reason: any) => TResult | PromiseLike<TResult>): Promise<TResult | TResult>

Parameter

onrejected

null | (reason: any) => TResult | PromiseLike<TResult>

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(null | () => void)

Fügt einen Rückruf an, der aufgerufen wird, wenn die Zusage abgeschlossen (erfüllt oder abgelehnt) wird. Der aufgelöste Wert kann nicht über den Rückruf geändert werden.

function finally(onfinally?: null | () => void): Promise<TResult>

Parameter

onfinally

null | () => void

Der Rückruf, der ausgeführt werden soll, wenn die Zusage abgerechnet (erfüllt oder abgelehnt) wird.

Gibt zurück

Promise<TResult>

Eine Zusage für den Abschluss des Rückrufs.

Geerbt von Promise.finally

then<TResult1, TResult2>(null | (value: TResult) => TResult1 | PromiseLike<TResult1>, null | (reason: any) => TResult2 | PromiseLike<TResult2>)

Fügt Rückrufe für die Lösung und/oder Ablehnung der Zusage an.

function then<TResult1, TResult2>(onfulfilled?: null | (value: TResult) => TResult1 | PromiseLike<TResult1>, onrejected?: null | (reason: any) => TResult2 | PromiseLike<TResult2>): Promise<TResult1 | TResult2>

Parameter

onfulfilled

null | (value: TResult) => TResult1 | PromiseLike<TResult1>

Der Rückruf, der ausgeführt werden soll, wenn die Zusage aufgelöst wird.

onrejected

null | (reason: any) => TResult2 | PromiseLike<TResult2>

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, dessen Rückruf ausgeführt wird.

Geerbt von Promise.then