WELCOME TO JDB.JS

this page will discuss how to operate with JDB.JS

What is JDB.JS?

JDB.JS is meant to be a NoSQL JSON datbase that people could use

Dependencies

• fs

• path

Installation

• npm install @web_dev_guy/jdb-js

Linking to your Project Using NPM

• Import

  • import JDB from "@web_dev_guy/jdb-js";

• Require

  • const { JDB } = require("@web_dev_guy/jdb-js"); 

JDB Class -

This is the class which contains all the functions that you can use the first parameter is the name of your file you will be preforming CRUD on

const { JDB } = require("./JDB/JDB.js") or require("@web_dev_guy/jdb-js");

const jdb = new JDB("jsonfile"); 

// links to "jsonfile.json" in the JDBF folder

now we will disscuss the functions in the JDB class

• readData()-

  • this function reads the file that you have put as the parameter in the class's constructor.

• writeData(data : String)-

  • this function writes the data into the JDBF (Json DataBase Files) , this WILL delete the rest of the contents in the file. The syntax to writing the json data in this function and other like functions is '"key1" : "value1", "key2" : "value2"'.

• setData(key : String, value : String | Int)-

  • this is basically writeData, but it dosnt delete the existing contents and can only write new data once. It can also change the value of any key you put as the first param any time.

• getData(key : String)-

  • this function will get the value of the key which has the same name as the key param.

• addData(key : String, value: String | Int) -

  • this function appends data ("{key}" : "{value}") to the file instead of deleteing the already existing contents.

• addBigData(code : String | Int)-

  • this is just add function but you could add lines of JSON code.

• removeData(key : String)-

  • this function removes the key and its value from the JDBF code.

• removeAllData(brackets : Boolean)-

  • removes all the code from the file, if brackets is true, then the brackets will also be delete, else the brackets will.

• hasData(value : String | Int, returnBool : Boolean)-

  • returns the name of the key that contains the value that is equal to value if returnBool is false, else it returns a bool value.

• setKey(name : String, newname : String)-

  • changes the key's name from name to newname.

• replaceUrl(new_url : String)-

  • changes the url of the JDB class to the value of new_url.

• terminate()-

  • terminates the JDB code

• onReadData(callback(txt : String) : Function)-

  • after reading the JDBF and returning the json it will run the callback function that has the param of txt which contains the content of the JDB.

• onWriteData(words : String | Int, callback: Function)-

  • after writing the data it runs the callback function.

• onAddData(text : String | Int, callback : Function)-

  • its onWriteData but it dosnt delete the existing contents of the text.

• onRemoveData(name : String, callback : Function)-

  • when a key thats equal to name is removed, the the callback function triggers.

• limitData(by : Int)-

  • basically the LIMIT keyword in sql where by is the least amount of values returned. It returns the value in [{key : key_name}, {value : value_value }] format.

• keyExists(key : String)-

  • checks if key is a key in the JDBF, if its there than it returns true, else false.

• valueExists(value : String | Int)-

  • checks if value is a value in the JDBF, if its there than it returns true, else false.

• countData()-

  • returns the count of keys in a JDBF.

• whereKey(key : String)-

  • finds the key and returns its position in the JDBF.

• whereValue(value : String | Int)-

  • finds the value and returns its position in the JDBF.

• sortData(by : String, type : String)-

  • Sorts the keys or values, you can choose by changing the by param, in the JSON data based on the specified criteria thats in the type param.

JDB FileSystem -

there are also functions that you can use which are not inside of the JDB class, which are super useful.

CreateJDBF(name : String) -

• This creates a new JDBF in the JDBF folder which has {} as the starting content.

DestroyJDBF(name : String) -

• This destorys or deletes the JDBF from the JDBF folder.

IntegrateJDBF(oldf : String, newf : String)

• This moves the data from the file named oldf to the file named newf.

DuplicateJDBF(file : String, name : String) -

• This duplicates the file named file. then the duplicated file name is name.

HookJDBF(fileone : String, filetwo : String); -

• This makes filetwo always have the contents of fileone.

Syntax

const {CreateJDBF, DeestroyJDBF, IntegrateJDBF} = require("./JDB/JDB.js") or require("@web_dev_guy/jdb-js");

CreateJDBF("example"); // creates new JDBF called example

// ...

IntegrateJDBF("example", "main"); // moves data from example.json to main.json

HookJDBF("main", "main2"); // main is now hooked to main

Duplicate("main", "main_dup"); // duplicated main and renamed the duplicate to main_dup

DestroyJDBF("example"); // destroys the JDBF called example

Example Usage:

// Create a JDB file
CreateJDBF("example");

// Create a new JDB instance
const jdb = new JDB("example");

// Write data to the JDB file
jdb.writeData('"name" : "john", "age" : "twenty-two", "month_of_birth" : "jan"');

// Set a new value for a key in the JSON data
jdb.setData("name", "alex");

// Read and log data from the JDB file asynchronously
jdb.onReadData((data) => {
  console.log(data);
});

// Delete the JDB file
DestroyJDBF("example");

// Terminate the JDB instance
jdb.terminate();