util.inspect

関数の概要

util.inspectは、Node.jsで提供されている関数の1つです。この関数は、JavaScriptのオブジェクトや値を文字列として表現するために使用されます。デバッグやログ出力などで、オブジェクトの中身を見やすく表示する際に役立ちます。

パラメータの説明

戻り値

util.inspectの戻り値は、指定されたオブジェクトや値を文字列として表現したものです。非同期処理ではなく、同期的に実行されます。

使用例

以下に、util.inspectの使用例を示します。

const util = require('util');
const obj = { name: 'John', age: 30 };
console.log(util.inspect(obj));

オプションを使用する例：

const util = require('util');
const obj = { name: 'John', age: 30 };
console.log(util.inspect(obj, { colors: true, depth: null }));

関連する関数

util.inspectと一緒によく使われる関数には、console.logやJSON.stringifyがあります。これらもオブジェクトを文字列に変換する際に活用されます。

まとめ

util.inspectは、オブジェクトを文字列として表現するための便利な関数です。デバッグやログ出力などでオブジェクトの中身を見やすく表示する際に活用できます。オプションを指定することで、表示形式をカスタマイズすることも可能です。