関数の概要
util.formatは、Node.jsで提供される関数の一つであり、文字列を指定のフォーマットに整形するために使用されます。主な目的は、プレースホルダーを含むテンプレート文字列を、実際の値で置換して結合することです。これにより、可読性の高い文字列を生成することができます。
パラメータの説明
| 引数 | 型 | 用途 |
|---|---|---|
| format | string | 整形したいテンプレート文字列 |
| …args | any | プレースホルダーに代入する実際の値 |
戻り値
util.formatは、整形された文字列を返します。戻り値はstring型で、同期的に処理されます。
使用例
以下に、util.formatの使用例を示します。
const util = require('util');
const message = util.format('Hello, %s! Today is %s.', 'John', 'Monday');
console.log(message);
// 出力: Hello, John! Today is Monday.
もう一つの例：
const util = require('util');
const formattedString = util.format('%d + %d = %d', 2, 3, 5);
console.log(formattedString);
// 出力: 2 + 3 = 5
関連する関数
- util.inspect: オブジェクトを文字列に変換するために使用される
- util.promisify: コールバックベースの関数をPromiseベースの関数に変換する
まとめ
util.formatは、文字列の整形に便利な関数です。プレースホルダーを使用して、テンプレート文字列を指定の形式に整形することができます。注意点としては、引数の数や型に気を付けて正しく整形する必要があります。
