PollerLike interface

Paquete:

@azure/keyvault-certificates

Representación abstracta de un sondeo, diseñada para exponer solo la API mínima con la que el usuario necesita trabajar.

Métodos

cancelOperation({ abortSignal?: AbortSignalLike })	Intenta cancelar la operación subyacente.
getOperationState()	Devuelve el estado de la operación. El TState definido en PollerLike puede ser un subconjunto del TState definido en la implementación de Poller.
getResult()	Devuelve el valor de resultado de la operación, independientemente del estado del sondeo. Puede devolver undefined o una forma incompleta del valor final de TResult 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 especificada.
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()	Detiene el sondeo. Después de esto, no se pueden enviar solicitudes manuales o automatizadas.
toString()	Devuelve una versión serializada de la operación del sondeo invocando el método toString de la operación.

Detalles del método

cancelOperation({ abortSignal?: AbortSignalLike })

Advertencia

Esta API ya está en desuso.

cancelOperation has been deprecated because it was not implemented.

Intenta cancelar la operación subyacente.

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

Parámetros

options

{ abortSignal?: AbortSignalLike }

Devoluciones

Promise<void>

getOperationState()

Devuelve el estado de la operación. El TState definido en PollerLike puede ser un subconjunto del TState definido en la implementación de Poller.

function getOperationState(): TState

Devoluciones

TState

getResult()

Devuelve el valor de resultado de la operación, independientemente del estado del sondeo. Puede devolver undefined o una forma incompleta del valor final de TResult 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 especificada.

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

Detiene el sondeo. Después de esto, no se pueden enviar solicitudes manuales o automatizadas.

function stopPolling()

toString()

Devuelve una versión serializada de la operación del sondeo invocando el método toString de la operación.

function toString(): string

Devoluciones

string