key-tree-store/README.md

Simple tool for storing/retrieving objects events based hierarchical keypaths.

# key-tree-store

Simple tool for storing/retrieving objects events based hierarchical keypaths.

It lets you store and retrive objects that are at an equal or deeper key path than what you give it.

## install

```
npm install key-tree-store
```

## example

Assume you've got a structure like this:

```js
{
    'first': [ {obj: 1}, {obj: 2} ],
    'first.stuff': [ {obj: 3} ],
    'first.something.other': [ {obj: 4}, {obj: 5} ]
}
```

Then you can retrive it by key. Where it returns anything at or deeper than level supplied. 

```javascript
var KeyTree = require('key-tree-store');

var tree = new KeyTree();

tree.add('first', {id: 'one'});
tree.add('first.second', {id: 'two'});
tree.add('first.second', {id: 'three'});
tree.add('first.second.third', {id: 'four'});

// now we can retrieve them by key
tree.get('first'); // returns all of them
tree.get('first.second'); // returns array of objects two, three and four
tree.get('first.second.third'); // returns array of object four;

// the `get` method returns them all in an array
// if we still need them grouped by key we can use
// `getGrouped`
tree.getGrouped('first.second'); // returns {'first.second': [...], 'first.second.third': [...]}

// calling `.get()` or `.getGrouped` without arguments
// returns all in appropriate format

// that's all there is to it

```

removing items:

```javascript
var KeyTree = require('key-tree-store');

var tree = new KeyTree();
var obj1 = {obj: '1'};

tree.add('key.path', obj1);

// removes it no matter what key
tree.remove(obj1);
```

running items:

```javascript
// as a shortcut, there's also the `run` method
// to help you run functions that match they keypath
// this assumes you're storing functions, of course.
var KeyTree = require('key-tree-store');

var tree = new KeyTree();

tree.add('key.path', function () {
    console.log('function ran!');
});

tree.run('key'); //=> function ran!

// you can also optionally pass a context or arguments to run them with
tree.run('key', {some: 'object'});

// with arguments
tree.run('key', {some: 'object'}, 'arg1', 'arg2');

```

## credits

If you like this follow [@HenrikJoreteg](http://twitter.com/henrikjoreteg) on twitter.

## license

MIT