0.0.2 • Published 2 years ago
kow-db v0.0.2
Welcome
Click here to jump to help table.
Installation
Using yarn:
yarn add kow-dbUsing npm:
npm install kow-dbHow to import
Using esm:
import KowDB from "kow-db";Using commonjs:
const KowDB = import("kow-db").then((db) => db.default);
// This method returns a promiseKow DB
Fast promise json database.
Methods
Database~load
load database
Returns:
Promise<void>Usage
await db.load();Database~save
Save values in database json
Returns:
Promise<boolean>Usage
await db.save();Database~add
Add value to specified data
Returns:
Promise<boolean> | booleanUsage
db.add("some stuff", "data name"); // No save
await db.add("some stuff", "data name", true); // Save, returns promiseDatabase~remove
Add value to specified data
Returns:
Promise<boolean> | booleanUsage
db.remove({ id: 1234 }, "data name"); // No save
await db.remove({ id: 1234 }, "data name", true); // Save, returns promiseDatabase~createData
Creates data
Returns:
DatabaseUsage
db.createData("data name", "data type");Database~deleteData
Deletes data
Returns:
DatabaseUsage
db.deleteData("data name");Database~control
Control data and returns a value
Returns:
TUsage
db.control((json) => {
const value = json.data.findWhere({
name: "users"
}).values.findWhere({
id: 630493603575103519
});
return value;
}); // { name: "snowie", id: 630493603575103519 }Example
import KowDB from "kow-db";
const db = new KowDB({
path: "./example.json",
humanReadable: true
});
db.load().then(async () => {
db.create("test", "object");
db.add({
id: 1234,
value: "test"
}, "test");
db.control((json) => json.data.findWhere({
name: "test"
}).values.findWhere({
id: 1234
})) // { id: 1234, name: "test" }
await db.save();
})ValueArray
Custom array created for database
Methods
Methods includes normal array methods
ValueArray~findWhere
Find value in array and return it
Returns:
TUsage:
va.findWhere({ id: 1234 });ValueArray~findWhereAndDelete
Find value in array delete it
Returns:
TUsage:
va.findWhereAndDelete({ id: 1234 });ValueArray~findWhereAndUpdate
Find value in array and update it
Returns:
TUsage:
va.findWhereAndUpdate({ id: 1234 }, { name: "snow" });ValueArray~update
Update value in array
Returns:
booleanUsage:
va.update(0, { name: "snow" });ValueArray~normalize
Removes repeated items in array
Returns:
ValueArrayUsage:
va.normalize();ValueArray~clone
Clone value array and return clone
Returns:
ValueArrayUsage:
va.clone();ValueArray~toSet
Transform value array in set and returns it
Returns:
Set<T>Usage:
va.toSet();Example
import { ValueArray } from "kow-db";
const va = new ValueArray(...[{
id: 1234,
name: "leo"
}, {
id: 5678,
name: "snowie"
}]);
va.findWhere({
id: 5678
}) // { name: "snowie", id: 1234 }