A slim wrapper around localStorage and sessionStorage that allows for NoSQL style access. It's basically a JSON-backed object database for your web browser.

View project onGitHub

Dustbin JS

A JSON-backed object database for your web browser. It's a light wrapper around local/session storage, designed to behave much like a standard NoSQL database. (In fact, it's design is heavily influenced by Riak, my personal favoriate NoSQL.)


Dustbin has the concepts of 'bins', which are loosely analogous to tables in SQL, or collections/buckets in NoSQL. Basically, they are collections of objects able to be referenced by a name. (In fact, Dustbin simply uses an anonymous object for each bin).

Inside each bin, objects are stored by key. Keys are always strings, but they can be any key you can set on a javascript object. The objects that are stored must be able to be turned into a JSON string. That is the only restriction. (Really, it's the cost of doing business with localStorage; it doesn't support storage of objects, only strings and integers.)

Metadata support

Dustbin does modify the stored objects slightly. In each object, it adds a key called $metadata, which stores useful information about the object, such as the key, and the bucket it was saved in, or the creation time. This object is for both internal use, as well as providing possibly useful data to the user. You may store whatever additional data you would like in the object; just be aware that whenever the object is stored, Dustbin will always override key, bucket, and updated.

Currently, here is an example $metadata object:

    key: "someKey",
    bin: "someBin",
    created: "Tue Apr 15 2013 23:05:42 GMT-0500 (CDT)",
    updated: "Tue Apr 16 2013 09:01:38 GMT-0500 (CDT)"

It should be noted that created and updated are always strings. You can turn them into Date objects trivially:

    var createdDate = new Date(obj.$metadata.created);


Using Dustbin is incredibly easy. When you include dustbin, it creates a new object on window, called dustbin. Here's an example of basic usage:

var obj = {'foo': "bar"};

// Store the object.
dustbin.store("testBin", "testObj", obj);

// Store an object if it already contains metadata.

// Retrieve it by key.
obj = dustbin.get("testBin", "testObj");

// Alternative syntax.
obj = dustbin.get("testBin")["testObj"];

That's all there is to it!

RequireJS support

Recently, I've added support for RequireJS. While it's optional (and will remain so), the support seems to work very well. You can simply use it like any other RequireJS module:

require(['dustbin'], function(dustbin)
    var key = dustbin.store("testBin", obj);

Though the support has been tested (and is part of the unit tests), I still consider the RequireJS support experimental. If you encounter any issues, please file a ticket. (Make sure to include a test case!)

Auto-generated Keys

You're not required to have a key to store your object under. Dustbin will automatically generate a key for you if you don't pass one in:

var obj = {'foo': "bar"};

// Store the object.
var key = dustbin.store("testBin", obj);

// Key will be something like: "LTMwMzk5OTQ2MA=="
console.log("Key:", key);

// Retrieve it by key.
obj = dustbin.get("testBin", key);

Retrieve entire bin object

You can also retrieve the entire bin object:

bin = dustbin.get("testBin");

This allows for the alternative (and in my opinion, cleaner) syntax:

obj = dustbin.get("testBin")["testObj"];

Remove an object

You can remove an object by key:

dustbin.remove("testBin", "testObj");

Remove all objects in a bin

You can even remove all objects from a bin:


Basic Query support

Currently, only basic query support has been added. You will need to construct an object containing key and value where you want back a list of object that have key equal to value. Here's an example:

var alex = {animal:"cat", name: "alex", age: 4};
var izzy = {animal:"cat", name: "izzy", age: 4};
var baal = {animal:"snake", name: "baal", age: 2};

dustbin.store("pets", alex);
dustbin.store("pets", izzy);
dustbin.store("pets", baal);

// `cats` will be equal to `[alex, izzy]`
var cats = dustbin.query("pets", {animal: "cat"});

// `pets` will be equal to `[alex, izzy, baal]`
var pets = dustbin.query("pets", {});

Right now the only thing supported is pure equality, not equivalence. Also, this is basically two nested forEach calls, so performance isn't as good as it could be. I'll be looking at improving this in the future, but for now it should meet most needs.

Session store support

All operations can also be done on the session store. By default, the dustbin object's functions are simply wrappers for dustbin.local. As such, you can also access the session store by using: dustbin.session. Here's some examples:

var obj = {'foo': "bar"};

// Store the object.
dustbin.session.store("testBin", "testObj", obj);

// Retrieve it by key.
obj = dustbin.session.get("testBin", "testObj");

// Alternative syntax.
obj = dustbin.session.get("testBin")["testObj"];

As you can see, it supports all the same operations as the local storage functions. There is absolutely no difference, except the inherent difference of session storage (all objects only last for the duration of the browser session.)


Currently, all unit tests pass, and the basic functionality is there. You can get, remove and store objects by key. There is also basic query support, which I estimate will work for 70% of most use cases. As near as I can tell, this code is simple enough it can be used in a production site.

That being said, I would very much like to add support for map/reduce and a django-like query api. I will work on that as I have time. If you would like to implement these features, I am more than willing to accept pull requests.


As mentioned, I'm more than willing to accept pull requests. I will require you to follow my code format. I also reserve the rights to reject any features that rely heavily on experimental features, or lock users into one way system for using Dustbin. (There's a readon why the RequireJS support is optional.)

Reporting issues

I'm more than happy to have issues reported! All that I ask is a clear description of the problem, along with a test case. I don't have the time or inclination to wade through your application to try and discover the causes for a bug. So, whenever possible, please try and give me a small test case (Or, preferably, a pull-request with new unit tests that show the failure!)

That all being said, don't wait to file a bug until you have a use case. I'd rather know there's a potential issue asap; you can feel free to file an issue, and attach the test case to it later. Just make it clear you're working on it. If you're having trouble isolating it, I'm more than willing to lend a hand, provided I have the time. Feel free to ask.