@azure/core-lro package
Interfaces
CreateHttpPollerOptions |
Opciones de |
OperationConfig |
Configuraciones para sondear la operación y comprobar si ha finalizado. |
OperationResponse |
Tipo de la respuesta de un LRO. |
OperationState |
Aunque el sondeo funciona como mecanismo de control local para iniciar el desencadenamiento y esperar una operación de larga duración, OperationState documenta el estado de la operación remota de larga duración. Se actualiza después de cada sondeo. |
PollerLike |
Un sondeo para una operación. |
RawRequest |
Tipo simple de la solicitud sin formato. |
RawResponse |
Tipo simple de la respuesta sin procesar. |
RunningOperation |
Descripción de una operación de larga duración. |
Alias de tipos
CancelOnProgress |
CancelOnProgress se usa como valor devuelto del método onProgress de poller. Cuando un usuario invoca onProgress, es necesario pasar una función a la que se llamará como devolución de llamada con los nuevos datos recibidos cada vez que se actualice la operación de sondeo. onProgress devuelve una función que impedirá que cualquier actualización adicional llegue a la devolución de llamada original. |
OperationStatus |
El conjunto de estados posibles en los que se puede realizar una operación puede estar en cualquier momento dado. |
ResourceLocationConfig |
Ubicación potencial del resultado del LRO si se especifica mediante la extensión LRO en swagger. |
RestorableOperationState |
Tipo de una operación de larga duración restaurable. |
Funciones
create |
Crea un sondeo que se puede usar para sondear una operación de larga duración. |
deserialize |
Deserializa el estado |
Detalles de la función
createHttpPoller<TResult, TState>(RunningOperation<unknown>, CreateHttpPollerOptions<TResult, TState>)
Crea un sondeo que se puede usar para sondear una operación de larga duración.
function createHttpPoller<TResult, TState>(lro: RunningOperation<unknown>, options?: CreateHttpPollerOptions<TResult, TState>): PollerLike<TState, TResult>
Parámetros
- lro
-
RunningOperation<unknown>
Descripción de la operación de ejecución prolongada
- options
-
CreateHttpPollerOptions<TResult, TState>
opciones para configurar el sondeo
Devoluciones
PollerLike<TState, TResult>
un sondeo inicializado
deserializeState<TResult, TState>(string)
Deserializa el estado
function deserializeState<TResult, TState>(serializedState: string): RestorableOperationState<TResult, TState>
Parámetros
- serializedState
-
string
Devoluciones
RestorableOperationState<TResult, TState>