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() 是一种同步方法，旨在用作调试工具。某些输入值可能会产生很大的性能开销，从而阻塞事件循环。请谨慎使用此函数，切勿在热代码路径中使用。