@tope0001/txt.db

@tope0001/txt.db is a simple database package that utilizes text files for storage. It provides basic CRUD (Create, Read, Update, Delete) operations along with additional functionalities like backup and length calculation.

Installation

npm i @tope0001/txt.db fs

Using Database

Create new database

const { Database } = require('@tope0001/txt.db');
const db = new Database('path.txt');

Set the Settings

Settings.set({
    STTM: true, // true, false
    //This option is to save a copy of the data piece in your device's RAM while your project is running

    //API settings are under construction
});

//To show all settings you can write this
//await Settings.this;
//{ STTM: 'true/false' }

Set

db.set(`id`, 1);
db.set({ Key: `id`, Value: 1 });
/*
You can put these types at the top
string, number, boolean, object, array, bigint, undefined, null
*/

Get

db.get(`data`);

Delete

db.delete(`last_day`); //To delete the data

Has

db.has(`bay`, `what?`); //It will output if the key and value are true or false

Add

db.add(`ids`, 1); //If the peak is 10, it will become 11

Subtraction

db.add(`reps`, 1); //If the peak is 10, it will become 9

Push

db.push(`user_actions_1`, `login at 12:00 PM`); //To add something to a specific array

Pull

db.pull(`user_actions_2`, `login at 12:00 PM`); //To remove something to a specific array

Type

db.type(`number`); //If the value is a number, a number will appear

AllKeys

await db.allKeys(); //It will take out all the keys

AllValues

await db.allValues(); //It will take out all the values

All

await db.all(); //It will take out all the values

Backup

db.backup(`./backup.txt`); //A copy of the data base will be made on the same path

Length

db.length; //To know the number of items in the database

Reset

db.reset; //To reset the database

Settings

const { Settings } = require(`@tope0001/txt.db`);
Settings.set({
    STTM: false, // true, false
});
//STTM = Use a copy in the RAM cache

Using API

The API system is under construction and will be present in the next update.

License

This project is licensed under the ISC License. See the LICENSE file for details.