【Node.js24.x】Object::AbortController()メソッドの使い方
AbortControllerメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
AbortControllerメソッドは、非同期処理の実行を途中で中止するための信号(AbortSignal)を生成し、その信号を制御する機能を提供します。このメソッドを通じて、新しく中止可能な操作のコンテキストを作成し、必要に応じてその操作の中止を指示することができます。たとえば、ネットワークリクエストやファイル操作、タイマー処理など、時間がかかる非同期タスクに対して、特定の条件やユーザー操作によって早期終了させたい場合に利用されます。AbortControllerメソッドは、対応するAbortSignalオブジェクトを生成し、そのsignalプロパティを通じてfetch APIなどのキャンセル可能な非同期APIに渡すことで連携します。そして、必要に応じてコントローラーのabort()メソッドを呼び出すことで、関連する処理に中止を伝達し、リソースの無駄な消費を防ぎ、アプリケーションの応答性を向上させます。これはNode.js環境において、モダンな非同期処理のキャンセルパターンを実装するための組み込み機能の一つです。
構文(syntax)
1const controller = new AbortController(); 2const signal = controller.signal; 3 4setTimeout(() => { 5 controller.abort(); 6}, 100); 7 8fetch('https://jsonplaceholder.typicode.com/todos/1', { signal }) 9 .then(response => response.json()) 10 .then(data => {}) 11 .catch(error => { 12 if (error.name === 'AbortError') {} else {} 13 });
引数(parameters)
引数なし
引数はありません
戻り値(return)
AbortController
AbortController メソッドは、新しい AbortController インスタンスを生成して返します。このインスタンスは、API リクエストなどの非同期処理をキャンセルするために使用されます。