通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

适用于 JavaScript 的 Azure 中止控制器客户端库 - 版本 2.1.2

  • 项目

包 @azure/abort-controller 提供 AbortSignalLike 接口和 AbortError 类，以便更轻松地使用 AbortController 以及 AbortSignal 内置于新式 JavaScript 平台中的 提取 所使用的 。

Azure SDK for JavaScript 的客户通常不需要使用此库。 相反，他们使用 AbortController 平台提供的 和 AbortSignal ，并将中止信号传递给 Azure SDK 操作。

关键链接：

入门

安装

使用 npm 安装此库，如下所示

npm install @azure/abort-controller

关键概念

使用 AbortController 创建一个 AbortSignal ，然后可将其传递给 Azure SDK 操作以取消挂起的工作。 可以通过实例化的 AbortController 上的 signal 属性访问 AbortSignal。 也可以直接从静态方法返回 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 文件夹，查看公共类的高级用法和行为。

疑难解答

如果在使用此库时遇到问题，请随时提出问题。

贡献

若要为此库做出贡献，请阅读贡献指南，详细了解如何生成和测试代码。

曝光数