icelake.db

1.0.0 • Public • Published

header

Icelake.db

A simple JSON based Asynchronous database made for Node.js

So, what is Icelake.db?

Icelake.db is a simple, JSON based, extremely fast and easy to use database, for Node.js. So, is this just another database? Nope, Icelake is completely different and wanted to keep things simple. Icelake is growing day by day and I am working each day trying to make it faster. If you want to help (Please do) Drop a PR! And join our Discord server to get that shiny "contributer" role

Advantages -

  • Extremely easy to use syntax
  • Very fast and gets data instantly, with only having graceful-fs as its dependency, the package size is tiny
  • VERY light weight - Have size phobia? Sure! Icelake.db is perfect for you then!
  • Icelake.db is NOT a wrapper, and Icelake.db doesn't need C++ Bindings or Python installed!😀
  • Works perfectly on Repl.it and Glitch :)
  • You can export and import databases anytime, anywhere making switching folders or switching devices a piece of cake! 🍰
  • Don't like unreadable DB files and want to read and analyze your database at any time? Sure! The DB files of Icelake.db are in JSON and make reading and inspecting data very easy :)
  • Migrating from Enmap or Quick.db? Follow our migration guide! The very easy and simlier syntax of Icelake.db makes migration very easy

Docs -

set(key, value)

Use this to set a key, example -

const ice = require("Icelake.db");
const exampledb = new ice.db("Example");

exampledb.set("Icelake.db", "Very cool :)")

get(key, optionalindex)

Use this to fetch a key from the database, example -

const ice = require("Icelake.db");
const exampledb = new ice.db("Example");

// exampledb.set("Cookies", 50)
exampledb.get("Cookies") // 50
// exampledb.set("Cakes", {"Chocolate" : 5, "Vanilla" : 10, "No toppings" : 7, "No eggs" : 3})
exampledb.get("Cakes", "Chocolate") // 5

has(key)

Use this to check if a key exists in the database, example -

const ice = require("Icelake.db");
const exampledb = new ice.db("Example");

// exampledb.set("Cookies", 50)
exampledb.has("Cookies") // true
// Lets try with a key that doesn't exist in the DB
exampledb.has("Chocolate Cookies") // false

delete(key)

Use this to delete a key from the database, example -

const ice = require("Icelake.db");
const exampledb = new ice.db("Example");

// exampledb.set("Cookies", 50)
exampledb.has("Cookies") // true
exampledb.delete("Cookies")
exampledb.has("Cookies") // true

inc(key, optionalamount)

Use this to increment a key, example -

const ice = require("Icelake.db");
const exampledb = new ice.db("Example");

// exampledb.set("Cookies", 50)
exampledb.inc("Cookies")
exampledb.get("Cookies") // 51
exampledb.inc("Cookies", 9)
exampledb.get("Cookies") // 60

getAll

Use this to get all the keys in the database in a dictionary format, example -

const ice = require("Icelake.db");
const exampledb = new ice.db("Example");

exampledb.set("Cookies", 50)
exampledb.set("Num Num Biscuits", 100)
exampledb.set("Love", "Infinite")

exampledb.getAll() // { "Cookies" : 50, "Num Num Biscuits" : 100, "Love" : "Infinite" }

showTable

Get the entire DB in a nice little table format (uses console.table), example -

const ice = require("Icelake.db");
const exampledb = new ice.db("Example");

exampledb.set("Cookies", 50)
exampledb.set("Num Num Biscuits", 100)
exampledb.set("Love", "Infinite")

exampledb.showTable() // { "Cookies" : 50, "Num Num Biscuits" : 100, "Love" : "Infinite" }

table image

Package Sidebar

Install

npm i icelake.db

Weekly Downloads

2

Version

1.0.0

License

ISC

Unpacked Size

7.67 kB

Total Files

4

Last publish

Collaborators

  • frostythedumdum