介绍
@anchan828/nest-storage-common 是一个在 nest.js 框架下能够方便存储和读取数据的工具库。该 npm 包可以极大地提高 nest.js 应用的开发效率和运行性能。
安装
首先，你需要在项目中安装 @anchan828/nest-storage-common。这可以通过 npm 命令完成：
$ npm install @anchan828/nest-storage-common --save
使用
要使用 @anchan828/nest-storage-common，你需要在你的 nest.js 项目的模块文件中导入 StorageModule 模块，并将其放置在 imports 数组中。
import { Module } from '@nestjs/common';
import { StorageModule } from '@anchan828/nest-storage-common';
@Module({
imports: [StorageModule],
})
export class AppModule {}现在，在你的 nest.js 应用程序的任何地方，你就可以注入 StorageService 服务并开始使用它了。
-- -------------------- ---- -------
------ - ---------- - ---- -----------------
------ - -------------- - ---- ---------------------------------
-------------
------ ----- --------- -
------------------- -------- --------------- --------------- --
----- -------------- ------- ----- ----- ------------- -
----- ---------------------------- ------
-
----- ----------------- -------- ------------ -
------ ----- -----------------------------
-
-@anchan828/nest-storage-common 包中的 StorageService 包含以下方法：
set(key: string, value: any): Promise<void>：将key与value关联并保存至存储库中。get(key: string): Promise<any>：从存储库中检索key关联的值。delete(key: string): Promise<void>：从存储库中删除key关联的值。
配置
@anchan828/nest-storage-common 支持多种不同的配置，你可以通过将其配置对象传递给 StorageModule 模块进行自定义配置。
以下为默认配置：
const defaultConfig: StorageModuleOptions = {
type: 'memory',
options: {},
};如果你需要进行配置，请创建一个 configuration 的对象并将其放置在 imports 数组中：
-- -------------------- ---- -------
------ - ------ - ---- -----------------
------ - -------------- -------------------- - ---- ---------------------------------
----- -------------- -------------------- - -
----- --------
-------- -
----- ------------------
----- -----
--
--
---------
-------- ---------------------------------------
--
------ ----- --------- --在上述配置中，我们将存储类型配置为 redis，并为 redis 配置了例程。
例子
这里是一个使用 @anchan828/nest-storage-common 存储机制的简单示例：
-- -------------------- ---- -------
------ - ----------- ----- ----- ---- ----- - ---- -----------------
------ - -------------- - ---- ---------------------------------
-------------
------ ----- ------------ -
------------------- -------- --------------- --------------- --
--------------
----- ---------------------- ---- ------- ------- ----- ----- ------------- -
----- ---------------------------- ------
-
-------------
----- ---------------------- ---- -------- ------------ -
------ ----- -----------------------------
-
-现在，你可以将数据存储到你的 nest.js 应用程序中：
$ curl -XPOST localhost:3000/mykey -d "hello, world!"
并通过 GET 请求检索它：
$ curl localhost:3000/mykey
结论
@anchan828/nest-storage-common 是一个极好的工具库，能够方便地提供存储功能。这篇文章为你展示了如何在 nest.js 应用程序中使用它，并如何进行自定义配置。如果你需要在 nest.js 应用程序中使用存储机制，那么这个 npm 包将是一个不错的选择。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/anchan828-nest-storage-common