plusdb
TypeScript icon, indicating that this package has built-in type declarations

0.1.4 • Public • Published

PlusDB

plusdb npm version install size npm downloads GitHub License Discord

Simple, convenient JSON database for nodejs.

Released v0.1.4 now.


Getting Started

Installing the npm package

$ npm install plusdb

Usage of plusdb

const { Database } = require("plusdb");
const db = new Database("myDataBase");

Documentation

  • new plusDB(settings)
    • add(id, value)
    • all()
    • clear()
      • reset()
    • delete(id)
      • remove(id)
    • get(id)
      • fetch(id)
    • has(id)
    • push(id, value)
    • set(id, value)
    • subtract(id, value)
  • DatabaseError

new plusDB(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.spaces - The spaces of the database file
  • Throws: DatabaseError() - If there are no settings or any settings are invalid

Methods

add(id, value)

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

all()

Return the all data on the database

  • Returns: Object - The all data

clear(id)

Deletes all the data in database / .reset() method is same

  • Returns: true - Indicates that it was cleared

delete(id)

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

get(id)

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

has(id)

Checks for data in the database

  • Params:
    • id - The ID of the element
  • Returns: Boolean - Indicates presence
  • Throws: DatabaseError() - If the ID is invalid

push(id, value)

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

set(id, value)

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 or value is invalid

subtract(id, value)

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

Package Sidebar

Install

npm i plusdb

Weekly Downloads

5

Version

0.1.4

License

MIT

Unpacked Size

25.9 kB

Total Files

8

Last publish

Collaborators

  • asimeren