observify-object

1.0.2 • Public • Published

Decorating a JS object with an observable pattern

Build Status Coverage Status

Setup:

npm install observify-object --save

Observifying an object:

const observify = require('observify-object');

let foo = {foo: 'foo'};
observify(foo);

// or

let bar = observify({bar: 'bar'});

// or

let baz = {baz: 'baz'};
observify(baz);

Observing an object:

let foo = observify({bar: 'bar'});

let handler = (new_bar) => console.log(new_bar);
foo.observe('bar', handler);

foo.bar = 'changed';
// console prints 'changed'

Removing an handler:

let foo = observify({bar: 'bar'});

let handler = (new_bar) => console.log(new_bar);
foo.observe('bar', handler);

foo.unobserve('bar', handler);

foo.bar = 'changed';
// no console print

Defining properties after observifying an object:

let foo = observify({});

foo.bar = 'value';

observify(foo); // call observify again

let handler = (new_bar) => console.log(new_bar);
foo.observe('bar', handler);

foo.bar = 'changed';
// console prints 'changed'

License

The MIT License (MIT) Copyright (c) 2016 Rafael Kallis

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Package Sidebar

Install

npm i observify-object

Weekly Downloads

0

Version

1.0.2

License

MIT

Last publish

Collaborators

  • rafaelkallis