a light module to store data in easy way for beginners in `JSON` format
npm install @molo_7/db.jsonJSON format, fast, simple and powerfull.
< string | number | bigint | boolean | symbol | undefined | object | function | array >
ps
npm install db.json
`
$3
`js
const Database = require("db.json"); // Constructor
const db = new Database("test.json"); // create new json storage file
`
new Database(filename)
- passing file name or file path is required
- file format must be json !
- If the file dosen't exist, it will create it
$3
easly create multiple storage files
`js
const Database = require("db.json");
const users = new Database("users.json");
const guilds = new Database("guilds.json");
users.set("user_1", {
id: 1,
name: "Jhon Doe",
ownGuilds: [],
});
let userOne = users.get("user_1");
// -> { id: 1, name: "Jhon Doe", ownGuilds: [] }
guilds.push("guilds", {
name: "new Guild",
owner: userOne,
});
guilds.fetchAll("guilds");
// -> { guilds: [ { name: "new Guild", owner: { id: 1, name: "Jhon Doe" } } ] }
users.push("user_1.ownGuilds", "new Guild");
`
---
Properties
$3
returns the db entries length
Example
`js
console.log(total entries: ${db.entries});
`
$3
returns the file size in bytes
`js
db.set("foo", "bar");
console.log(db.size); // 13 bytes
`
---
Methods
$3
Sets a key-value to db!
| Name | Type | Required | Description |
| ----- | ------ | -------- | ----------- |
| Key | String | true | Key |
| Value | Any | true | Data |
Example
`js
// set any datatype !
db.set("userProfile", { username: "jhon doe", views: 10 });
db.set("userProfile.bigint", BigInt(9007199254740991));
db.set("userProfile.getViews", function getViews() {
return this.views;
});
`
$3
returns the value of a key
| Name | Type | Required | Description |
| ---- | ------ | -------- | ----------- |
| Key | String | true | Key |
To complete the previous example
`js
let userProfile = db.get("userProfile");
// -> { username: 'jhon doe', views: 10, bigint: 9007199254740991n, getViews: [Function: anonymous] }
console.log(userProfile.getViews());
// -> 10
`
$3
returns 2d array with n number of random unique entries, by default returns 1 entry
| Name | Type | Required | Default | Description |
| ---- | ------ | -------- | ------- | ------------------------ |
| n | Number | false | 1 | number of random entries |
Eample
`js
db.set("one", 1);
db.set("two", 2);
let randomEntries = db.random(2); // array with 2 unique random entry
console.log(randomEntries);
// -> [["one", 1], ["two", 2]]
console.log(
"First Random Entry",
"key: " + randomEntries[0][0],
"value: " + randomEntries[0][1]
);
`
$3
returns the type of key,
datatypes : < "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function" | "array" >
| Name | Type | Required | Description |
| ---- | ------ | -------- | ----------- |
| Key | String | true | Key |
Exmaple
`js
db.set("myBigint", BigInt(9007199254740991));
db.set("mySymbol", Symbol("symboool"));
db.set("myFunction", (msg) => console.log(msg));
console.log(db.typeOf("bigint"));
// -> bigint
console.log(db.typeOf("mySymbol"));
// -> symbol
console.log(db.typeOf("myFunction"));
// -> function
`
$3
checks if the db has key, returns Boolean
| Name | Type | Required | Description |
| ---- | ------ | -------- | ----------- |
| Key | String | true | Key |
Exmaple
`js
db.set("foo", "bar");
console.log(db.has("foo"));
// -> true
`
$3
Pushs to Array, if typeof key wasn't array, automatically convert it to array and append the new value.
and returns array length
| Name | Type | Required | Description |
| ----- | ------ | -------- | ----------- |
| Key | String | true | Key |
| Value | Any | true | Data |
Example
`js
db.push("items", "new item");
console.log(db.get("items"));
// -> [ "new value" ]
db.set("myWepon", "Pistol");
console.log(db.get("myWepon"));
// -> Pistol
db.push("myWepon", "Riffle");
console.log(db.get("myWepon"));
// -> ["Pistol", "Riffle"]
`
$3
search keys that starts with or ends with str, returns array with the matched keys otherwise returns empty array
| Name | Type | Required | Description |
| ---- | ------ | -------- | ---------------- |
| Str | String | true | string to search |
Example
`js
db.set("user_a", "jhon 1");
db.set("user_b", "jhon 2");
db.set("abba", "someText");
let keysStartsWithUser = db.startsWith("user");
let keysEndsWithA = db.endsWith("a");
console.log(keysStartsWithUser);
// -> ["user_a", "user_b"]
console.log(keysEndsWithA);
// -> ["user_a", "abba"]
`
$3
removes key from db, returns Boolean
no difference between remove() and delete()
| Name | Type | Required | Description |
| ---- | ------ | -------- | ----------- |
| Key | String | true | Key |
Exmaple
`js
db.set("foo", "bar");
console.log(db.remove("foo"));
// -> true
console.log(db.remove("foo"));
// -> false
`
$3
returns everything from the db as a Javascript object
Exmaple
`js
let allData = db.fetchAll();
console.log(allData);
`
$3
clears everything in the db
Exmaple
`js
db.clear();
console.log("Everything Has Been Cleared");
``