Клиентская библиотека контроллера Azure Abort для JavaScript версии 2.1.2

Пакет @azure/abort-controller предоставляет AbortSignalLike интерфейс и AbortError классы, которые упрощают работу с AbortController и AbortSignal , используемым при выборке , встроенные в современные платформы JavaScript.

Клиентам пакета Azure SDK для JavaScript в целом не требуется использовать эту библиотеку. Вместо этого они используют AbortController и AbortSignal предоставляются их платформами и передают сигналы прерывания в операции пакета AZURE SDK.

Основные ссылки:

• Исходный код
• Пакет (npm)
• Справочная документация по API

Начало работы

Установка

Установите эту библиотеку с помощью npm следующим образом

npm install @azure/abort-controller

Основные понятия

Используйте для AbortController создания , AbortSignal который затем можно передать в операции Пакета SDK Azure для отмены ожидающих работ. Доступ для AbortSignal можно получить с помощью свойство signal в экземпляре AbortController. Также AbortSignal можно вернуть непосредственно статическим методом, например AbortSignal.timeout(100). который отменяется через 100 миллисекунд.

Примеры

В приведенных ниже примерах предполагается, что doAsyncWork это функция, которая принимает контейнер свойств, одно из которых является сигналом прерывания.

Пример 1. Базовое использование

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

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

Пример 2. Прерывание с истечением времени ожидания

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

Дальнейшие действия

Вы можете создавать и запускать тесты локально с помощью команды rushx test. Изучите папку test, чтобы увидеть расширенное использование и поведение открытых классов.

Устранение неполадок

Если при использовании этой библиотеки возникают проблемы, вы можете сообщить о проблеме.

Участие

Если вы хотите вносить изменения в эту библиотеку, ознакомьтесь с руководством по внесению изменений, в котором содержатся сведения о создании и тестировании кода.