PollerLike interface

Intenta cancelar la operación subyacente.

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

Parámetros

Devoluciones

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

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

function getResult(): undefined | TResult

Devoluciones

Devuelve true si el sondeo ha terminado de sondear.

function isDone(): boolean

Devoluciones

Devuelve true si se detiene el sondeo.

function isStopped(): boolean

Devoluciones

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 determinada.

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

Parámetros

Devoluciones

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

Devoluciones

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

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

Parámetros

Devoluciones

Detiene el sondeo. Después de esto, no se puede enviar ninguna solicitud manual o automatizada.

function stopPolling()

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

function toString(): string

Devoluciones