ngraph.events

Small and powerful eventing in node and browser

Example (ESM)

import eventify from 'ngraph.events';
const 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');

UMD via CDN

The UMD build is published as ngraph.events.umd.js.

<script src="https://unpkg.com/ngraph.events/dist/ngraph.events.umd.js"></script>
<script>
	const yourObject = {};
	// UMD global name is `ngraphEvents` (a function)
	ngraphEvents(yourObject);
	yourObject.on('beep', (name) => console.log('Hello ' + name));
	yourObject.fire('beep', 'World!');
	yourObject.off('beep');
</script>

More advanced examples:

import eventify from 'ngraph.events';
const 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:
const 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