简介
在前端开发过程中，我们经常需要打印输出对象以方便我们的调试和调用。但是，在浏览器或 node 环境下默认的 console.log() 输出的对象内容非常难以阅读和理解。此时我们需要使用更好的方法来输出对象，以使调试过程更加高效。
此时， @base2/pretty-print-object 就可以帮助我们将对象打印输出为易于阅读的格式。
为什么要使用 @base2/pretty-print-object
使用 @base2/pretty-print-object 可以使对象的打印输出更加易于阅读，让前端调试和开发过程更加高效。
默认的 console.log() 输出的对象如下：
const obj = {
name: 'xiaoming',
age: 18,
gender: 'male'
}
console.log(obj)
// Output: {name: "xiaoming", age: 18, gender: "male"}而使用 @base2/pretty-print-object 输出的对象如下：
-- -------------------- ---- ------- ----- ----- - ------------------------------------- ----- --- - - ----- ----------- ---- --- ------- ------ - ---------- --- - ------- - - - ------- ----------- - ------ --- - --------- ------ - - --
从上面的输出结果可以看出，@base2/pretty-print-object 输出的对象更加易于在控制台中阅读。
安装 @base2/pretty-print-object
安装 @base2/pretty-print-object 可以使用 npm 或 yarn，运行下面的命令即可：
npm install @base2/pretty-print-object # or yarn add @base2/pretty-print-object
使用 @base2/pretty-print-object 打印对象
使用 @base2/pretty-print-object 打印对象的使用非常简单，只需要传递要打印的对象即可。下面进行一个简单的示例：
const ppobj = require('@base2/pretty-print-object')
const obj = {
name: 'xiaoming',
age: 18,
gender: 'male'
}
ppobj(obj)运行上面的代码，可以得到下面的输出：
/**
* Output:
* {
* "name": "xiaoming",
* "age": 18,
* "gender": "male"
* }
*/从上面的输出结果可以看出，@base2/pretty-print-object 输出的对象采用了缩进格式，键值对之间使用逗号隔开，非常易于阅读。
配置 @base2/pretty-print-object
@base2/pretty-print-object 可以通过传递选项来配置输出格式。下面是几个常用的格式选项：
indent: 缩进大小，默认为 2。maxdepth: 最大输出深度，超过此深度的嵌套对象将被省略，避免输出过长。默认为 5。maxarray: 最大输出数组长度，超过此长度的元素将被省略。默认为 100。maxprops: 最大输出属性数量，超过此数量的属性将被省略。默认为 50。
下面是一个配置的示例：
-- -------------------- ---- -------
----- ----- - -------------------------------------
----- --- - -
----- -----------
---- ---
------- -------
-------- -
--------- ------------
----- -----------
------- ------- -------
--
-------- -
-------------
-----------
-----------
------------
--------
-
-
---------- -
------- --
--------- --
--------- -
--运行上面的代码，可以得到下面的输出：
-- -------------------- ---- ------- --- - ------- - - - ------- ----------- - ------ --- - --------- ------- - ---------- - - ----------- ------------ - ------- ----------- - --------- ---- ---------- ------- - -- - ----------- -- --- - -- - ---------- - - ------------- - ----------- - ---- ---------- ------- - -- - ------ -- --- - - - - --
从上面的输出结果可以看出，缩进大小为 4，最大输出深度为 3，超过此深度的对象将被省略，最大输出数组长度为 3，超过此长度的元素将被省略。
总结
@base2/pretty-print-object 可以使我们在前端开发和调试过程中更加高效地输出和阅读对象。在使用时，我们需要掌握基本的打印对象方法和配置选项，以便更好地适应各种不同的输出需求。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedbbd2b5cbfe1ea06119b0