【Node.js24.x】AbortSignal::AbortSignal()関数の使い方
AbortSignal関数の使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
AbortSignal関数は、AbortSignalクラスのインスタンスを生成するための関数です。このインスタンスは、Node.js環境における非同期処理を中止（キャンセル）するためのシグナルを提供します。具体的には、進行中の非同期操作に対し、中止の意思を伝達し、その操作を途中で停止させる役割を果たします。
通常、AbortSignalインスタンスは直接この関数を呼び出して作成するのではなく、AbortControllerオブジェクトのsignalプロパティを通じて取得されます。AbortControllerは、AbortSignalと連携して動作し、コントローラーが中止されたときに、関連付けられたシグナルを監視しているすべての非同期処理に中止を通知します。
この機能は、ネットワークリクエストのタイムアウト、ユーザーによる操作の中断、不要になったバックグラウンドタスクの停止など、様々なシナリオで活用されます。例えば、fetch APIなどの非同期操作にAbortSignalを渡すことで、指定したタイミングでリクエストを中止し、無駄なリソース消費を防ぎ、アプリケーションの応答性を向上させることができます。これにより、開発者はより堅牢で効率的な非同期コードを記述することが可能になります。
構文(syntax)
1const signal = AbortSignal.abort();
引数(parameters)
dontThrowSymbol=undefined, init=kEmptyObject
- dontThrowSymbol: symbol | undefined:
AbortSignal.timeout()などのメソッドで、例外をスローする代わりにこのシンボルを返すように設定するためのシンボル。デフォルトはundefined。 - init: object = kEmptyObject:
AbortControllerの初期化に使用されるオブジェクト。通常は空のオブジェクト{}。
戻り値(return)
戻り値なし
戻り値はありません