chi

childish

An opinionated LevelUP abstraction that stores and operate on keys in the form of parent/child

Showing:

Popularity

Downloads/wk

1

GitHub Stars

2

Maintenance

Last Commit

7yrs ago

Contributors

0

Package

Dependencies

1

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

Childish

Childish is an opinionated LevelUP abstraction that stores and operate on keys in the form of parent/child.

Besides giving you a way to store and delete these keys, you can query for the existence of a key using .ok(key) get a list of all children of a given parent using .children(parent) or a list of all parents using .parents(child).

Notice that there are no values associated with the keys. This is just a database for storing parent-child relationships using a hierarchical key structure.

You can use any LevelDOWN compatible datastore you like as your backend. Here are a few popular once:

  • LevelDOWN - Doh!
  • MemDOWN - A drop-in replacement for LevelDOWN that works in memory only
  • MongoDOWN - MongoDB backend for LevelUP
  • SQLDown - sql backend for levelup
  • mysqlDOWN - An drop-in replacement for LevelDOWN that works in mysql

Build Status

Installation

npm install childish

Example

var levelup = require('level');
var db = require('childish')(levelup('/tmp/my-db'));

db.put('admin/odin', function (err) {
  db.put('moderator/odin', function (err) {
    db.put('moderator/thor', function (err) {
      db.ok('admin/odin', function (err, ok) {
        if (ok) console.log('Odin is an admin');
      });

      console.log('The follwoing users are admins:');
      db.children('admin').pipe(console.log);

      console.log('Odin have the following permissions:');
      db.parents('odin').pipe(console.log);
    });
  });
});

API

  • db.put(key, callback) - Register a key (key format: parent/child)
  • db.ok(key, callback) - Check if a key exists (key format: parent/child)
  • db.del(key, callback) - Remove a key (key format: parent/child)
  • db.children(parent) - Get a stream of all children for parent
  • db.parents(child) - Get a stream of all parents for child

License

MIT

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial