Donkey-DB

The dumbest db you'll ever see

Installation

npm install --save donkey-db

Usage

const DonkeyDB = require('donkey-db');

const db = new DonkeyDB('donkey-database'); // can be set to any filename/path (even none)

db.save('my money', 0);     // based on a true story
db.save('my money', 20);    // got money (somehow)
db.get('my money');         // 20

Documentation

DonkeyDB Class

save

Saves JSON data to a specific key

db.save(key, data); // key:string, data:any (has to be stringifyable with JSON)
// returns boolean (successful or not)

get

Gets the data of a key

db.get(key); // key:string
// returns any (undefined if not available)

has

Checks if key exists

db.has(key); // key:string
// returns boolean (if it exists or not)

fetch

Fetches the entire database

db.fetch();
// returns Object ({key1: data, key2: data})

clean

Cleans up the database (less storage usage)

db.clean();

readDB

Literally reads the DB (not required for usage)

db.readDB();
// returns array<string>

path

Gives the path to the database file

db.path();
// returns string (path of file)

filename (static)

Helper function for generating a path to file (not required for usage)

DonkeyDB.filename(file); // file:string (relative (to cwd) or absolute path to file)
// returns string (path to file)
// default: "{cwd}/db.donk"

parseSingle (static)

Parses a donkey string into usable data (not required for usage)

DonkeyDB.parseSingle(data, parse) // data:string, parse:boolean (if true, JSON.parse-s the data)