eventize

eventize

Convert objects into event emitters, that emit events before and after calling the specified methods.

Installation

Node

Dependencies:

• node >= 0.10
• npm >= 2.0.0

npm install eventize

Browser

The package is also available as a UMD module (compatible with AMD, CommonJS and exposing a global variable eventize) in dist/eventize.js and dist/eventize.min.js (1.9 KB minified and gzipped).

It can be installed with npm, bower or downloading the release from GitHub:

npm install eventize
bower install eventize

Usage

eventize.object

eventize.object converts plain objects into event emitters (if it they are not) and wraps the specified methods to emit events before and after being called:

var eventize = require('eventize');

var myObject = {
  name: 'John',
  getName: function() {
    return this.name;
  },
  setName: function(name) {
    this.name = name;
    return name;
  }
};

// equivalent to eventize.object(myObject, ['setName']);
eventize.object(myObject, ['setName']);

myObject.on('setName:before', function(args, method, target) {});
myObject.on('setName', function(args, returnValue, method, target) {});

myObject.setName('Jack'); // emits setName:before and setName

eventize.methods

eventize.methods wraps the specified methods to emit events before and after being called (the target must be an event emitter):

var eventize = require('eventize');
var util = require('util');
var EventEmitter = require('util');

function MyConstructor() {
  EventEmitter.call(this);
}

util.inherits(MyConstructor, EventEmitter);

MyConstructor.prototype.addOne = function(value) {
  return value + 1;
};

eventize.methods(MyConstructor.prototype, ['addOne']);

var myObject = new MyConstructor();
myObject.on('addOne:before', function(args, method, target) {});
myObject.on('addOne', function(args, returnValue, method, target) {});
myObject.addOne(1); // Emits addOne:before and addOne

eventize.method

eventize.method wraps a single method to emit events (the target must be an event emitter):

eventize.method(myObject, 'getName');
myObject.on('getName:before', function(args,  method, target) {});
myObject.on('getName', function(args, returnValue, method, target) {});
myObject.getName(); // emits setName:before and setName

Tests

To run the tests with Jasmine:

npm install
npm test

Contributing

• Fork it!
• Create your feature branch: git checkout -b my-new-feature
• Commit your changes: git commit -am 'Add some feature'
• Check the build: npm run build
• Push to the branch: git push origin my-new-feature
• Submit a pull request :D

History

• 0.6.0:

  • Added browser compatibility
  • Added bower.json
  • Modified public API to expose a plain object with the main methods

• 0.5.1:

  • Fixed documentation examples

• 0.5.0:

  • Removed "method:after" events
  • Called "method" events after calling the original method

• 0.4.0:

  • Event callback signature is now (args, [returnValue], method, target)

• 0.3.0:

  • New method eventize.methods (mostly for classes)

• 0.2.0:

  • New methods eventize.object and eventize.method
  • eventize (eventize.object) is now idempotent (as well as eventize.method)

• 0.1.0:

  • Basic functionality

License

The MIT License (MIT)

Copyright (c) 2015 Rubén Norte

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.