PollerLike interface

Pakket:

@azure/core-lro

Een poller voor een bewerking.

Uitbreiding

Promise<TResult>

Eigenschappen

isDone	Is waar als de poller klaar is met pollen.
operationState	De status van de bewerking. Deze kan niet worden gedefinieerd als de poller nog niet is ingediend.
result	De resultaatwaarde van de bewerking, ongeacht de status van de poller. Het kan niet gedefinieerd of een onvolledige vorm van de uiteindelijke TResult-waarde zijn, afhankelijk van de implementatie.

Overgenomen eigenschappen

[toStringTag]

Methoden

onProgress((state: TState) => void)	Roept de opgegeven callback aan nadat elke polling is voltooid, waardoor de huidige status van de bewerking van de poller wordt verzonden. Het retourneert een methode die kan worden gebruikt om het ontvangen van updates voor de opgegeven callback-functie te stoppen.
poll({ abortSignal?: AbortSignalLike })	Retourneert een belofte die wordt omgezet zodra één polling-aanvraag is voltooid. Dit doet u door de updatemethode van de poller-bewerking aan te roepen.
pollUntilDone({ abortSignal?: AbortSignalLike })	Retourneert een belofte die wordt omgezet zodra de onderliggende bewerking is voltooid.
serialize()	Retourneert een belofte die kan worden gebruikt voor geserialiseerde versie van de bewerking van de poller door de serialisatiemethode van de bewerking aan te roepen.
submitted()	Retourneert een belofte die kan worden gebruikt om te controleren of de poller is verzonden.

Overgenomen methoden

catch<TResult>(null | (reason: any) => TResult | PromiseLike<TResult>)	Voegt een callback toe voor alleen de afwijzing van de promise.
finally(null | () => void)	Voegt een callback toe die wordt aangeroepen wanneer de promise wordt geregeld (voldaan of afgewezen). De opgeloste waarde kan niet worden gewijzigd vanuit de callback.
then<TResult1, TResult2>(null | (value: TResult) => TResult1 | PromiseLike<TResult1>, null | (reason: any) => TResult2 | PromiseLike<TResult2>)	Hiermee worden callbacks toegevoegd voor de resolutie en/of afwijzing van de promise.

Eigenschapdetails

isDone

Is waar als de poller klaar is met pollen.

isDone: boolean

Waarde van eigenschap

boolean

operationState

De status van de bewerking. Deze kan niet worden gedefinieerd als de poller nog niet is ingediend.

operationState: undefined | TState

Waarde van eigenschap

undefined | TState

result

De resultaatwaarde van de bewerking, ongeacht de status van de poller. Het kan niet gedefinieerd of een onvolledige vorm van de uiteindelijke TResult-waarde zijn, afhankelijk van de implementatie.

result: undefined | TResult

Waarde van eigenschap

undefined | TResult

Details van overgenomen eigenschap

[toStringTag]

[toStringTag]: string

Waarde van eigenschap

string

overgenomen van Promise.__@toStringTag@68

Methodedetails

onProgress((state: TState) => void)

Roept de opgegeven callback aan nadat elke polling is voltooid, waardoor de huidige status van de bewerking van de poller wordt verzonden.

Het retourneert een methode die kan worden gebruikt om het ontvangen van updates voor de opgegeven callback-functie te stoppen.

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

Parameters

callback

(state: TState) => void

Retouren

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Retourneert een belofte die wordt omgezet zodra één polling-aanvraag is voltooid. Dit doet u door de updatemethode van de poller-bewerking aan te roepen.

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

Parameters

options

{ abortSignal?: AbortSignalLike }

Retouren

Promise<TState>

pollUntilDone({ abortSignal?: AbortSignalLike })

Retourneert een belofte die wordt omgezet zodra de onderliggende bewerking is voltooid.

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

Parameters

pollOptions

{ abortSignal?: AbortSignalLike }

Retouren

Promise<TResult>

serialize()

Retourneert een belofte die kan worden gebruikt voor geserialiseerde versie van de bewerking van de poller door de serialisatiemethode van de bewerking aan te roepen.

function serialize(): Promise<string>

Retouren

Promise<string>

submitted()

Retourneert een belofte die kan worden gebruikt om te controleren of de poller is verzonden.

function submitted(): Promise<void>

Retouren

Promise<void>

Details overgenomen methode

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

Voegt een callback toe voor alleen de afwijzing van de promise.

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

Parameters

onrejected

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

De callback die moet worden uitgevoerd wanneer de promise wordt geweigerd.

Retouren

Promise<TResult | TResult>

Een promise voor de voltooiing van de callback.

overgenomen van Promise.catch

finally(null | () => void)

Voegt een callback toe die wordt aangeroepen wanneer de promise wordt geregeld (voldaan of afgewezen). De opgeloste waarde kan niet worden gewijzigd vanuit de callback.

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

Parameters

onfinally

null | () => void

De callback die moet worden uitgevoerd wanneer de promise wordt afgehandeld (voldaan of afgewezen).

Retouren

Promise<TResult>

Een promise voor de voltooiing van de callback.

overgenomen van Promise.tot slot

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

Hiermee worden callbacks toegevoegd voor de resolutie en/of afwijzing van de promise.

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

Parameters

onfulfilled

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

De callback die moet worden uitgevoerd wanneer de promise is opgelost.

onrejected

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

De callback die moet worden uitgevoerd wanneer de promise wordt geweigerd.

Retouren

Promise<TResult1 | TResult2>

Een promise voor de voltooiing waarvan ooit callback wordt uitgevoerd.

overgenomen van Promise.then