【Node.js24.x】Object::CANCELLEDプロパティの使い方

CANCELLEDプロパティは、Node.jsにおける非同期操作のキャンセルメカニズムにおいて、標準的なキャンセル理由を識別するための特別なシンボル値を保持するプロパティです。このプロパティは、非同期処理（例えば、ネットワークリクエストやファイル操作、タイマー処理など）が実行中に不要になった際に、その処理を安全に中断するためのAbortSignalオブジェクトと密接に関連しています。

Node.jsでは、AbortControllerとそれから生成されるAbortSignalを使用して、実行中の非同期処理をキャンセルできます。AbortControllerのabort()メソッドが呼び出されると、関連するAbortSignalはキャンセル状態になり、その理由を示す値がsignal.reasonプロパティに格納されます。

もしAbortControllerのabort()メソッドが、キャンセル理由を具体的に指定せずに呼び出された場合、デフォルトでObject.CANCELLEDという特別なシンボル値がsignal.reasonプロパティに自動的に設定されます。このCANCELLEDプロパティが保持する値は、開発者が「処理がユーザーによる明示的なキャンセル、または同等の標準的な理由によって中断された」ことをプログラム上で識別するために利用されます。

したがって、開発者は非同期処理におけるキャンセルの発生を検知した際に、signal.reasonの値がObject.CANCELLEDであるかを確認することで、それが一般的なキャンセルによるものか、あるいは別の特定のエラーやタイムアウトなどの理由によるものかを区別できます。これにより、アプリケーションはキャンセルの種類に応じて適切な後処理やリソースの解放を実行し、より堅牢で予測可能な非同期処理の制御を実現することが可能になります。

Copy
1module.Object.CANCELLED

引数なし

引数はありません

戻り値なし

戻り値はありません