SimplePollerLike interface

Pakket:

@azure/arm-nginx

Een eenvoudige poller die kan worden gebruikt om een langdurige bewerking te peilen.

Methoden

getOperationState()	Retourneert de status van de bewerking.
getResult()	Retourneert de resultaatwaarde van de bewerking, ongeacht de status van de poller. Het kan niet-gedefinieerde of onvolledige vorm van de uiteindelijke TResult-waarde retourneren, afhankelijk van de implementatie.
isDone()	Retourneert waar als de poller de poller heeft voltooid.
isStopped()	Retourneert waar als de poller is gestopt.
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()	Geeft een belofte terug die gebruikt kan worden voor een geserialiseerde versie van de poller-operatie door de serialisatiemethode van de operatie aan te roepen.
stopPolling()	Voorkomt dat de peiler blijft peilen. Let op: dit stopt alleen de polling aan clientzijde
submitted()	Wacht tot de poller wordt ingediend.
toString()	Geeft een stringrepresentatie van de operatie van de poller terug. Vergelijkbaar met serializen, maar dan met een string terug.

Methodedetails

getOperationState()

Retourneert de status van de bewerking.

function getOperationState(): TState

Retouren

TState

getResult()

Retourneert de resultaatwaarde van de bewerking, ongeacht de status van de poller. Het kan niet-gedefinieerde of onvolledige vorm van de uiteindelijke TResult-waarde retourneren, afhankelijk van de implementatie.

function getResult(): undefined | TResult

Retouren

undefined | TResult

isDone()

Retourneert waar als de poller de poller heeft voltooid.

function isDone(): boolean

Retouren

boolean

isStopped()

Waarschuwing

Deze API is nu afgeschaft.

Use abortSignal status to track this instead.

Retourneert waar als de poller is gestopt.

function isStopped(): boolean

Retouren

boolean

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()

Geeft een belofte terug die gebruikt kan worden voor een geserialiseerde versie van de poller-operatie door de serialisatiemethode van de operatie aan te roepen.

function serialize(): Promise<string>

Retouren

Promise<string>

stopPolling()

Waarschuwing

Deze API is nu afgeschaft.

Use abortSignal to stop polling instead.

Voorkomt dat de peiler blijft peilen. Let op: dit stopt alleen de polling aan clientzijde

function stopPolling()

submitted()

Wacht tot de poller wordt ingediend.

function submitted(): Promise<void>

Retouren

Promise<void>

toString()

Waarschuwing

Deze API is nu afgeschaft.

Use serialize() instead.

Geeft een stringrepresentatie van de operatie van de poller terug. Vergelijkbaar met serializen, maar dan met een string terug.

function toString(): string

Retouren

string