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

@brillout/proto-db

v0.1.1

Published

<!---

Downloads

244

Readme

ProtoDB

What is ProtoDB

Proto is a small Node.js tool to persist a JavaScript object to disk.

Why ProtoDB

At the early prototyping phase of several projects, we were too lazy to set up a proper database and instead we used a JavaScript object and persisted it by reading & writing JSON to disk.

We expected that our approach wouldn't survive long and that we would soon need to replace our lazy hack with a real database. But, and to our biggest surprise, we got quite far until we had to use a real database.

Proto is only ~40 lines of code (/index.js), so you can easily modify it and write your own implementation.

We actually encourage you to write your own implementation; ProtoDB is a cheering message that the technique of using JSON and the filesystem can be a great alternative to a database for prototypes and small to medium-sized apps. You may not use Proto but you may want to consider this technique.

Usage

Idiomatic usage example:

// /example/db/index.js

const proto = require('@brillout/proto-db'); // npm install @brillout/proto-db

const data = proto.load(__dirname+'/data.json', {todos: []});

module.exports = {createTodo, getAllTodos};

async function createTodo({text}) {
  const id = proto.getUUID();
  const newTodo = {id, text};

  data.todos.push(newTodo);

  await data._save();
}

function getAllTodos() {
  return data.todos;
}
// /example/index.js

const db = require('./db');

run();

async function run() {
  await db.createTodo({text: 'Buy Milk'});

  const todos = db.getAllTodos();
  console.log(todos);
}

Which prints:

$ node example/
[ { id: 430557952207, text: 'Buy Milk' } ]

The new todo item is saved as JSON in data.json:

$ cat example/db/data.json
{"todos":[{"id":199451513185,"text":"Buy Milk"}]}

API

  • const data = proto.load(databaseFile, defaultValue) loads and returns the JavaScript object saved at databaseFile. If there is no file at databaseFile then defaultValue is used. The proto.load function is synchronous.
  • await data._proto.save() saves data to the disk at the path databaseFile you provided when running const data = proto.load(databaseFile).
  • proto.getUUID() generates and returns a universally unique ID.