Observe-event NPM

observe-event

Make Object.observe emit events on every change

Object.observe is finally here and everyone is excited, but simply giving one callback the observe can make it hard to manage and re-use observations.

This simple Object.observe wrapper will return an event emitter instead that allows us to specify what type of change we want and passing the emitter around. If we want to catch all type of changes, we can do that too.

API

eObserve(object[, optAcceptList]) : EventEmitter

optAcceptList defines what type of changes to listen to. If not defined, it defaults to all changes (see below).

Events

The event emitter returned from eObserve(), emits changes made to the observed object in a channel that is the same as the type of change.

For instance:

eObserve(object).on('update', callback);

In addition to all types of changes as defined by the spec, a special channel exists to catch any change:

// Will trigger on any change
eObserve(object).on('any', callback);

Event overview

any – Triggered for all of the below
add
update
delete
reconfigure
setPrototype
preventExtensions

See the harmony specs for more information of the different changes

Install

Install using NPM

npm install --save observe-event

Install using Bower

bower install --save observe-event

Install manually

Download observe-event.js or observe-event.min.js from the dist folder and include in your HTML. See below for more details.

Usage

Node.js / Browserify

var eObserve = require('observe-event');

var obj = { message: 'Hello World!' };
eObserve(obj).on('update', function (change) {
  // => change.object.message = 'Hello, World!'
});

obj.message = 'Hello, World!';

See example

Manually in the browser

<script src="./dist/observe-event.js"></script>

var obj = { message: 'Hello World!' };
eObserve(obj).on('update', function (change) {
  // => change.object.message = 'Hello, World!'
});

obj.message = 'Hello, World!';

See example.

Using AMD (Require.js etc)

Not yet tested with AMD

Files observe-event.js and observe-event.min.js is wrapped with UMD (Universal Module Definition), so it should work with AMD as well as directly loading in the browser.

require(['observe-event'], function(eObserve) {
  var obj = { message: 'Hello World!' };
  eObserve(obj).on('update', function (change) {
    // => change.object.message = 'Hello, World!'
  });

  obj.message = 'Hello, World!';
});

Changelog

Version `0.7.0`

Changes from having a single file with UMD in it, to use a build step creating seperate distribution files.
No longer have external dependencies (EventEmitter.js).
For AMD and Browser you now need to use either observe-event.js or observe-event.min.js.