@anchan828/nest-storage 是一个基于 Nest.js 框架的包，提供了将数据存储在本地文件系统中的功能，方便前端开发者进行数据持久化操作。在这篇文章中，我们将详细介绍如何使用 @anchan828/nest-storage 包。
安装
使用 npm 安装 @anchan828/nest-storage 包：
npm i @anchan828/nest-storage
引入
在你的 Nest.js 应用程序中引入 @anchan828/nest-storage 包:
-- -------------------- ---- -------
------ - ------ - ---- -----------------
------ - ----------------- - ---- --------------------------
---------
-------- -
---------------------------
----- --------- -- ------
---
--
--
------ ----- --------- --在上面的代码中，我们通过 NestStorageModule.forRoot() 方法将模块引入到应用程序中。 配置选项需要指定数据的存储路径以及其他可选参数（例如，您可以配置 JSON 文件名和扩展名）。在这个示例中，我们将数据存储在 ./data 目录中。
API
@anchan828/nest-storage 包提供了一个实用的 Storage 类，使您可以执行 CRUD 操作。让我们来看一些基本的用例：
写入数据
-- -------------------- ---- -------
------ - ----------- --- - ---- -----------------
------ - ------- - ---- --------------------------
--------------------
------ ----- --------------- -
------- -------- -------- --------
------------- -
------------ - --- -----------------
-
------
----- ---------- -
----- ----- - ----- -------------------
------ ----- -- ---
-
-- ---- ----
-------
----- ------------------ ----- ----- -
----- ------------------------- ------
-
-- ---- -----
---------------
----- ------------------- ------ ------- -
----- --------------------------
-
-在上面的示例中，我们创建了一个 TodosController，并通过构造函数实例化了 Storage 类。从 @nestjs/common 中导入 @Controller 和 @Get 装饰器，我们可以通过 @Controller 装饰器来定义路由前缀，通过 @Get 装饰器定义路由处理程序，这里我们仅仅是获取 todos 数据。
我们还看到，我们使用了 @Body() 装饰器从请求体中获取数据并写入到 todos 中。我们可以通过调用 this.storage.set() 方法，将数据写入到数据存储中。
如果我们需要写入多个 todos，我们可以使用 batch() 方法，其接受一个数组参数。 这些示例仅是 Storage 类的基本招式， 要了解更多方法的详细信息，请查看官方文档。
获取数据
-- -------------------- ---- -------
------ - ----------- ---- ----- - ---- -----------------
------ - ------- - ---- --------------------------
--------------------
------ ----- --------------- -
------- -------- -------- --------
------------- -
------------ - --- -----------------
-
------
----- ---------- -
----- ----- - ----- -------------------
------ ----- -- ---
-
-- ---- ----
-----------
----- -------------------- --- ------- -
----- ---- - ----- ---------------------
-- ------- -
----- --- ----------------------- --- --------
-
------ -----
-
-在上面的示例中，我们定义了 getTodo() 方法，使用 @Param('id') 装饰器来从路由参数中获取 id。如果我们不能找到该 ID 的记录，我们返回一个 NotFoundException 异常。
在getTodo 方法中，我们调用 this.storage.get() 方法。它返回存储的数据，如果找不到，则返回 null。
总结
@anchan828/nest-storage 包提供了一个轻量级和易于使用的方法来将数据存储在本地文件系统中。我们可以使用 Storage 类轻松执行一些常见的 CRUD 操作。 值得注意的是，我们应该尽量避免在生产环境中使用本地文件系统来存储数据。否则，可能会面临一些安全、性能等问题。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/155797