Niodb 是一个简单的高性能本地 JSON 数据库。
安装
$ npm i niodb --save
例子
以下代码在一个空的example_data.json文件中创建了 Nio 数据库，并添加了一些键值对到数据库中。
import { Nio } from 'niodb' // 或 const { Nio } = require('niodb')
const db = await new Nio('example_data.json')
db.name = 'NioDB'
db.message = 'Hello NioDB!'
db.users = {
count: 100
}
db.users.count++
example_data.json 文件在代码运行之后将会变成：
{
"name": "NioDB",
"message": "Hello NioDB!",
"users": {
"count": 101
}
}
开始
设置 / 获取值
在数据库中设置值的方式和给 JavaScript 的对象设置值的方式一样：
import { Nio } from 'niodb'
const db = await new Nio()
db.key = 'value'
如果 filepath 是一个字符串，数据库中的数据将异步且原子地存储到指定的文件中。
获取一个键的值也非常简单：
console.log(db.key)
🌟 只需将 Nio 对象视作一个普通的 JavaScript 对象。
封装函数
或者，你可以使用封装函数 $set 和 $get 来做同样的事。
db.$set(key, value)
db.$get(key)
删除 / 检查一个键是否存在
就像在 JavaScript 对象中使用 delete 删除键和使用 in 关键字检查键是否存在一样:
delete db.key
console.log(key in db)
封装函数
db.$delete(key)
db.$exists(key)
API
Nio
new Nio(filepath, config):
每个 Nio 对象都是一个绑定到一个 json 文件的数据库：
const database = await new Nio(filepath, config);
Filepath - json 文件路径
如果 filepath 是一个字符串，new Nio(filepath) 返回一个 Promise 对象，这个对象将会返回一个 Nio 实例，所以你需要使用 await 关键字来获取这个 Nio 对象。
如果 filepath 是 undefined，它将会直接返回一个 Nio 对象，所以不需要使用 await 关键字。然而，为了保证代码的一致性，你总是应该在实例化 Nio 数据库时使用 await ，无论是否定义了 filepath。
Config - 配置对象
config 是可选的，它应该是一个 JavaScript 对象。
所有的配置如下：
await new Nio(filepath, { // 本地的 json 文件被更新时调用 transactionUpdated: () => {} })
封装函数
以下是所有的封装函数：
$set(key, value): 设置一个键的值。将值设置为undefined将会导致TypeError。$get(key): 获取一个键的值。$delete(key): 删除键。$exists(key): 如果键存在，返回 true。$randomKey(): 返回一个随机的键。$rename(key, newKey): 将键设置为一个新名称，如果新名称已被占用则替换。$type(key): 返回键中存储的值的数据类型。所有可能的返回值：array,object,null,number,string,boolean, 和undefined。
链式调用
你可以链式调用封装函数：
const db = await new Nio()
db.content = {
content1: 'hello',
content2: 'this is NioDB',
content3: 'you will like it'
}
db.content.$delete('content1').$rename('content2', 'introduction').$set('content3', true)
console.log(db)
数据库中的数据将会是：
{
content: {
content3: true,
introduction: 'this is NioDB'
}
}
错误处理
import { DatabaseError } from 'niodb'
测试 & 构建
$ npm test
$ npm build
评论