【Node.js24.x】Object::inspect()メソッドの使い方
inspectメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
inspectメソッドは、オブジェクトの内容を人間が読みやすい形式の文字列に変換し、その表現を返すメソッドです。このメソッドは、主にデバッグやログ出力の際に利用され、プログラム実行中にオブジェクトの内部状態を詳細に把握するために使用されます。
一般的なtoString()メソッドがオブジェクトの単純な概要しか提供しないのに対し、inspectメソッドはより詳細な情報を提供します。具体的には、オブジェクトが持つ全てのプロパティ、その値、そしてそれらがネストされたオブジェクトや配列である場合でも、再帰的にその内部構造を深く辿り、表示します。出力される文字列は、適切なインデントや区切り文字で整形されるため、複雑なデータ構造であっても視覚的に理解しやすくなっています。
これにより、開発者はコードの動作確認や予期せぬ挙動の原因究明において、オブジェクトがどのような状態にあるのかを瞬時に把握することができます。特に、大規模なアプリケーションや複数のモジュールが連携するシステムにおいて、特定のオブジェクトの状態を詳細に検査することは、効率的なデバッグプロセスに不可欠です。このメソッドは、開発者がオブジェクトの現在の状態について、より深い洞察を得るための強力なツールとして機能します。
構文(syntax)
1import util from 'node:util'; 2 3util.inspect(object, [options]);
引数(parameters)
value, opts
- value: any: インスペクション（構造の可視化）を行う対象の値。プリミティブ型、オブジェクト、配列など、JavaScriptで扱えるほとんどの値。
- opts: object = {}: インスペクションの挙動を制御するためのオプションオブジェクト。省略可能。
戻り値(return)
戻り値なし
戻り値はありません