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

statedb

v4.2.1

Published

Save your app state!

Downloads

263

Readme

StateDb

Little wrapper around lowdb, for persitence of states.

Usage:

new StateDb (dbPath, [appkey], [options]);

StateDb create a file at dbPath and add .db extensions. So, if you pass /mount/app.settings the result in the filesystem is /mount/app.settings.db

With the appkey you can categorize your app/domain in the db file. For example, if you wanna persist another domain in the same file you can do:

const myDbPath = '/mount/local/file';
const UsersDb = new StateDb(myDbPath, 'users');
const CustomersDb = new StateDb(myDbPath, 'customers');

If the appkey is omitted, the dbPath will be used as appkey. This behavior create an hard link with the db location and the content. If you try to open the Db with another path, the content is reseted.

In general, if you provide a database as ressource, don't ommit the appkey.

saveState ('state key', value)

Save something at state key.

loadState ('state key')

Load something that reside at state key.

Example:

import StateDb from 'statedb';

async function main() {
  const myDbPath = '/mount/local/burritos';
  const savedSettings = new StateDb(myDbPath, 'settings');
  const savedUsers = new StateDb(myDbPath, 'users');

  await savedSettings.init();
  await savedUsers.init();

  // saving
  savedSettings.saveState('bobSettings', {
    x: 800,
    y: 600,
    locale: 'en_US',
  });

  // loading
  const settings = savedSettings.loadState('settings');
  // todo: do some magic with loaded settings...
}

main();