0.1.2 • Published 4 years ago

jdbx-t v0.1.2

Weekly downloads
1
License
ISC
Repository
github
Last release
4 years ago

What is this module?

This module is a simple local json database good for small projects and very simple games

Installation

npm install jdbx-t

Setup

const jdbx = require("jdbx-t");

jdbx.setup(__dirname)

Sets the main directory to Create the "data" folder that stores the collection

jdbx.setup(__dirname)

Create function

A function that accepts two parameters first for the initial data second for the collection name to create a collection

Usage

jdbx.create({ name: "test" }, "collection") // initial data, collection name

If you set the initial data to null

jdbx.create(null, "collection") // initial data to null

This will be returned

{
    "init": "collection"
}

Read functions

There is two types of this function

First

A function that accepts one parameter for the collection name to read the data from

jdbx.read("collection") // collection name

Second

A function that accepts two parameters first for the values to delete and second the collection name to return the data with this values

jdbx.readCondition({init:"collection"}, "collection") 
// data with these values, collection name 

ReadCondition() condition properties

_type property

_type:"all"

Gets all entries with the condition if specified if not will return the collection

_type:"one"

Gets The first entry from the condition if specified if not will return the first entry of the collection

_index property

_index:NUMBER

Gets The index of an entry from the condition if specified if not will return the index of the entire collection

Useage

jdbx.readCondition({name:"collection", _type:"all", _index:0}, "collection") 

How to get data from these functions?

First

let data = jdbx.read("collection")

Second

jdbx.read("collection", (err, data)=>{
    if(!err){
        console.log(data)
    }
})

Insert

Usage

A function that accepts two parameters first for the values to insert and second the collection name to insert it to the collection

jdbx.insert({data:"new Data"}, "collection")
// data to push, collection name

Insert() data object properties

_times

_times:NUMBER

Insert the data to the collection an amount of times default:1

Useage

jdbx.insert({name:"collection", _times:10, _index:0}, "collection") 

Update

Usage

A function that accepts two parameters first for the values to update and second the collection name to update the data in

jdbx.update({$fr:{name:"from"}, $to:{name:"to"}}, "collection")
// $fr a data already inserted $to replace the data with

Delete functions

There is two types of this function

First

A function that accepts one parameter the collection name to delete the collection

jdbx.deleteCollection("collection") // collection name 

Second

A function that accepts two parameters first the values to delete and second the collection name to delete the value from the collection

jdbx.deleteCondition({init:"collection"}, "collection")
// data to delete, collection name
0.1.2

4 years ago

0.1.1

4 years ago

0.1.0

4 years ago

0.0.9

4 years ago

0.0.8

4 years ago

0.0.7

4 years ago

0.0.6

4 years ago

0.0.5

4 years ago

0.0.4

4 years ago

0.0.3

4 years ago

0.0.2

4 years ago

0.0.1

4 years ago