README.md

Depot DB

An embedded database for typescript and nodejs. Built as a tiny wrapper around leveldb.

Overview

Depot DB is a performant database designed for embedded projects and low traffic web apps.

It has a different, yet familiar query language. Typescript.

In depot the "where" is a function that is passed all of the documents in the db. If the function returns true, the document is added to the collection, otherwise it is ignored.

The same goes for "sort". The sort function is passed two documents ("a" and "b") and returns a number determining which one goes first. If the sort function returns a number greater than zero "a" is at a higher index than "b", less than zero and "b" comes first. If it returns 0 they "a" and "b" equivelent.

Installation

npm i --save depot-db

Basic Usage

import { Depot } from "depot-db";

// Define a document type
type Person = { firstname: string, lastname: string, age: number };

// Initialize a people database (Stored in /databases/people)
const people = new Depot<Person>("/databases/people");

// Store some people
people.put("John", { firstname: "John", lastname: "Doe", age: 32 });
people.put("Jane", { firstname: "Jane", lastname: "Doe", age: 32 });
people.put("Tim", { firstname: "Tim", lastname: "Burton", age: 59 });
people.put("Tony", { firstname: "Stark", lastname: "Doe", age: 45 });

// Query people
people.find({
    where: person => person.age > 32
}).then(personsOlderThat32 => {
    // personsOlderThat32 = [
    //     { firstname: "Tim", lastname: "Burton", age: 61 },
    //     { firstname: "Stark", lastname: "Doe", age: 53 }
    // ];
});

// Find a person by their key (rejects if person is not found)
people.get("John").then(/** { firstname: "John", lastname: "Doe", age: 32 } */);

API

API documentation can be found here