ostore

Object Store for JavaScript

npm install ostore
11 downloads in the last month

OStore

In-memory object store for JavaScript

Installation

Via npm on Node:

npm install ostore

In your browser: TBD

Usage

Reference in your program

var ostore = require('ostore');

Create an store

var store = ostore.createStore();

Put an item with a key

var item = { name: 'Adam', age: 800 };
store.put(1, item);

The key is NOT added to the item.

Add an item

var item = { name: 'Adam', age: 800 };
var id = store.add(item);

The key is NOT added to the original item, but the saved item (a clone) has a new field id.

Retrieve item by key

var item = store.get(id);

Retrieve items

var items = store.find(id);

Retrieve items with criteria

var items = store.find({ name: 'Adam' });

Retrieve items with criteria and fields

var items = store.find({ name: 'Adam' }, { age: true });

In this example, only the age is retrieved.

Retrieve all items using empty criteria and fields

var items = store.find({ }, { age: true });

You can also null criteria

var items = store.find(null, { age: true });

Update fields in an item

store.update(1, { age: 700 });

Samples

TBD

Versions

  • 0.0.1 Published

Inception

It was born after reading an email at Node.js list: Tests for a REST store generator

Contribution

Feel free to file issues and submit pull requests � contributions are welcome.

If you submit a pull request, please be sure to add or update corresponding test cases, and ensure that npm test continues to pass.

npm loves you