npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

elephant-db

v0.0.1

Published

A simple in-memory node database.

Downloads

4

Readme

ElephantDB

ElephantDB is a is a super simple in-memory node database. It supports adding, deleting, updating & querying. It is synchronous & is designed to be used when prototyping or stubbing APIs etc.

npm install --save elephant-db

Basic Example

This is a basic example which creates a db, adds some items & retrieves them.

const ElephantDB = require('elephant-db');

// You can set up different collections based like this. Collections
// are kind of like tables in which your data can and will be stored.
const db = new ElephantDB(['dogs', 'people']);

// You can add a single document like so:
db.select('people').add({
    id: 1, name: 'Steve', age: 38, job: 'developer'
});

// You can add multiple documents like so:
db.select('dogs').add([
    {
        id: 1, breed: 'Dachshund', hair: 'Short', name: 'Olive', age: 2
    },
    {
        id: 2, breed: 'Labrador', hair: 'Short', name: 'Albert', age: 10
    },
    {
        id: 3, breed: 'Cocker Spaniel', hair: 'Long', name: 'Bruce', age: 4
    }
]);

// You can then retrieve a single documents like so:
db.select('dogs').find({id: 3});
// {id: 3, breed: 'Cocker Spaniel', name: 'Bruce', age: 4}

// You can also find multiple documents:
db.select('dogs').findAll({hair: 'Short'});
// [
//     {id: 1, breed: 'Dachshund', hair: 'Short', name: 'Olive', age: 2},
//     {id: 2, breed: 'Labrador', hair: 'Short', name: 'Albert', age: 10}
// ]

// You can also provide a function to find documents:
db.select('dogs').findAll((dog) => dog.age < 5);
// [
//     {id: 1, breed: 'Dachshund', hair: 'Short', name: 'Olive', age: 2},
//     {id: 3, breed: 'Cocker Spaniel', hair: 'Long', name: 'Bruce', age: 4}
// ]

Full API

For examples check the tests.

#####ElephantDB([String]) Constructor to create an instance of ElephantDB. It takes a single array of string where each string is the name of a collection.

#####.select(String) Selects a single collection within which you would like to find, delete, update etc.

#####.find({}|fn) Finds & returns the first document that matches. Takes either an object or function to find you a document. You can use an object that defines your query (e.g. .find({name: 'John'}) to find the first document with the name of John). Alternatively you can use a function that returns true or false base on whether a document matches (e.g. .find((person) => person.age <= 30))

#####.findAll({}|fn) Same as .find() but returns an array of all documents that match. If called without a query, returns all documents in the selected collection.

#####.update({}|fn, {}|fn) Finds & returns the first document that matches (like .find()) and updates that document. For example: .update({id: 1}, {age: 15}) would find a dog with the id of 1 and set it's age to 15 (in the example above). Alternatively a function can be used to update the document: .update({id: 1}, (dog) => { dog.age = dog.age*2; })

#####.updateAll({}|fn, {}|fn) Same as update() but updates all documents that matches.

#####.delete({}|fn) Deletes & returns the first document that matches.

#####.deleteAll({}|fn) Deletes & returns all documents that match.

#####.dump() Returns all collections and stored objects.