【Node.js24.x】Object::formatWithOptions()メソッドの使い方

formatWithOptionsメソッドは、Node.jsのutilモジュールが提供する機能の一つで、C言語のprintf関数に似た書式指定で文字列を整形し、出力する処理を実行するメソッドです。

このメソッドは、デバッグメッセージやログ出力などにおいて、複数の値を指定された書式文字列に従って結合し、読みやすい一つの整形された文字列として生成するために使用されます。プログラムの変数やオブジェクトの状態を詳細かつ分かりやすく表示したい場合に特に役立ちます。

利用する際は、最初の引数にoptionsオブジェクトを指定し、書式指定子の挙動やオブジェクトの検査オプションを設定します。例えば、出力に色を付けるか、オブジェクトをどこまで深く展開して表示するかなどを設定可能です。続く引数として、整形したい文字列のパターンを定義するformat文字列と、そのformat文字列内の書式指定子（例: %sで文字列、%dで数値、%jでJSONオブジェクトなど）に対応する可変個の値を渡します。

optionsオブジェクトを柔軟に利用することで、出力される文字列の視覚的なカスタマイズや、複雑なオブジェクトの詳細な表示を制御できます。これにより、単に値を連結するだけでなく、人間が理解しやすい形に整形して表示できるため、システム開発におけるデバッグ作業の効率化やログの見やすさ向上に大きく貢献します。複雑なデータ構造も適切な書式で表現できるため、プログラムの動作解析において非常に強力なツールとなります。

Copy
1const util = require('node:util');
2
3const inspectOptions = { colors: true, depth: 0 };
4const formattedString = util.formatWithOptions(inspectOptions, 'User: %s, ID: %d, Active: %j', 'Alice', 123, true);

inspectOptions, format, ...args

• inspectOptions: object = { depth: null, colors: false }: オブジェクトの検査（インスペクション）方法を指定するオプション
• format: string: フォーマット文字列。printfライクな書式指定子を使用可能
• ...args: any[]: フォーマット文字列で使用される引数

string

Object.formatWithOptions メソッドは、指定されたオプションに基づいて、JavaScriptオブジェクトを整形した文字列を返します。