npm install puddle-crud
Corpus CRUD API wrapper
###Features:
[X] Minimum dependencies
[X] Can be connectd in a branched fashion, can't in circular
Returns a Crud class which is:
[X] has .on method to hook to events
[X] emits: create,remove,update events
[X] implements .create,.remove, .update methods
[X] implements .getState method which returns internal state
[X] implements .connect method which allows to
bi-directionally bind it to another instance of same class.
[X] Constructor takes optional initial hash
[X] Object agnostic (does not care what to sync)
###Installation:
npm install puddle-crud
npm test # optional
###Usage:
####Basic usage:
var Crud = require(‘puddle-crud’)
var uuid = require(‘node-uuid’)
var newId = uuid();
var initialHash = {uuid():Obj1, uuid():Obj2, ...};
var crud = new Crud(initialHash); //optionaly pass in init hash
crud.on('create', function (id,obj) {
console.log('Create event called with ',obj);
})
crud.create(newId,Obj3); //here an event will fire and you'll see in Console
// Create event called with Obj3
crud.getState() // returns current state of the internal hash including added Obj3;
####Chaining:
var Crud = require(‘puddle-crud’)
var uuid = require(‘node-uuid’)
var initialHash = {uuid():Obj1, uuid():Obj2, ...};
var one = new Crud(initialHash); //pass in init hash
var two = new Crud();
var three = new Crud();
two.connect(one);
three.getState() // {}
three.connect(two);
three.getState() // {uuid():Obj1, uuid():Obj2, ...}; because .connect() pulls in other instance's state.
one.on('create', function (id,obj) {
console.log('One got an object ',obj);
})
three.on('create', function (id,obj) {
console.log('Three got an object ',obj);
})
//events propogate through the chain
one.create(uuid(),obj) // 'Three got an object obj'
//both ways
three.create(uuid(),obj) // 'One got an object obj'
- Fritz Obermeyer
- Yan T.
Puddle was factored out of Pomagma in 2014.
Copyright 2013-2014 Fritz Obermeyer.
Puddle is licensed under the MIT license.