Ready.db is here for you!

make editing your database simpler using ready.db, have readable json as your database instead of nonsense file types that may break many code editors!

🔌 Getting Started

• we will start by installing the package

npm i ready.db

• We will define our database using the following;

const { Database } =  require('ready.db')

const  db  =  new  Database(/* file.json */)

a file name is highly suggested tho readyDB will create one if not mentioned.

🖌 Adding data

db.set will set the data of an object overwriting anything in the past.

//object use case
var  object1  = {key: true, key2: "true"}
db.set('Object', object1);

//regular use case
var  client  = {
userName: "alexander",
passcode: "testPass1"
}
db.set(`${client.userName}_password`, client.passcode);

db.push will push the settings whom you changed into an array, and the part you didn't change will remain the same.

Array: ['element', 'element2', 'element3']
db.push(Array, element2); 

this will only push changes to element2

and lastly for this section, db.add will add a number to another number (negatives aswell)

db.add('data', 1); // Adds one to the data
db.add('data', -1); // removes one from the data

📜 fetching data from the database

we use db.get and db.fetch to recieve data of an element, not an array.

db.get('data'); // Get the value of the data
db.fetch('data'); // Fetches the value of the data

Meanwhile you can use other methods to fetch arrays and objects

db.objectFetch('Object', 'key'); /* key: "value1" */
db.arrayFetch('Array', 1); /* element2 */

you can use db.all to get all the data from the base.

db.fetchAll(); // Fetches all the data in the database
db.all(); // Fetches everything in the database

🔥 Destruction in ready.db

We wont go over this very much as its quite simple.

db.remove('data'); // Removes the data from the database
db.delete('Array', 'element3'); // Removing something from an array using value/index
db.deleteKey('object', 'key'); // Deletes the provided key from the given object
db.deleteEach('data'); // Deletes each data that starts with the given parameter

meanwhile note that you can destroy an entire database simply.

db.clear(); // Clears everything from the database
db.destroy(); // Delete the database file (And Clear All Data)

🚩 Booleans in ready.db

you can use db.has to check if data exists in ready.db

db.has('data'); // Returns "true" or "false" if the database has the data or not.

🌌 Backups in ready.db

you can backup your data using db.setbackup

db.setBackup('backup.json') // Set "backup.json" as the backup file

and load it using db.loadbackup

db.loadBackup(); // Loads the backup from the backup file (setBackup) function