PollerLike interface

Pakket:

@azure/keyvault-secrets

Abstracte weergave van een poller, bedoeld om alleen de minimale API beschikbaar te maken waarmee de gebruiker moet werken.

Methoden

cancelOperation({ abortSignal?: AbortSignalLike })	Probeert de onderliggende bewerking te annuleren.
getOperationState()	Retourneert de status van de bewerking. De TState die is gedefinieerd in PollerLike kan een subset zijn van de TState die is gedefinieerd in de Poller-implementatie.
getResult()	Retourneert de resultaatwaarde van de bewerking, ongeacht de status van de poller. Het kan een niet-gedefinieerde of onvolledige vorm van de uiteindelijke TResult-waarde retourneren, afhankelijk van de implementatie.
isDone()	Retourneert true als de poller de polling heeft voltooid.
isStopped()	Retourneert true als de poller is gestopt.
onProgress((state: TState) => void)	Roept de opgegeven callback aan nadat elke polling is voltooid, waarbij 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 opgelost zodra een enkele 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 opgelost zodra de onderliggende bewerking is voltooid.
stopPolling()	Stopt de poller. Daarna kunnen er geen handmatige of geautomatiseerde aanvragen meer worden verzonden.
toString()	Retourneert een geserialiseerde versie van de bewerking van de poller door de toString-methode van de bewerking aan te roepen.

Methodedetails

cancelOperation({ abortSignal?: AbortSignalLike })

Waarschuwing

Deze API is nu afgeschaft.

cancelOperation has been deprecated because it was not implemented.

Probeert de onderliggende bewerking te annuleren.

function cancelOperation(options?: { abortSignal?: AbortSignalLike }): Promise<void>

Parameters

options

{ abortSignal?: AbortSignalLike }

Retouren

Promise<void>

getOperationState()

Retourneert de status van de bewerking. De TState die is gedefinieerd in PollerLike kan een subset zijn van de TState die is gedefinieerd in de Poller-implementatie.

function getOperationState(): TState

Retouren

TState

getResult()

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

function getResult(): undefined | TResult

Retouren

undefined | TResult

isDone()

Retourneert true als de poller de polling heeft voltooid.

function isDone(): boolean

Retouren

boolean

isStopped()

Retourneert true als de poller is gestopt.

function isStopped(): boolean

Retouren

boolean

onProgress((state: TState) => void)

Roept de opgegeven callback aan nadat elke polling is voltooid, waarbij 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 opgelost zodra een enkele polling-aanvraag is voltooid. Dit doet u door de updatemethode van de poller-bewerking aan te roepen.

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

Parameters

options

{ abortSignal?: AbortSignalLike }

Retouren

Promise<void>

pollUntilDone({ abortSignal?: AbortSignalLike })

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

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

Parameters

pollOptions

{ abortSignal?: AbortSignalLike }

Retouren

Promise<TResult>

stopPolling()

Stopt de poller. Daarna kunnen er geen handmatige of geautomatiseerde aanvragen meer worden verzonden.

function stopPolling()

toString()

Retourneert een geserialiseerde versie van de bewerking van de poller door de toString-methode van de bewerking aan te roepen.

function toString(): string

Retouren

string