An amazing and simple json database
npm install hyper-jdb
npm i hyper-jdb
`
Table of contents
------------------
* Usage
* Methods
* set
* get
* has
* delete
* push
* add
* substract
* drop
* Help
* License
Usage
-------
`js
// Using Node.js require()
const hyperJDB = require('hyper-jdb');
// Using ES6 imports
import hyperJDB from 'hyper-jdb';
const database = new hyperJDB("users") // This will create the folder databases and the users.json file
`
Methods
-----
$3
Sets a value into the database.
`js
database.set("language", "english")
/*
{
"language": "english"
}
*/
// You can use dots to specify a new property
database.set("user1.name", "Álvaro")
/*
{
"language": "english",
"user1": {
"name": "Álvaro"
}
}
*/
`
$3
Gets an existing key from the database.
Returns the value of the given key.
`js
/*
{
"user1": {
"name": "Álvaro",
"age": 16
},
"user2": {
"name": "Juan",
"age": 20
}
}
*/
database.get("user1.name") // "Álvaro"
database.get("user2.age") // 20
`
$3
Searches the given key.
Returns true if it exists or false if not.
`js
/*
{
"user1": {
"name": "newalvaro9",
"hobbies": ["Gym", "Coding]
}
}
*/
database.has("user1.hobbies") // true
database.has("user1.age") // false
`
$3
Deletes an existing key from the database.
`js
/*
{
"user1": {
"name": "Álvaro",
"age": 16,
"hobbies": ["Gym", "Coding", "Cycling"]
}
}
*/
database.delete("user1.hobbies[1]") // Deletes Coding property as it is hobbies[1]
/*
{
"user1": {
"name": "Álvaro",
"age": 16,
"hobbies": ["Gym", "Cycling"]
}
}
*/
`
$3
Pushes to the given array a new value.
Returns the updated array.
`js
/*
{
"user1": {
"name": "Álvaro",
"age": 16,
"hobbies": ["Gym", "Coding", "Cycling"]
}
}
*/
database.push("user1.hobbies", "Climbing")
/*
{
"user1": {
"name": "Álvaro",
"age": 16,
"hobbies": ["Gym", "Coding", "Cycling", "Climbing"]
}
}
*/
`
$3
Adds to the given key the quantity provided (must be a Number).
Returns the updated key value.
`js
/*
{
"user1": {
"name": "Álvaro",
"money": 430
}
}
*/
// Adds 150 to 430 money property
database.add("user1.money", 150) // 580
/*
{
"user1": {
"name": "Álvaro",
"money": 580
}
}
*/
`
$3
Substracts from the given key the quantity provided (must be a Number).
Returns the updated key value.
`js
/*
{
"user1": {
"name": "Álvaro",
"money": 430
}
}
*/
// Substracts 240 from 430 money
database.add("user1.money", 240) // 190
/*
{
"user1": {
"name": "Álvaro",
"money": 190
}
}
*/
`
$3
Clears all the data in the .json file
`js
database.drop() // Clears the database
``