basementdb

BasementDB v1.0.3

BasementDB is a simple Node.js based database.

const db = require('basementdb')('./data');

db.field('authentication').user = 'banana';

console.log(
    db.field('authentication').user
); // banana

Installation

Install using NPM:

$ npm i -g npm
$ npm i --save basementdb

In Node.js:

// Require the BasementClient from basementdb
const basementdb = require('basementdb');

// Initialize a new database in directory './data'
let db = basementdb('./data');

API

.set(name)

• name <String>
• Returns: <Object>
  • set <Function>
  • field <Function>

A set is a collection of several fields. This creates a new folder in the previous one.

The functions set and field are recursively returned.

// Create a new set in the root directory
db.set('authentication')
// Returns:

.field(name)

• name <String>
• Returns: <Object>

License

MIT License

Copyright (c) 2019 Luca Joos

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.