@gambar/folder-db v1.1.8

FolderDB

Filesystem based database focused on lightweight data storage and easy data preview

Build using Bun on Debian, published to NPM.
(should work on windows and node too)

Table of contents

• Installation
• Documentation
• Basic usage

Installation

npm i @gambar/folder-db

import FolderDB, { CaseFormat } from '@gambar/folder-db';
// or
const FolderDB = require('@gambar/folder-db').default;
const { CaseFormat } = require('@gambar/folder-db').enums;

const db = new FolderDB({ dbPath: './db' });

Documentation

Detailed documentation can be found on GitHub.

Basic usage

const FolderDB = require('@gambar/folder-db').default;
const db = new FolderDB({ dbPath: './db' });

//create a folder to store your users
db.createFolder("users");

//add new user
db.get("users").createFile("random_id_or_hash", { name: "GamBar" });

//update username of user
db.get("users")
  .get("random_id_or_hash")
  .get("name")
  .set("Gamriel");

//add a a new field to user
db.get("users.random_id_or_hash").set("job_title", "Software developer");

//add a timestamp
db.get('users.random_id_or_hash').setTimestamp('updated_at');

//read the user
const myUser = db.get('users.random_id_or_hash').data;
console.log(myUser);