Local json database.
npm install sagdbbash
$ npm install sagdb
`
Usage
`js
//JavaScript version
const Sagdb = require("sagdb").default;
`
`ts
//TypeScript version
import Sagdb from "sagdb";
`
- Default database name is "db".
- Db name and folder name is must be String.
- Database folder name is optional.
- If you want readable database, set "minify" to false.
`js
const db = new Sagdb({ name: "database", folder: "foldername", minify: true });
`
`js
const db = new Sagdb({ name: "database", folder: "folder/database" });
`
`js
const db = new Sagdb({ name: "database" });
`
Method's
set
- Set any value with key.
`js
db.set("key", "apple"); // -> apple
`
> Can't set Function.
`js
function test() {}
db.set("key", test); // -> return Error
`
get
- Get any value with key.
`js
db.set("key", "apple"); // -> apple
db.get("key"); // -> apple
`
update
- Update get a callback function, give old data and return must be a same type old data.
`js
db.update("key", (old_data) => {
const new_data = old_data.toUpperCase();
return new_data;
});
`
delete
- Delete any key from database.
`js
db.set("key", "apple"); // -> apple
db.delete("key"); // -> apple
db.get("key"); // -> undefined
`
add
- Add number to number value.
- Value must be a Number.
- Default number is 1.
`js
db.set("number", 1); // -> 1
db.get("number"); // -> 1
db.add("number", 3); // -> 4
db.get("number"); // -> 4
db.add("number"); // -> 5
db.get("number"); // 5
db.add("number", "asd"); // return false
`
Extra
U can set object in object.
`js
db.set("key.value", "apple"); // -> apple
db.get("key"); // -> { value : "apple" }
`
Table
`ts
import Sagdb, { Table } from "sagdb";
const db = new Sagdb({ name: "database" });
const table = new Table(db, "table_name");
`
add
`ts
table.add(1); // -> {_id: "uuid", data: 1, createdAt: number, updatedAt: number}
`
find
`ts
table.find(callback | data_object); // -> {_id: "uuid", data: 1, createdAt: number, updatedAt: number} | undefined
`
findById
`ts
table.findById("uuid"); // -> {_id: "uuid", data: 1, createdAt: number, updatedAt: number} | undefined
`
update
`ts
table.update(callback | data_object, new_data, force?: boolean); // -> {_id: "uuid", data: 1, createdAt: number, updatedAt: number} | undefined
`
filter
`ts
table.filter(callback | data_object, new_data); // -> old_data: {_id: "uuid", data: 1, createdAt: number, updatedAt: number}[] | undefined
`
remove
`ts
table.update(callback, all?: boolean); // -> {_id: "uuid", data: 1, createdAt: number, updatedAt: number} | undefined
`
Listeneer's
On
`ts
table.on("event_name", callback()); // -> Listening.
`
_Example_
`ts
table.on("add", callback(new_data));
table.on("update", callback(old_data, new_data));
table.on("remove", callback(old_data));
``