PollerLike interface
Un sondeo para una operación.
- Extends
-
Promise<TResult>
is |
Es true si el sondeo ha terminado de sondear. |
operation |
Estado de la operación. Puede ser indefinido si el sondeo aún no se ha enviado. |
result | Valor de resultado de la operación, independientemente del estado del sondeo. Puede ser indefinido o una forma incompleta del valor final de TResult en función de la implementación. |
on |
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({ abort |
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. |
poll |
Devuelve una promesa que se resolverá una vez completada la operación subyacente. |
serialize() | Devuelve una promesa que se podría usar para la versión serializada de la operación del sondeo invocando el método serialize de la operación. |
submitted() | Devuelve una promesa que podría usarse para comprobar si se ha enviado el sondeo. |
catch<TResult>(null | (reason: any) => TResult | Promise |
Adjunta una devolución de llamada solo para el rechazo de la promesa. |
finally(null | () => void) | Adjunta una devolución de llamada que se invoca cuando se resuelve la promesa (completada o rechazada). El valor resuelto no se puede modificar desde la devolución de llamada. |
then<TResult1, TResult2>(null | (value: TResult) => TResult1 | Promise |
Adjunta devoluciones de llamada para la resolución o rechazo de la promesa. |
Es true si el sondeo ha terminado de sondear.
isDone: boolean
Valor de propiedad
boolean
Estado de la operación. Puede ser indefinido si el sondeo aún no se ha enviado.
operationState: undefined | TState
Valor de propiedad
undefined | TState
Valor de resultado de la operación, independientemente del estado del sondeo. Puede ser indefinido o una forma incompleta del valor final de TResult en función de la implementación.
result: undefined | TResult
Valor de propiedad
undefined | TResult
[toStringTag]: string
Valor de propiedad
string
heredado de Promise.__@toStringTag@68
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
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<TState>
Parámetros
- options
-
{ abortSignal?: AbortSignalLike }
Devoluciones
Promise<TState>
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>
Devuelve una promesa que se podría usar para la versión serializada de la operación del sondeo invocando el método serialize de la operación.
function serialize(): Promise<string>
Devoluciones
Promise<string>
Devuelve una promesa que podría usarse para comprobar si se ha enviado el sondeo.
function submitted(): Promise<void>
Devoluciones
Promise<void>
Adjunta una devolución de llamada solo para el rechazo de la promesa.
function catch<TResult>(onrejected?: null | (reason: any) => TResult | PromiseLike<TResult>): Promise<TResult | TResult>
Parámetros
- onrejected
-
null | (reason: any) => TResult | PromiseLike<TResult>
Devolución de llamada que se va a ejecutar cuando se rechaza la promesa.
Devoluciones
Promise<TResult | TResult>
Promesa para la finalización de la devolución de llamada.
Heredado de Promise.catch
Adjunta una devolución de llamada que se invoca cuando se resuelve la promesa (completada o rechazada). El valor resuelto no se puede modificar desde la devolución de llamada.
function finally(onfinally?: null | () => void): Promise<TResult>
Parámetros
- onfinally
-
null | () => void
Devolución de llamada que se ejecutará cuando se resuelva la promesa (completada o rechazada).
Devoluciones
Promise<TResult>
Promesa para la finalización de la devolución de llamada.
Heredado de Promise.finally
then<TResult1, TResult2>(null | (value: TResult) => TResult1 | PromiseLike<TResult1>, null | (reason: any) => TResult2 | PromiseLike<TResult2>)
Adjunta devoluciones de llamada para la resolución o rechazo de la promesa.
function then<TResult1, TResult2>(onfulfilled?: null | (value: TResult) => TResult1 | PromiseLike<TResult1>, onrejected?: null | (reason: any) => TResult2 | PromiseLike<TResult2>): Promise<TResult1 | TResult2>
Parámetros
- onfulfilled
-
null | (value: TResult) => TResult1 | PromiseLike<TResult1>
Devolución de llamada que se va a ejecutar cuando se resuelve la promesa.
- onrejected
-
null | (reason: any) => TResult2 | PromiseLike<TResult2>
Devolución de llamada que se va a ejecutar cuando se rechaza la promesa.
Devoluciones
Promise<TResult1 | TResult2>
Promesa para la finalización de la que se ejecuta la devolución de llamada.
Heredar de Promise.then