npm 包 @sinonjs/formatio 使用教程

简介

@sinonjs/formatio 是一个用于格式化 JavaScript 对象的库，它可以把对象转化为字符串展示，支持多种格式输出。主要应用于测试框架中，可方便进行对象的比较和断言。该库支持 Node.js 和浏览器环境。

安装

在使用 @sinonjs/formatio 之前，需要先安装它。

使用 npm 或者 yarn 安装：

npm install @sinonjs/formatio

# 或

yarn add @sinonjs/formatio

示例

转化为字符串

@sinonjs/formatio 中主要的方法是 format，它的作用是将 JavaScript 对象转化为字符串。下面是一个例子：

-- -------------------- ---- -------
----- ------ - -----------------------------

----- --- - -
  ----- ------
  ---- ---
  -------- -------------- ---------- ----------
  --------- -
    -------- ---- --------
    ----- ----------
    -------- --------
  --
--

----- --- - ------------
-----------------

上面的代码中，我们将一个 JavaScript 对象转化为字符串，并打印输出。运行结果如下所示（对应格式为 default）：

{ name: 'Tom', age: 18, hobbies: [ 'basketball', 'reading', 'movies' ], location: { address: 'xxx street', city: 'Beijing', country: 'China' } }

format 方法还可以接收第二个参数，用于指定格式类型。例如，指定格式为 html：

const str = format(obj, { formatter: 'html' });
console.log(str);

运行结果如下所示：

{<br>&nbsp;&nbsp;name: "Tom",<br>&nbsp;&nbsp;age: 18,<br>&nbsp;&nbsp;hobbies: [ "basketball", "reading", "movies" ],<br>&nbsp;&nbsp;location: {<br>&nbsp;&nbsp;&nbsp;&nbsp;address: "xxx street",<br>&nbsp;&nbsp;&nbsp;&nbsp;city: "Beijing",<br>&nbsp;&nbsp;&nbsp;&nbsp;country: "China"<br>&nbsp;&nbsp;}<br>}

按类型格式化

@sinonjs/formatio 提供了多种格式类型，用于按类型格式化对象。

const str = format(obj, { formatter: 'html', type: 'Object', expand: 1 });
console.log(str);

上面的代码中，我们指定了格式类型为 Object，并设置 expand: 1，表示需要展开子对象。运行结果如下所示：

{<br>&nbsp;&nbsp;<span class="highlight">name:</span> "Tom",<br>&nbsp;&nbsp;<span class="highlight">age:</span> 18,<br>&nbsp;&nbsp;<span class="highlight">hobbies:</span> {<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="highlight">0:</span> "basketball",<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="highlight">1:</span> "reading",<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="highlight">2:</span> "movies"<br>&nbsp;&nbsp;},<br>&nbsp;&nbsp;<span class="highlight">location:</span> {<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="highlight">address:</span> "xxx street",<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="highlight">city:</span> "Beijing",<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="highlight">country:</span> "China"<br>&nbsp;&nbsp;}<br>}

自定义输出

@sinonjs/formatio 提供了一个 Configure 对象，可以用于自定义输出格式。例如，我们可以自定义展示元素名的格式：

const Configure = require('@sinonjs/formatio/out/lib/configure');
const config = new Configure().addType('Object', (obj) => {
  return `Name: ${obj.name}\nAge: ${obj.age}\nHobbies: ${obj.hobbies.join(', ')}\nLocation: ${obj.loation.city}, ${obj.location.country}`;
});

const str = format(obj, { formatter: 'html', configure: config });
console.log(str);

上面的代码中，我们自定义了 Object 类型的格式，添加了对象的 name、age、hobbies 和 location 信息，分别用 \n 换行分隔。运行结果如下所示：

Name: Tom
Age: 18
Hobbies: basketball, reading, movies
Location: Beijing, China

结论

@sinonjs/formatio 是一个非常实用的对象格式化工具，可方便进行对象的展示、比较和断言。该库支持多种格式输出，还提供了自定义输出的功能，使用起来非常灵活方便，是前端开发中不可或缺的工具之一。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/83487