Node.js util.format(format[, ...args])用法及代碼示例

util.format(format[, ...args])

參數

• format <string> 類似於 printf 的格式字符串。

util.format() 方法返回一個格式化字符串，使用第一個參數作為類似 printf 的格式字符串，它可以包含零個或多個格式說明符。每個說明符都被相應參數的轉換值替換。支持的說明符是：

• %s ：String 將用於轉換除 BigInt 、 Object 和 -0 之外的所有值。 BigInt 值將用 n 表示，沒有用戶定義的 toString 函數的對象使用帶有選項 { depth: 0, colors: false, compact: 3 } 的 util.inspect() 檢查。
• %d ：Number 將用於轉換除 BigInt 和 Symbol 之外的所有值。
• %i ：parseInt(value, 10) 用於除 BigInt 和 Symbol 之外的所有值。
• %f ：parseFloat(value) 用於除 Symbol 之外的所有值。
• %j：JSON。如果參數包含循環引用，則替換為字符串 '[Circular]'。
• %o：Object。具有通用 JavaScript 對象格式的對象的字符串表示形式。類似於帶有選項 { showHidden: true, showProxy: true } 的 util.inspect() 。這將顯示完整的對象，包括不可枚舉的屬性和代理。
• %O：Object。具有通用 JavaScript 對象格式的對象的字符串表示形式。類似於沒有選項的util.inspect()。這將顯示不包括不可枚舉屬性和代理的完整對象。
• %c：CSS。此說明符被忽略，並將跳過任何傳入的 CSS。
• %%：單百分號('%')。這不會消耗一個論點。
• 返回： <string> 格式化字符串

如果說明符沒有對應的參數，則不會被替換：

util.format('%s:%s', 'foo');
// Returns: 'foo:%s'

如果它們的類型不是 string ，則不屬於格式字符串的值將使用 util.inspect() 進行格式化。

如果傳遞給 util.format() 方法的參數多於說明符的數量，則額外的參數將連接到返回的字符串，以空格分隔：

util.format('%s:%s', 'foo', 'bar', 'baz');
// Returns: 'foo:bar baz'

如果第一個參數不包含有效的格式說明符，util.format() 返回一個字符串，該字符串是由空格分隔的所有參數的串聯：

util.format(1, 2, 3);
// Returns: '1 2 3'

如果僅將一個參數傳遞給 util.format() ，則將按原樣返回，不帶任何格式：

util.format('%% %s');
// Returns: '%% %s'

util.format() 是一種同步方法，旨在用作調試工具。某些輸入值可能會產生很大的性能開銷，從而阻塞事件循環。請謹慎使用此函數，切勿在熱代碼路徑中使用。