@nlfmt/stormdb v2.0.0

Storm DB

A Simple Typescript ORM for NodeJS. Supports custom class serialization and deserialization, advanced querying, and more.

Disclaimer

Pros

StormDB is a good choice for projects, that need a simple typesafe database, that works out of the box. \ Since all the data is stored in JSON (or a format of your choice), you dont have to set up anything like a server. \ StormDB can be used in any project you wish, as it is very lightweight.

Cons

StormDB is NOT a good choice to store large amounts of data, as it loads the entire database into memory. \ It is also not suitable for applications that need very fast data access. Even though StormDB is quite fast, as the data is stored in memory, \ it doesnt do any querying optimizations, like indexing.

Quickstart

1. Install StormDB npm install @nlfmt/stormdb
2. Install packages for you validation library, here are some examples:
   • npm install zod @typeschema/zod
   • npm install valibot @typeschema/valibot
3. Initialize the database

import StormDB from '@nlfmt/stormdb';
import { z } from 'zod';

const userModel = z.object({
  name: z.string(),
  age: z.number(),
});

const db = StormDB({ user: userModel }, { storage: "db.json" });

4. Use the querying API

// Add a user
let usr = await db.user.create({ name: "John", age: 20 });

// Get a user
usr = await db.user.findById(usr._id);
usr = await db.user.find({ name: "John" });

// Update a user
usr = await db.user.updateById(usr._id, { age: 21 });
usr = await db.user.update({ name: "John" }, { age: 21 });

// Delete a user
await db.user.deleteById(usr._id);

Examples

For more examples, check out the examples folder.

License

This project is licensed under the MIT License - see the LICENSE file for details.