在前端开发中，我们不可避免地需要与 JSON 文件打交道，比如读取和写入 JSON 文件。而 @types/write-json-file 这个 npm 包为 JavaScript 或 TypeScript 提供了一种便捷的方式来写入 JSON 文件，并且它支持异步操作和文件锁定机制。
安装
首先，我们需要安装该 npm 包。在终端中运行以下命令即可：
npm install --save-dev @types/write-json-file
注意，这个 npm 包只提供了 TypeScript 类型声明文件，实际的写入 JSON 文件的代码需要使用对应的写入 JSON 文件的库，比如 fs-extra 或者 node-json-db 等。
使用
在 TypeScript 代码中，我们需要引入 @types/write-json-file 包，并且导入 WriteJsonFile 函数。接下来，我们来看一下基本的用法。
import WriteJsonFile from 'write-json-file';
const data = { msg: 'Hello, World!' };
WriteJsonFile('./data.json', data)
.then(() => console.log('写入成功！'))
.catch((error) => console.error(`发生错误：${error}`));可以看到，WriteJsonFile 的第一个参数是文件路径，第二个参数是要写入的 JSON 数据。该函数返回一个 Promise。
我们也可以使用 async/await 语法来使用该函数。
-- -------------------- ---- -------
------ ------------- ---- ------------------
----- -------- ------ -
----- ---- - - ---- ------- ------- --
--- -
----- ---------------------------- ------
---------------------
- ----- ------- -
-------------------------------
-
-
-------进阶应用
当我们需要写入的 JSON 数据超过一定的大小时，我们可能需要考虑使用流式传输。那么我们可以这样写：
-- -------------------- ---- -------
------ -- ---- -----
------ ------------- ---- ------------------
------ - -------- - ---- ------------------
----- ---- - --- -----------
----- -------- ------------------------- ------- ----- ----- ------------- -
----- ----------- - ----- -- -- ------------------- - -------- - ---
----- ----------- - ----- -- -- ----------------------
----- ----------- - ------------------------------ - ------ --- ---
----- ---------- - -------------------- - -----
------------------------------
------------------
--- -
----- --------------
----- ----------------------- ----- - ----- ------ ------- ---- ---
- ------- -
----- --------------
-
-
------ -- -- -
----- ---- - - ----- --- ------------------- ----- ------- ------ --- -- --
----- ------------------------------ ------
-----可以看到，我们写入一个大数据量的 JSON 文件时，我们将文件的写入操作通过流式方式，将此操作保护在一个异步 lock 内，将写入时 换行符，将异步的 lock 和过程处理交由 WriteJsonFile 包来完成。这些步骤不仅可以保证文件写入的顺序，避免资源冲突，而且还保证了 WriteJsonFile 的同原子操作，即使写入过程被中断，写入文件也不至于是损坏的。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/110981