Skip to content

@neosjs/node-db ​

Node.js 环境下的 JSON 文件数据库,基于 lowdb 的 FileSync 适配器封装。以键值对的形式将数据持久化到本地 JSON 文件,无需额外数据库服务,适合 Electron、脚本、小型 Node 应用的轻量数据存储场景。

安装 ​

sh
pnpm add @neosjs/node-db
sh
npm i @neosjs/node-db
sh
yarn add @neosjs/node-db

快速上手 ​

包导出的是一个单例实例,先调用 start 初始化数据库,再进行读写:

js
const db = require('@neosjs/node-db')

// 初始化:会在指定目录下创建 Database 目录和 db.json 文件
db.start('/Users/neosjs/appData')

ESM 方式引入:

js
import db from '@neosjs/node-db'

await db.start('./data')

读写数据:

js
// 写入数据(key 不存在则创建)
db.addData('token', 'xxxx-xxxx')
db.saveData('userInfo', { name: 'neosjs', role: 'admin' })

// 读取数据
const token = db.findData('token')
const userInfo = db.findData('userInfo')

API ​

初始化(start)之前或初始化失败时,读写方法会返回空字符串 ''。

方法参数说明
start(filePath)filePath: string 目录路径初始化数据库。在 filePath 下创建 Database 目录与 db.json 文件,并写入默认数据结构
findData(key)key: string根据 key 查询数据,返回对应的值
addData(key, value)key: string, value: any新增数据并写入文件
saveData(key, value)key: string, value: any保存数据(key 存在时覆盖),写入文件

TIP

数据以 JSON 格式落盘,db.json 可以直接用文本编辑器查看;每次写入都会同步(write())到文件。