Node.js util.formatWithOptions() 方法

2025年2月22日 | 阅读 4 分钟

在本文中,我们将讨论 Node.js 中 util.formatWithOptions() 方法的语法、参数和示例。

Node.js 中的 util.formatWithOptions() 方法是什么?

util.formatWithOptions() 方法是 util 模块中的一个内置 API。它于 Node.js v10.0.0 中首次引入。它以类似于其他编程语言中的 printf 的方式格式化字符串。第一个参数用作此方法返回的格式化字符串的模板。这些选项类似于 util.inspect() 中使用的选项,在格式化字符串(尤其是包含对象时)时提供了更大的控制和灵活性。

格式化字符串可能包含零个或多个格式说明符,其中适当的参数值已转换并插入到说明符的位置。util.formatWithOptions() 函数是开发人员强大的调试工具,因为它可以提供信息丰富且可读的调试输出。由于它是一个同步方法,因此它确保在返回字符串之前完成格式化和检查。

语法

它具有以下语法:

参数

  • inspectOptions:此参数指定 util.inspect() 方法接收的参数。输出格式,包括颜色、深度和其他检查参数,由这些选项决定。
  • Format:由一个或多个格式说明符组成的格式字符串。格式说明符指定如何格式化后续参数 (args) 并将其插入到字符串中。
  • [, args]:这些是额外的参数,它们根据格式说明符指示的位置进行格式化并插入到格式字符串中。参数的数量和类型是灵活的。

返回值 <string>

返回类型的格式化字符串。

示例

我们以一个例子来说明 Node.js util.formatWithOptions() 方法。

输出

 
1 =>  %: Peter John -0
2 =>  % Peter John Joseph
3 =>  Peter 94357321361723374516854775807n
4 =>  Peter [Object: null prototype] [john] {}
5 =>  NaN 94751625
6 =>  2023 Alex was 40 12.44 10 10
7 =>  947583221.567 Peter 789879654065464
8 =>  {"name":"Joseph","age":25,"city":"Hyderabad"} Peter 78987965465464
9 =>  [class Bar] {
  [length]: 0,
  [prototype]: Bar { [constructor]: [Circular] },
  [name]: 'Bar'
} Peter 78987967415464
10 =>  [class Foo] {
  [length]: 0,
  [prototype]: Foo {
    [constructor]: [Circular],
    [Symbol(Symbol.toStringTag)]: [Getter]
  },
  [name]: 'Foo'
}:NaN 78978425464964   

说明

通过导入 util 模块并利用各种格式说明符来格式化具有一系列值的字符串,此 Node.js 程序演示了如何使用 util.formatWithOptions() 方法。示例涵盖了 BigInt 实例、具有 null 原型的对象、传递多个值、字符串到数字说明符、JSON 对象和类实例等情况。console.log() 方法用于显示格式化输出,并且通过配置颜色和深度等设置提高了输出的可读性。每个示例都演示了如何使用多个格式说明符和参数有效地格式化和检查不同类型的数据。