適用於 JavaScript 的 Azure 中止控制器用戶端連結庫 - 2.1.2 版

此@azure/abort-controller套件提供AbortSignalLike介面和AbortError類別，讓您更輕鬆地使用 AbortController，以及AbortSignal擷取內建於新式 JavaScript 平臺的 。

Azure SDK for JavaScript 的客戶通常不需要使用此連結庫。 相反地，它們會使用 AbortController 和 AbortSignal 由其平臺提供，並將中止訊號傳遞至 Azure SDK 作業。

重要連結：

• 原始程式碼 \(英文\)
• 套件 (npm)
• API 參考檔

開始使用

安裝

使用 npm 安裝此程式庫，如下所示

npm install @azure/abort-controller

重要概念

使用 AbortController 來建立 AbortSignal ，然後可以傳遞至 Azure SDK 作業以取消擱置中的工作。 可透過 signal 具現化的屬性AbortController來存取 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 資料夾中查看公用類別的進階使用方式和行為。

疑難排解

如果您在使用此程式庫時遇到問題，可隨時提出問題。

參與

如果您希望向此程式庫投稿，請參閱投稿指南，深入瞭解如何組建與測試程式碼。