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

flat-file-db

v1.0.0

Published

Fast in-process flat file database that caches all data in memory

Downloads

1,392

Readme

flat-file-db

Fast in-process flat file database for Node.js that supports JSON and caches all data in memory. All data is persisted to an open file using a append-only algorithm ensuring compact file sizes and strong consistency.

npm install flat-file-db

build status

Usage

Pass a database file to use to the flat-file-db constructor and wait for the database to open. When it is open all data has been loaded into memory.

var flatfile = require('flat-file-db');
var db = flatfile('/tmp/my.db');

db.on('open', function() {
	db.put('hello', {world:1});  // store some data
	console.log(db.get('hello')) // prints {world:1}

	db.put('hey', {world:2}, function() {
		// 'hey' is now fully persisted
	});
});

If you don't want to wait for it to open use flatfile.sync

var db = flatfile.sync('/tmp/my.db');
console.log(db.get('hello')); // prints {world:1}

If you issue multiple writes the last one will always win

for (var i = 0; i < 10; i++) {
	db.put('test', {count:i}, ...);
}
console.log(db.get('test')); // {count:9} which also the persisted value of 'test'

API

  • db = flatfile(path, opts) Create a new db instance. Per default fsync is called on all puts. To disable this set opts.fsync = false

  • db = flatfile.sync(path, opts) Same as above except you do not need to wait for the open event

  • db.put(key, val, [cb]) Insert or update new key

  • db.del(key, [cb]) Delete a key

  • db.get(key) -> doc Get the value of a key

  • db.has(key) -> bool True if db has key

  • db.keys() -> list Get all keys as an array

  • db.clear([cb]) Clears the database of all values

  • db.close() Close the database

Events

  • db.on('open') Fired when the db is open and ready for use.

  • db.on('close') Fired when the db is fully closed

  • db.on('drain') All puts and deletes are flushed to disk

License

MIT