ngraph.events

ngraph.events JS library on GitHub ngraph.events JS library on npm Download ngraph.events JS library

Basic events supoort for ngraph.js

Version 1.2.2 License BSD-3-Clause Vulnerabilities 0
ngraph.events has no homepage
ngraph.events JS library on GitHub
ngraph.events JS library on npm
Download ngraph.events JS library
Keywords
ngraphngraphjs

ngraph.events

Small and powerful eventing in node and browser

build status

Example

var eventify = require('ngraph.events');
var yourObject = {}; // any javascript object

eventify(yourObject);

// now any object can listen to events from your object
yourObject.on('beep', function(name) { console.log('Hello ' + name); });

// and you can fire events from your object:
yourObject.fire('beep', 'World!'); // prints 'Hello World!'

// stop listen to events:
yourObject.off('beep');

More advanced examples:

var eventify = require('ngraph.events');
var yourObject = eventify({});

// Pass context to event handler as last argument:
yourObject.on('beep', function () { console.log(this === yourObject); }, yourObject);
yourObject.fire('beep'); // prints true;

// Pass additional arguments to fire:
var onBop = function (x, y) { console.log(x + y); };
yourObject.on('bop', onBop);
yourObject.fire('bop', 40, 2); // prints 42;

// Remove given event handler for 'bop' event
yourObject.off('bop', onBop);

// Remove all event listeners from your object:
yourObject.off();

Why?

I wanted a light-weight eventing library, so I built this.

Install

With npm do:

npm install ngraph.events

License

BSD 3-Clause