在线时间:8:00-16:00
迪恩网络APP
随时随地掌握行业动态
扫描二维码
关注迪恩网络微信公众号
开源软件名称:Belphemur/node-json-db开源软件地址:https://github.com/Belphemur/node-json-db开源编程语言:TypeScript 99.8%开源软件介绍:
InstallationAdd yarn add node-json-db DocumentationInner WorkingDataThe module stores the data using JavaScript Object directly into a JSON file. You can easily traverse the data to reach directly the interesting property using the DataPath. The principle of DataPath is the same as XMLPath. Example{
test: {
data1 : {
array : ['test','array']
},
data2 : 5
}
} If you want to fetch the value of array, the DataPath is /test/data1/array To reach the value of data2 : /test/data2 You can of course get also the full object test : /test Or even the root : / UsageSee test for more usage details. import { JsonDB } from 'node-json-db';
import { Config } from 'node-json-db/dist/lib/JsonDBConfig'
// The first argument is the database filename. If no extension, '.json' is assumed and automatically added.
// The second argument is used to tell the DB to save after each push
// If you put false, you'll have to call the save() method.
// The third argument is to ask JsonDB to save the database in an human readable format. (default false)
// The last argument is the separator. By default it's slash (/)
var db = new JsonDB(new Config("myDataBase", true, false, '/'));
// Pushing the data into the database
// With the wanted DataPath
// By default the push will override the old value
db.push("/test1","super test");
// It also create automatically the hierarchy when pushing new data for a DataPath that doesn't exists
db.push("/test2/my/test",5);
// You can also push directly objects
db.push("/test3", {test:"test", json: {test:["test"]}});
// If you don't want to override the data but to merge them
// The merge is recursive and work with Object and Array.
db.push("/test3", {
new:"cool",
json: {
important : 5
}
}, false);
/*
This give you this results :
{
"test":"test",
"json":{
"test":[
"test"
],
"important":5
},
"new":"cool"
}
*/
// You can't merge primitive.
// If you do this:
db.push("/test2/my/test/",10,false);
// The data will be overriden
// Get the data from the root
var data = db.getData("/");
// From a particular DataPath
var data = db.getData("/test1");
// If you try to get some data from a DataPath that doesn't exists
// You'll get an Error
try {
var data = db.getData("/test1/test/dont/work");
} catch(error) {
// The error will tell you where the DataPath stopped. In this case test1
// Since /test1/test does't exist.
console.error(error);
};
// Deleting data
db.delete("/test1");
// Save the data (useful if you disable the saveOnPush)
db.save();
// In case you have a exterior change to the databse file and want to reload it
// use this method
db.reload(); TypeScript Supportv0.8.0As of v0.8.0, TypeScript types are
included in this package, so using v1.0.0JsonDB isn't exported as default any more. You'll need to change how you load the library. This change is done to follow the right way to import module. import { JsonDB } from 'node-json-db';
import { Config } from 'node-json-db/dist/lib/JsonDBConfig'
const db = new JsonDB(new Config("myDataBase", true, false, '/')); TypingWith TypeScript, you have access to a new method: getObject that will take care of typing your return object. import { JsonDB } from 'node-json-db';
import { Config } from 'node-json-db/dist/lib/JsonDBConfig'
const db = new JsonDB(new Config("myDataBase", true, false, '/'));
interface FooBar {
Hello: string
World: number
}
const object = {Hello: "World", World: 5} as FooBar;
db.push("/test", object);
//Will be typed as FooBar in your IDE
const result = db.getObject<FooBar>("/test"); Array SupportYou can also access the information stored into arrays and manipulate them. import { JsonDB } from 'node-json-db';
import { Config } from 'node-json-db/dist/lib/JsonDBConfig'
// The first argument is the database filename. If no extension, '.json' is assumed and automatically added.
// The second argument is used to tell the DB to save after each push
// If you put false, you'll have to call the save() method.
// The third argument is to ask JsonDB to save the database in an human readable format. (default false)
const db = new JsonDB(new Config("myDataBase", true, false, '/'));
// This will create an array 'myarray' with the object '{obj:'test'}' at index 0
db.push("/arraytest/myarray[0]", {
obj:'test'
}, true);
// You can retrieve a property of an object included in an array
// testString = 'test';
var testString = db.getData("/arraytest/myarray[0]/obj");
// Doing this will delete the object stored at the index 0 of the array.
// Keep in mind this won't delete the array even if it's empty.
db.delete("/arraytest/myarray[0]"); Appending in Array// You can also easily append new item to an existing array
// This set the next index with {obj: 'test'}
db.push("/arraytest/myarray[]", {
obj:'test'
}, true);
// The append feature can be used in conjuction with properties
// This will set the next index as an object {myTest: 'test'}
db.push("/arraytest/myarray[]/myTest", 'test', true); Last Item in Array// Add basic array
db.push("/arraytest/lastItemArray", [1, 2, 3], true);
// You can easily get the last item of the array with the index -1
// This will return 3
db.getData("/arraytest/lastItemArray[-1]");
// You can delete the last item of an array with -1
// This will remove the integer "3" from the array
db.delete("/arraytest/lastItemArray[-1]");
// This will return 2 since 3 just got removed
db.getData("/arraytest/lastItemArray[-1]"); Count for Array//
db.push("/arraytest/list", [{id: 65464646155, name: "test"}], true);
// You can have the number of element, in this case = 1
let numberOfElement = db.count("/arraytest/list"); Get Index in Array// You can have the current index of an object
db.push("/arraytest/myarray", {id: 65464646155, name: "test"}, true);
db.getIndex("/arraytest/myarray", 65464646155);
// By default, the property is 'id'
// You can add another property instead
db.getIndex("/arraytest/myarray", "test", "name");
// It's useful if you want to delete some object
db.delete("/arraytest/myarray[" + db.getIndex("/arraytest/myarray", 65464646155) + "]"); Nesting in Array// You can easily access any nested array and their object
//You can also append to nested array other array
db.push("/arraytest/myarray",
[
[
{
obj: 'test'
},
{
obj: 'hello'
}
],
[
{
obj: 'world'
}
]
]
, true);
//This will return the first object (obj: 'test')
db.getData("/arraytest/myarray[0][0]"); Exception/ErrorType
Errors
Limitations
Object with |
Jamie Davis |
2023-10-27
2022-08-15
2022-08-17
2022-09-23
2022-08-13
请发表评论