whale-db

0.0.3 • Public • Published

WHALE-DB

A great JSON-based and simple to use database.

Introduction

const { Database } = require("whale-db");
const db = new Database(/*
    {
        path: "string/to/path", default: "database.json"
        prefix: "stringprefix" default: '/'
    }
*/)

db.set(`database/set`, 1)

Whale-db has many methods, list of them:

  • set
    param: [key, set]
    function: store something in the database
  • delete/del
    param: [key]
    function: delete something in database
  • get
    param: [key]
    function: gets something in database
  • add
    param: [key, add]
    function: adds something in database
  • sub
    param: [key, sub]
    function: subs something in database
  • pull
    param: [key, ...names]
    function: Remove arguments from a list according to the second parameter
  • put
    param: [objectPut]
    function: Insert an object into the database by deleting all data
  • write
    param: [stringPut]
    function: Insert an string into the database by deleting all data
  • pop
    param: []
    function: Remove the last element from the database
  • shift
    param: []
    function:Remove the first element from the database
  • at
    param: [index]
    function: acess elements by index in dataase
  • first
    param: []
    function: get first element of database
  • randomKey
    param: []
    function: get a random key of a value in dataase
  • random
    param: []
    function: get a random value in dataase
  • push
    param: [key, ...values]
    function: push many values in key in database
  • unshift
    param: [key, ...values]
    function: empurrar muitos valores na chave no banco de dados para o primeiro elemento
  • clear
    param: []
    function: delete all datas of database
  • search
    param: []
    function: Do a lookup using a callback in the database
  • all
    param: [{ limit: Infinity, filter: () => true, collection: false }]
    function: Format all database data and return them
  • has
    param: [key]
    function: Check if this value exists
  • size
    param: []
    function: return the length of database
  • slice
    param: [min, max]
    function: Returns the all method bounded by min and max
  • reverse
    param: []
    function: reverse all database
  • last
    param: []
    function: return the last value of database
  • type
    param: [key]
    function: return the type of data of database

Otherwise

It is possible to manage the database from a "method"

db.acess.hi = 'Hi!'
db.save()

Package Sidebar

Install

npm i whale-db

Weekly Downloads

1

Version

0.0.3

License

ISC

Unpacked Size

63.1 kB

Total Files

10

Last publish

Collaborators

  • belzinhu1234