Compartir a través de

Biblioteca cliente de Azure Abort Controller para JavaScript: versión 2.1.2

  • Artículo

El @azure/abort-controller paquete proporciona AbortSignalLike interfaz y AbortError clases para facilitar el trabajo con AbortController y el AbortSignal usado por la captura integrada en plataformas modernas de JavaScript.

Los clientes del SDK de Azure para JavaScript en general no necesitan usar esta biblioteca. En su lugar, usan AbortController y AbortSignal proporcionan sus plataformas y pasan las señales de anulación a las operaciones del SDK de Azure.

Vínculos principales:

Introducción

Instalación

Instale esta biblioteca con npm como se indica a continuación

npm install @azure/abort-controller

Conceptos clave

Use AbortController para crear un AbortSignal objeto que se puede pasar a las operaciones del SDK de Azure para cancelar el trabajo pendiente. Se puede acceder a AbortSignal a través de la propiedad signal en una instancia de AbortController. También AbortSignal se puede devolver directamente desde un método estático, por ejemplo, AbortSignal.timeout(100). se cancela después de 100 milisegundos.

Ejemplos

En los ejemplos siguientes se supone que doAsyncWork es una función que toma una bolsa de propiedades, una de las cuales es de la señal de anulación.

Ejemplo 1: uso básico

const controller = new AbortController();
doAsyncWork({ abortSignal: controller.signal });

// at some point later
controller.abort();

Ejemplo 2: anular con tiempo de espera

const signal = AbortSignal.timeout(1000);
doAsyncWork({ abortSignal: signal });

Pasos siguientes

Puede compilar y ejecutar las pruebas localmente ejecutando rushx test. Explore la carpeta test para ver el uso avanzado y el comportamiento de las clases públicas.

Solución de problemas

Si tiene problemas al usar esta biblioteca, no dude en presentar un problema.

Contribuciones

Si desea contribuir a esta biblioteca, lea la guía de contribución para obtener más información sobre cómo compilar y probar el código.

Impresiones