Installation:

npm install kaitodb

Basic Usage:

const KaitoDB = require('kaitodb'); //requiring the package
const MyDb = new KaitoDB('test_db'); //creating new db
console.log(MyDb.version); //expected output: '2.6.0'
console.log(MyDb.name); //expected output: 'test_db'
console.log(MyDb.path); //expected output: './KaitoDataBases/test_db.json'
console.log(MyDb.get('test_key_string')); //expected output: undefined
MyDb.set('test_key_string', 'test_value'); //sets the key-value
console.log(MyDb.get('test_key_string')); //expected output: 'test_value'
console.log(MyDb.get('test_key_number')); //expected output: undefined
MyDb.set('test_key_number', 5); //sets the key-value
console.log(MyDb.get('test_key_number')); //expected output: 5
console.log(MyDb.get('test_key_boolean')); //expected output: undefined
MyDb.set('test_key_boolean', true); //sets the key-value
console.log(MyDb.get('test_key_boolean')); //expected output: true
console.log(MyDb.get('test_key_null')); //expected output: undefined
MyDb.set('test_key_null', null); //sets the key-value
console.log(MyDb.get('test_key_null')); //expected output: ''(may look empty in console)
console.log(MyDb.get('test_key_array')); //expected output: undefined
MyDb.set('test_key_array', ["test_value", 5, true, null]); //sets the key-value
console.log(MyDb.get('test_key_array')); //expected output: ["test_value", 5, true, null]
console.log(MyDb.all()); /*
expected output:
[
  { key: 'test_key_string', value: 'test_value' },
  { key: 'test_key_number', value: '5' },
  { key: 'test_key_boolean', value: 'true' },
  { key: 'test_key_null', value: '' },
  { key: 'test_key_array', value: '["test_value",5,true,null]' }
]
*/
MyDb.refresh(); //erases all datas
console.log(MyDb.all()); //expected output: []

Documentation:

<kaitodb> will be count as MyDb in the Basic Usage code.

<kaitodb>.version

type: string

<kaitodb>.name

type: string

<kaitodb>.path

type: path

<kaitodb>.get(key)

type: function(returns: string || number || array || boolean)

value placement: <key>= the name of the value that will be catched from the database(type: string)

<kaitodb>.set(key, value)

type: function(returns: number(returning 0 means completed unsuccessfully and 1 means completed successfully))

value placement: <key>= the name of the value that will be catched from the database(type: string) <value> = the key that will be the value of the <key> in database(type: string || number || array || boolean || null(it count as empty string))

<kaitodb>.refresh()

type: function(returns: undefined)

<kaitodb>.all()

type: function(returns: array)

Future Ideas:

• .env formated database: the idea is to make a db using env file format to store data to make it secure with the public file hosts
• non-node support a kaitodb module alternative that can be used with <script> tag that not requires node
• alternative language support making kaitodb more popular by making a module for other languages too but sadly by far the most hard one to become real but if it will be then probably will be c#(.cs) or python(.py) because the usage popularity

Credits:

Only me kaito_turkish_boi for now.