




> Simple, convenient JSON database for nodejs.
Version 1.0.3, splice seems to be working fine.
Getting Started
Installing the npm package
``
console
$ npm install nope.db-nl
`
Usage of nope.db
`
js
const nopedb = require("nope.db-nl");
const db = new nopedb({
path: "./path/of/database.json",
seperator: ".", // optional
spaces: 2 // optional
});
``
Documentation
-
Getting Started
-
Documentation
-
new nopeDB(settings)
-
Methods
-
add(id, value)
-
all()
-
clear(id)
-
delete(id)
-
get(id)
-
has(id)
-
push(id, value)
-
splice(id,index)
-
set(id, value)
-
subtract(id, value)
-
DatabaseError
new nopeDB(settings)
Creates or gets a database file
-
Params:
-
settings - An object with the settings
-
settings.path - The path of the database (must be an absolute path / the folder should be created)
-
settings.seperator - Seperator for the ID's (Default: ,)
-
settings.spaces - The spaces of the database file (Default: 2)
-
Throws: DatabaseError() - If there are no settings or any settings are invalid
Methods
$3
Adds the value of an element in the database
-
Params:
-
id - The ID of the element
-
value - The value to be added
-
Returns: Number - Result
-
Throws: DatabaseError() - If the ID or value is invalid
$3
Return the all data on the database
-
Returns: Object - The all data
$3
Deletes all the data in database /
.reset() method is same
-
Returns: true - Indicates that it was cleared
$3
Deletes element from database /
.remove() method is same
-
Params:
-
id - The ID of the element
-
Returns: Boolean - Indicates that it was deleted
-
Throws: DatabaseError() - If the ID is invalid
$3
Gets the element on the database /
.fetch() method is same
-
Params:
-
id - The ID of the element
-
Returns: * - The data
-
Throws: DatabaseError() - If the ID is invalid
$3
Checks for data in the database
-
Params:
-
id - The ID of the element
-
Returns: Boolean - Indicates presence
-
Throws: DatabaseError() - If the ID is invalid
$3
Pushs the data in a array from database
-
Params:
-
id - The ID of the element
-
value - The pushed element
-
Returns: Array - The array of the ID
-
Throws: DatabaseError() - If the ID or value is invalid
$3
Splices the data in a array from database
-
Params:
-
id - The ID of the element
-
index - The index number to splice
-
Returns: Array - The updated array
-
Throws: DatabaseError() - If the ID is invalid
$3
Sets the value of an element in the database
-
Params:
-
id - The ID of the element
-
value - The value to be setted
-
Returns: * - The value setted
-
Throws: DatabaseError() - If the ID is invalid
$3
Subtracts the value of an element in the database
-
Params:
-
id - The ID of the element
-
value - The value to be subtract
-
Returns: Number - Result
-
Throws: DatabaseError() - If the ID or value is invalid
-
DatabaseError
Extends
Error, only used for error reference