jsonlitedb v1.0.1

JSONliteDB

JSONliteDB is a “lite”weight, file-based database solution for prototype or small-scale implementations with an emphasis on extremely simple operation.

Installation

Using npm:

npm i jsonlitedb

Importing jsonlitedb to your Node Project:

const jsonlitedb = require(‘jsonlitedb’)

Usage

JSONliteDB currently features three external functions. All use similar parameters which will be described below:

colName: Collection Name Consider this the folder name for your data, it could be the ID for a discord server you’re documenting data for, the name of a sports team, etc.

docName: Document Name The name that this particular record will be under, think a specific event, user, etc.

data: the actual data! This will be the data you include with your PUSH requests.

The Functions

Here are the three external functions that JSONlitDB currently offers:

readCollectionData

The GET function, used to pull data already recorded to the database. You will have a JSON with your data returned.

This function has two mandatory parameters: 1. colName 2. docName

Example:

let serverId = 9021042069 
let docName = “bdayevent” 

readCollectionData(serverId, docName)

writeCollectionData

The PUSH function, used to record data to the database, you will have a status message returned on successful or unsuccessful writes. Note, this function also acts as an initializer for collections, if the collection name you provide is new, it will be created and your data will be written under that newly created collection.

This function has three mandatory parameters: 1. colName 2. docName 3. data

Example:

let serverId = 9021042069 
let docName = “bdayevent” 
let data = { Inuarashi: 100 } 

writeCollectionData(serverId, docName, data)

deleteCollectionData

The DELETE function, used to delete data from the database. you will have a status message returned on successful or unsuccessful deletions.

This function has two mandatory parameters: 1. colName 2. docName

Example:

let serverId = 9021042069 
let docName = “bdayevent” 

deleteCollectionData(serverId, docName)