前言
对于前端来说，处理文件 I/O 操作时需要依赖 Node.js 提供的 fs 模块，但是其中存在多个异步 API，如读取文件的 fs.readFile() 和写入文件的 fs.writeFile()，这些操作需要手动管理回调函数和错误处理，增加了代码的复杂度和可读性。
为了简化这些操作，NPM 社区中有一个名为 @cgjs/fs 的包，该包提供了一组 Promise 封装的异步文件 I/O API，使得读写文件更加简单愉悦。本文将介绍如何使用该 npm 包。
安装
在控制台中执行以下命令进行安装：
npm install @cgjs/fs
用法
@cgjs/fs 中的 API 与 Node.js 原生的 fs 模块一致，但是 API 被 Promise 包装封装，使得操作文件更加简单。
例如，使用 fs.readFile() 方法读取文件中的数据：
-- -------------------- ---- -------
----- -- - --------------------
----------------------------
---------- -- -
-----------------------------
--
------------ -- -
---------------------
---在这个示例中，通过调用 fs.readFile() 并传递文件路径作为参数来读取文件。返回一个 Promise，我们可以通过 .then() 获取读取的数据并将其打印到控制台。如果出现错误，.catch() 将捕捉错误并将其打印到控制台。
类似地，使用 fs.writeFile() 方法将数据写入到文件中：
-- -------------------- ---- -------
----- -- - --------------------
----- ---- - ------- --------
----------------------------- -----
-------- -- -
----------------- ------- -- --------
--
------------ -- -
---------------------
---在这个示例中，我们传递了文件路径和要写入文件的数据。当文件写入完成后，将打印“Data written to file!”。如果出现错误，则会将其打印到控制台。
进阶用法
除了基本的读/写操作，@cgjs/fs 还提供有用的进阶用法，例如：读取和写入二进制文件、追加到文件、递归创建目录等。
读取和写入二进制文件
使用 fs.readBinFile() 方法读取二进制文件：
-- -------------------- ---- -------
----- -- - --------------------
-------------------------------
---------- -- -
------------------
--
------------ -- -
---------------------
---使用 fs.writeBinFile() 向二进制文件中写入数据：
-- -------------------- ---- -------
----- -- - --------------------
----- ---- - ------------------ ----- -------
-------------------------------- -----
-------- -- -
----------------- ------- -- --------
--
------------ -- -
---------------------
---追加到文件
使用 fs.appendFile() 方法将数据追加到文件末尾：
-- -------------------- ---- -------
----- -- - --------------------
----- ---- - ------- --------
------------------------------ -----
-------- -- -
----------------- -------- -- --------
--
------------ -- -
---------------------
---在这个示例中，我们将数据追加到文件末尾。当追加完成后，将打印“Data appended to file!”。如果出现错误，则会将其打印到控制台。
递归创建目录
使用 fs.mkdirp() 方法递归创建目录：
-- -------------------- ---- -------
----- -- - --------------------
-----------------------------
-------- -- -
---------------------- -----------
--
------------ -- -
---------------------
---在这个示例中，我们将创建一个名为“new”目录的新目录，并在其下创建一个名为“dir”的子目录。如果出现错误，则会将其打印到控制台。
总结
使用 @cgjs/fs 包可以大幅简化文件 I/O 操作的代码，使其更加易于阅读和维护。
简单地将 fs 原生 API 替换为使用 Promise 封装的 @cgjs/fs API，可以轻松地将现有文件 I/O 代码转化为 Promise 链式调用形式，编写出更加简洁、容错率更高的代码。
我强烈建议您在进行前端文件 I/O 操作时使用 @cgjs/fs 包，它将为您带来许多便利和好处。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60065b42c6eb7e50355dbd96