JavaScript 用 Azure Abort Controller クライアント ライブラリ - バージョン 2.1.2
このパッケージには@azure/abort-controller
、AbortController と、最新の JavaScript プラットフォームに組み込まれているフェッチによって使用される をAbortSignal
操作しやすくするためのインターフェイスとAbortError
クラスが用意AbortSignalLike
されています。
一般に Azure SDK for JavaScript のお客様は、このライブラリを使用する必要はありません。 代わりに、プラットフォームで と が使用 AbortController
され AbortSignal
、提供され、中止シグナルが Azure SDK 操作に渡されます。
主要リンク:
作業の開始
インストール
次のように npm を使用してこのライブラリをインストールします
npm install @azure/abort-controller
主要概念
を使用 AbortController
して を作成 AbortSignal
し、Azure SDK 操作に渡して保留中の作業を取り消すことができます。 AbortSignal
は、インスタンス化された AbortController
の signal
プロパティを経由してアクセスできます。
また、AbortSignal
は、AbortSignal.timeout(100)
などの静的メソッドから直接返すこともできます。
100 ミリ秒後にキャンセルされます。
例
次の例では、doAsyncWork
がプロパティのバッグを受け取る関数であり、そのうちの 1 つは中止シグナルであると想定されています。
例 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
フォルダーを調べて、パブリック クラスの高度な使用状況と動作を確認します。
トラブルシューティング
このライブラリの使用中に問題が発生した場合は、お気軽に問題を提出してください。
共同作成
このライブラリに投稿する場合、コードをビルドしてテストする方法の詳細については、投稿ガイドを参照してください。
Azure SDK for JavaScript