【Node.js24.x】Object::format()メソッドの使い方
formatメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
formatメソッドはObjectクラスに属し、与えられた引数を特定の書式に従って整形し、一つの文字列として出力するメソッドです。このメソッドは、C言語のprintf関数に似た機能を提供しており、プログラミングにおいてデバッグ情報の出力や、ユーザーへのメッセージ表示など、動的に文字列を組み立てる必要がある場面で非常に役立ちます。
このメソッドを使用する際は、最初の引数にフォーマット文字列を指定し、その中に%s（文字列）、%dや%i（整数）、%f（浮動小数点数）、%j（JSON形式）、%oや%O（オブジェクト）といったプレースホルダーを配置します。これらのプレースホルダーは、後続の引数の値によって置き換えられます。例えば、format('名前: %s, 年齢: %d', '太郎', 30)と記述すると、「名前: 太郎, 年齢: 30」のような文字列が生成されます。
もしフォーマット文字列中のプレースホルダーの数に対し、対応する引数が不足している場合、残りの引数は自動的にスペースで区切られて、生成される文字列の末尾に追加されます。また、最初の引数がフォーマット文字列ではない場合、formatメソッドはすべての引数を単純にスペースで区切って結合する動作をします。このように、formatメソッドは柔軟な文字列整形機能を提供し、可読性の高い出力を簡単に実現するための重要なツールです。
構文(syntax)
1const util = require('node:util'); 2const formattedString = util.format('ユーザー名: %s, ID: %d', 'guest', 101); 3console.log(formattedString);
引数(parameters)
format, ...args
- format: string: フォーマット文字列。
%sや%dなどのプレースホルダーをargsの値で置き換えます。 - ...args: any: フォーマット文字列で使用される値。可変長引数です。
戻り値(return)
戻り値なし
戻り値はありません