介绍
json-briefing 是一个 npm 包，能够将 JSON 对象转换为可读性更好的文本格式。这个模块能够将 JSON 对象转换为 Markdown 或者 HTML 格式，方便我们将数据在网站或者文档中展示。
在本篇文章中，我们将深入介绍如何使用 json-briefing 模块，并且，通过我们的实例，你将学习到如下技术：
- 使用 npm 安装和管理模块；
- 了解 js 中的对象；
- 如何使用 js 中的对象转换成 JSON 对象；
- 如何使用
json-briefing显示 JSON 对象； - 如何使用 Markdown 含义。
安装
要安装 json-briefing，我们需要在控制台中输入下面的命令：
npm install json-briefing --save
这个命令将会下载 json-briefing 模块并把相关依赖项添加到 package.json。--save 标志将会把这个模块添加到我们的依赖项中。
使用
一般来说，json-briefing 需要下面的步骤：
- 创建 JSON 对象
- 转换成可读取的格式
- 将其显示在网页上
在下面，我们将详细讲解怎样按照这个步骤使用 json-briefing 库。
创建 JSON 对象
你必须先创建一个 JSON 对象。可以按照下面的代码从一个 js 对象上创建：
const jsonObj = {
"name": "Jack",
"age": 30,
"location": "New York",
"hobbies": ["reading", "guitar"]
};将 JSON 对象转换成可读性更好的格式
我们将使用 json-briefing 模块将其转换。以下代码将使用 json-briefing：
const briefing = require('json-briefing');
const text = briefing(jsonObj).html(); // 获得 HTML 格式的文本这段代码首先将 json-briefing 模块引入。然后，使用创建的 JSON 对象调用 briefing 函数，并将结果分配到文本变量中。调用 html() 方法可以将结果以 HTML 格式形式获得。
输出文本将看起来像这样：
-- -------------------- ---- -------
----
-------------------------- ---------
------------------------- -------
------------------------------ --- ---------
-----------------------------
----
----------------
---------------
-----
-----
-----将其显示在网页上
我们将使用 Node.js的 http 模块来展示生成的 HTML。可以按照下面的示例代码：
const http = require('http');
http.createServer(function(req, res) {
res.writeHead(200, {'Content-Type': 'text/html'});
res.write(text);
res.end();
}).listen(8080);此代码将创建一个本地网络服务，并将转换后的 HTML 内容输出到http://127.0.0.1:8080。
使用 Markdown
json-briefing 可以使用 Markdown 格式显示 JSON 对象。以下代码将显示一个包含 JSON 数据的 Markdown 文件：
const briefing = require('json-briefing');
const text = briefing(jsonObj).markdown(); // 获得 Markdown 格式的文本这将会显示下面的 Markdown 文本：
- **name**: Jack - **age**: 30 - **location**: New York - **hobbies**: - reading - guitar
总结
在这个教程中，我们介绍了如何使用 json-briefing 包，并且了解了如何：
- 安装模块，并将其添加到 package.json；
- 创建 JS 对象；
- 将 JS 对象转换为 JSON 对象；
- 使用
json-briefing将 JSON 对象转换为可读性更好的文本格式； - 使用本地网络服务来展示转换后的 HTML 内容。
此外，我们还介绍了 json-briefing 使用 Markdown 的方式。
通过本篇文章，你可以更加清晰地了解如何使用 json-briefing 包。技巧和方法足够详细，且能够应用到实际开发应用中，能够在学习和开发中发挥指导作用。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600575c281e8991b448ea716