简介
stargs
是一个能轻松转化对象属性的树形结构的 npm 包,它处理的是一个对象或者数组的引用,将其返回。它可以将深嵌套对象或数组转换为或们理解的树形结构,从而提供用户更好的可视化、可读性。
安装
首先,你需要先安装好 Node.js。如果你没有安装 Node.js,可以在官方网站下载安装。
然后,使用以下命令在终端安装 stargs
:
npm install stargs
使用
用以下代码引入 stargs
:
const stargs = require('stargs')
使用方法
在这里我们将展示 stargs
的使用方法:
-- -------------------- ---- ------- ----- -------- - - ------ --------- ------ - ------- ------------ ------- ----------- - - ----- ------ - ---------------- -------------------
打印结果:
+ prop1 : value1 + prop2 | + prop21 : subvalue1 | + prop22 : subvalue2
可以看到,我们将 JSON 对象 "myObject" 传入 stargs,接着它返回了我们期望的树形结构。我们可以看到,对象的属性以加号 (+) 开头。如果这个属性是一个对象,就会用竖线 (|) 连接上一层级,之后再以一个加号开头。这种语法可以很好地区分对象属性和对象属性值。
下面是另一个例子,我们传入一个数组,也是返回一种类似于树形结构的格式:
-- -------------------- ---- ------- ----- ------- - - ------ -------- ---- ---- ------ ------ ---- ---- ------ ---------- ---- --- - ----- ------ - --------------- -------------------
打印结果:
-- -------------------- ---- ------- --- - - ---- - ----- - - --- - -- --- - - ---- - --- - - --- - -- --- - - ---- - ------- - - --- - --
配置
可以使用配置对象来更改默认参数,如下:
-- -------------------- ---- ------- ----- -------- - - ------ --------- ------ --------- -------- -------- - ----- ------ - - ------- - -- -------- ----- --------------- ----- - ----- ------ - ---------------- ------- -------------------
输出:
+ prop1 : value1 + prop2 [0] : item1 [1] : item2 [2] : item3
indent
, 确定每个缩进的字符。默认为两个空格。lineEnd
,确定每行结束时添加的字符。默认是 "\n" 。keysInBrackets
, 一个布尔值,表示每个属性名称是否应在方括号内。
结论
现在你已经掌握了 stargs
的使用方法,这个 npm 包可以帮助你将深度嵌套的对象或数组转换为树形结构,使它们更加具有可视化、可读性。
一个好的可读性更好的代码,将使得团队成员更加容易理解并进行维护,因此使用 stargs
更有利于我们开发出更具有可维护性的代码。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60056cd181e8991b448e6600