moov-database

Database

A simple json database storage.

Get Started

Install the package

$ [sudo] npm install --save moov-database

Basic Usage

const db = require('moov-database')
 
db
  .setFile('path/to/your/db.json')
  .add('user', 'uselessdev')
  .store()

API

.setFile(path/to/your/database.json)

The setFile method allow you to set a path for one database per time.

//...
 
db.seFile('./users.json')
 
console.log(db.database) // ./users.json
 

.add(key, value)

Using the add method you can push a new data to your database

//...
 
db.add('username', 'donkey')
db.add('useremail', '[e-mail]')
 
// Or you can chain methods...
 
db
  .add('username', 'donkey')
  .add('useremail', '[e-mail]')
 
console.log(db.data) // {username: 'donkey', useremail: '[e-mail]'}
 

.massive()

Using the massive method you can store an whole object at once to your database

//...
 
db.massive({
  users: [
    {name: 'donkey', email: '[e-mail]'},
    {name: 'cow', email: '[e-mail]'}
  ]
})
 
console.log(db.data)
// {
//    users: [
//      {name: 'donkey', email: '[e-mail]'},
//      {name: 'cow', email: '[e-mail]'}
//    ]
// }

.store()

The store method will save the stored data in to a .json file

//...
 
db.store()

.get()

Using the get method you can retrieve all data stored in database, or you can retrieve a single result by passing his key name

//...
 
db.get('users')
// [
//   {name: 'donkey', email: '[e-mail]'},
//   {name: 'cow', email: '[e-mail]'}
// ]
 

Example:

 
const database = require('moov-database')
const db = database.setFile('./users.json')
 
db
  .massive({
    users: [
      {name: 'donkey', email: '[e-mail]'},
      {name: 'cow', email: '[e-mail]'}
    ]
  })
  .add('count_users', db.get('users').length)
  .store()
 
db.get()
// will return
//
// {
//    users: [
//      {name: 'donkey', email: '[e-mail]'},
//      {name: 'cow', email: '[e-mail]'}
//    ],
//    count_users: 2
// }
//
//
 

CHANGELOG

changelog

CONTRIBUTING

contributing

LICENSE

MIT