PollerLike interface

Paquete:

@azure/keyvault-admin

Un sondeo sencillo que se puede usar para sondear una operación de larga duración.

Métodos

getOperationState()	Devuelve el estado de la operación.
getResult()	Devuelve el valor de resultado de la operación, independientemente del estado del sondeo. Puede devolver una forma no definida o incompleta del valor TResult final en función de la implementación.
isDone()	Devuelve true si el sondeo ha terminado de sondear.
isStopped()	Devuelve true si se detiene el sondeo.
onProgress((state: TState) => void)	Invoca la devolución de llamada proporcionada después de completar cada sondeo y envía el estado actual de la operación del sondeo. Devuelve un método que se puede usar para dejar de recibir actualizaciones en la función de devolución de llamada dada.
poll({ abortSignal?: AbortSignalLike })	Devuelve una promesa que se resolverá una vez finalizada una única solicitud de sondeo. Para ello, llama al método de actualización de la operación de Poller.
pollUntilDone({ abortSignal?: AbortSignalLike })	Devuelve una promesa que se resolverá una vez completada la operación subyacente.
stopPolling()	Impide que el sondeo continúe sondeando. Tenga en cuenta que esto solo detendrá el sondeo del lado cliente.
toString()	Devuelve una representación de cadena de la operación del sondeo. Similar a serializar, pero devuelve una cadena.

Detalles del método

getOperationState()

Devuelve el estado de la operación.

function getOperationState(): TState

Devoluciones

TState

getResult()

Devuelve el valor de resultado de la operación, independientemente del estado del sondeo. Puede devolver una forma no definida o incompleta del valor TResult final en función de la implementación.

function getResult(): undefined | TResult

Devoluciones

undefined | TResult

isDone()

Devuelve true si el sondeo ha terminado de sondear.

function isDone(): boolean

Devoluciones

boolean

isStopped()

Devuelve true si se detiene el sondeo.

function isStopped(): boolean

Devoluciones

boolean

onProgress((state: TState) => void)

Invoca la devolución de llamada proporcionada después de completar cada sondeo y envía el estado actual de la operación del sondeo.

Devuelve un método que se puede usar para dejar de recibir actualizaciones en la función de devolución de llamada dada.

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

Parámetros

callback

(state: TState) => void

Devoluciones

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Devuelve una promesa que se resolverá una vez finalizada una única solicitud de sondeo. Para ello, llama al método de actualización de la operación de Poller.

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

Parámetros

options

{ abortSignal?: AbortSignalLike }

Devoluciones

Promise<void>

pollUntilDone({ abortSignal?: AbortSignalLike })

Devuelve una promesa que se resolverá una vez completada la operación subyacente.

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

Parámetros

pollOptions

{ abortSignal?: AbortSignalLike }

Devoluciones

Promise<TResult>

stopPolling()

Impide que el sondeo continúe sondeando. Tenga en cuenta que esto solo detendrá el sondeo del lado cliente.

function stopPolling()

toString()

Devuelve una representación de cadena de la operación del sondeo. Similar a serializar, pero devuelve una cadena.

function toString(): string

Devoluciones

string