Share via

PollerLike interface

  • Referens
Paket:
@azure/keyvault-secrets

Abstrakt representation av en poller, avsedd att exponera bara det minimala API som användaren behöver arbeta med.

Metoder

cancelOperation({ abortSignal?: AbortSignalLike })

Försöker avbryta den underliggande åtgärden.
getOperationState()

Returnerar åtgärdens tillstånd. TState som definieras i PollerLike kan vara en delmängd av den TState som definieras i Poller-implementeringen.
getResult()

Returnerar resultatvärdet för åtgärden, oavsett pollerns tillstånd. Den kan returnera odefinierad eller ofullständig form av det slutliga TResult-värdet beroende på implementeringen.
isDone()

Returnerar sant om polleraren har slutfört avsökningen.
isStopped()

Returnerar sant om polleraren stoppas.
onProgress((state: TState) => void)

Anropar det angivna återanropet efter att varje avsökning har slutförts och skickar det aktuella tillståndet för pollerns åtgärd.

Den returnerar en metod som kan användas för att sluta ta emot uppdateringar för den angivna återanropsfunktionen.
poll({ abortSignal?: AbortSignalLike })

Returnerar ett löfte som kommer att lösas när en enskild avsökningsbegäran har slutförts. Det gör den genom att anropa uppdateringsmetoden för Poller-åtgärden.
pollUntilDone({ abortSignal?: AbortSignalLike })

Returnerar ett löfte som löses när den underliggande åtgärden har slutförts.
stopPolling()

Stoppar polleraren. Därefter kan inga manuella eller automatiserade begäranden skickas.
toString()

Returnerar en serialiserad version av pollerns åtgärd genom att anropa åtgärdens toString-metod.

Metodinformation

cancelOperation({ abortSignal?: AbortSignalLike })

Varning

Det här API:et är nu inaktuellt.

cancelOperation has been deprecated because it was not implemented.

Försöker avbryta den underliggande åtgärden.

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

Parametrar

options

{ abortSignal?: AbortSignalLike }

Returer

Promise<void>

getOperationState()

Returnerar åtgärdens tillstånd. TState som definieras i PollerLike kan vara en delmängd av den TState som definieras i Poller-implementeringen.

function getOperationState(): TState

Returer

TState

getResult()

Returnerar resultatvärdet för åtgärden, oavsett pollerns tillstånd. Den kan returnera odefinierad eller ofullständig form av det slutliga TResult-värdet beroende på implementeringen.

function getResult(): undefined | TResult

Returer

undefined | TResult

isDone()

Returnerar sant om polleraren har slutfört avsökningen.

function isDone(): boolean

Returer

boolean

isStopped()

Returnerar sant om polleraren stoppas.

function isStopped(): boolean

Returer

boolean

onProgress((state: TState) => void)

Anropar det angivna återanropet efter att varje avsökning har slutförts och skickar det aktuella tillståndet för pollerns åtgärd.

Den returnerar en metod som kan användas för att sluta ta emot uppdateringar för den angivna återanropsfunktionen.

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

Parametrar

callback

(state: TState) => void

Returer

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Returnerar ett löfte som kommer att lösas när en enskild avsökningsbegäran har slutförts. Det gör den genom att anropa uppdateringsmetoden för Poller-åtgärden.

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

Parametrar

options

{ abortSignal?: AbortSignalLike }

Returer

Promise<void>

pollUntilDone({ abortSignal?: AbortSignalLike })

Returnerar ett löfte som löses när den underliggande åtgärden har slutförts.

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

Parametrar

pollOptions

{ abortSignal?: AbortSignalLike }

Returer

Promise<TResult>

stopPolling()

Stoppar polleraren. Därefter kan inga manuella eller automatiserade begäranden skickas.

function stopPolling()

toString()

Returnerar en serialiserad version av pollerns åtgärd genom att anropa åtgärdens toString-metod.

function toString(): string

Returer

string