esosdb

Description

You can easily create a database locally.

Do you want more detail? Check Docs

Contents

• Setup classic Database
  • set()
  • get()
  • delete()
  • push()
  • unpush()
  • getAll()
  • deleteAll()
• Setup advanced Database
  • ready
  • create()
  • deleteById()
  • findByElement()
  • findById()
  • updateById()

Badges

Install

npm i esosdb

Setup Classic Database

CommonJS

const { Database } = require("esosdb");
const db = new Database({
  path: "./esosdb/db.json", // this is default, can write the what you want
  space: 2, //should be a number (default:0)
});

EsModule

import { Database } from "esosdb";
const db = new Database({
  path: "./esosdb/db.json", // this is default, can write the what you want
  space: 2, //should be a number (default:0)
});

Examples

set

db.set("main", {}, (callback) => {
  console.log(callback); // logs the {main:{}}
});

db.set("main.name", "esosdb", (callback) => {
  console.log(callback); // logs the {name:"esosdb"}
});

db.set("main.version", "2.1.0", (callback) => {
  console.log(callback); // logs the {name:"esosdb",version:"2.1.0"}
});

get

console.log(db.get("main.name")); //logs the "esosdb"

delete

db.delete("main.version", (callback) => {
  console.log(callback); // logs the {name:"esosdb"} because version is deleted
});

push

db.push("main.dependencies", "fs", (callback) => {
  console.log(callback); // logs the {name:"esosdb",dependencies:["fs"]}
});

unpush

db.unpush("main.dependencies", "fs", (callback) => {
  console.log(callback); // logs the {name:"esosdb",dependencies:[]}
});

getAll

console.log(db.getAll()); // logs the {main:{name:"esos"}}

deleteAll

db.deleteAll((callback) => {
  console.log(callback); // logs the {}
});

Setup Advanced Database

CommonJS

const { AdvancedDatabase, CreateSchema } = require("esosdb");
const adb = new AdvancedDatabase({ name: "advanceddb", space: 2 });
const ExampleSchema = new CreateSchema({
  connect: adb,
  name: "exapmle",
  props: { name: { type: "string", required: true } }, //if you don't add any id then id will be generated randomly
  timestamps: true,
});

EsModule

import { AdvancedDatabase, CreateSchema } from "esosdb";
const adb = new AdvancedDatabase({ name: "advanceddb", space: 2 });
const ExampleSchema = new CreateSchema({
  connect: adb,
  name: "example",
  props: { name: { type: "string", required: true } }, //if you don't add any id then id will be generated randomly
  timestamps: true,
});

ready

ExampleSchema.on("ready", (data) => {
  console.log(data);
});

create

ExampleSchema.create({ name: "example" }, (callback) => {
  console.log(callback);
  /*
   {
      id:"uniqueId",
      name:"example",
      updatedAt: "1970-01-01T00:00:00.000Z",
      createdAt: "1970-01-01T00:00:00.000Z"
   }
   */
});

deleteById

ExampleSchema.deleteById("id", (callback) => {
  console.log(callback); //true or error
});

findByElement

ExampleSchema.findByElement({ name: "example" }, (callback) => {
  console.log(callback); //[...foundDatas]
});

findById

ExampleSchema.findById("uniqueId", (callback) => {
  console.log(callback);
  /*
  {
    name:"Example",
    //... 
  }
  */
});

updateById

ExampleSchema.updateById("id", { name: "example in the end" }, (callback) => {
  console.log(callback);
  /*
  //changes
  {
    name:"example in the end",
    updatedAt:"last edited"
  }
  */
});

esosdb