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

formatメソッドは、Objectクラスに属し、書式指定文字列とそれに続く引数を使って整形された文字列を生成するメソッドです。これは、C言語のprintf関数に似た機能を提供し、複数の異なる型の情報を一つの読みやすい文字列に統合する際に非常に役立ちます。

このメソッドの基本的な使い方は、最初の引数として書式指定文字列を渡し、その後に書式指定子に対応する値を渡すことです。例えば、文字列を埋め込むための%s、整数を埋め込むための%d、浮動小数点数を埋め込むための%fなどがあります。また、JavaScriptオブジェクトをJSON形式で表示する%jや、オブジェクトの内部構造を詳細に検査して表示する%o（または%O）といった指定子も利用できます。

引数が書式指定子よりも多い場合、余った引数は空白で区切られ、整形された文字列の末尾に連結されます。逆に、書式指定子よりも引数が少ない場合、対応する値が提供されなかった書式指定子はそのまま文字列中に残ります。このメソッドは、ログ出力やユーザーへのメッセージ表示など、動的に内容が変化する文字列を効率的に作成したい場合に特に有用です。正確な情報を一貫した形式で表現するために活用されます。

Copy
1const util = require('node:util');
2const formattedString = util.format('名前: %s, 年齢: %d歳', '山田太郎', 28);

...args

• message: string: フォーマットする文字列。%s や %d などのプレースホルダーを使用できます。
• ...args: any[]: フォーマット文字列に埋め込む値。

戻り値なし

戻り値はありません