jstore

An easy way for lightweight storage via a JSON file.

Installation

npm install jstorejs

Getting started

const jst = require('jstorejs'); //Require jstore
/**
* Create a new jstore instance.
* If the file does not exist, jstore will create a new file with a black JSON.
*/
var db = new jst.jstore('/path/to/db.jst'); 

jstore.insert(table, obj)

/**
* Inserts a given object into the given table.
*/
db.insert('members', {
   name: 'foo',
   access: '1'
})

jstore.search(table, query)

/**
* Search in table "tablename" with the given query.
* In this example "name" is a column in the databse.
* It will search in the table for items with the exact value in the given column.
*/
db.search('members', {
   name: 'foo'
});

//Now it will search for items with access greater than 0.
db.search('members', {
   access: {
      query: jstore.greaterThan,
      value: 0
   }
})

jstore.remove(table, query)

/**
* Removes items that fulfil the given query in the given table.
*/
db.remove('members', {
   access: {
      query: jstore.lessThan,
      value: 2
   }
})

db.remove('members', {
   name: 'foo'
})

jstore.refresh()

/**
*  Refreshes the database to what is inside the database file.
*/
db.refresh();

jstore.pushDb()

/**
* Saves the database into the file.
* THIS IS NOT REQUIRED, as the database is saved everytime
* a change is made (removes, inserts).
*/
db.pushDb();

License

MIT License

Copyright (c) 2017 Andrés Sánchez

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.