Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including @alcumus/aggregating-event-emitter with all npm packages installed. Try it out:

var aggregatingEventEmitter = require("@alcumus/aggregating-event-emitter")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

@alcumus/aggregating-event-emitter v0.1.1

An event emitter that provides both normal event emitting functionality as well as the ability to aggregate results of calling the event handlers. For example you can use emitAsync to receive an array of the results of all the event handlers that were triggered or emitAsyncWaterfall to process the arguments in series and get the result returned at the end.

Aggregating Event Emitter

This is an event emitter that works similar to standard event emitters, but is purpose built to use events for getting data as well as simply notifying parts of the system of events. This is helpful for invertion-of-control approaches where you don't necessarily know what will be able to provide your code with the data you need, only that it will exist at runtime.

In addition to this it has useful features like wildcard matching and list item matching.

Installation

npm i @alcumus/aggregating-event-emitter

Usage examples

Getting data returned by event handlers:

// Handler.js
const dataEvents = require('aggregating-event-emitter').aggregatingEventEmitter({ name: 'data', wildcards: true });
const data = {
    namespace: [1, 4, 9, 12]
};
dataEvents.on('*.data.get', (event, query) => {
    if (query.$gt) {
        const name = event.eventName.split('.')[0];
        return (data[name] || []).filter(value => value > query.$gt);
    }
});

// Emitter.js
// We can reference the previously instantiated event emitter by name and don't need to provide other options to it.
const dataEvents = require('aggregating-event-emitter').aggregatingEventEmitter({ name: 'data' });
const data = dataEvents.emit('namespace.data.get', { $gt: 5 });
console.log(data); // [[9, 12]]

Waterfall:

const events = require('aggregating-event-emitter').aggregatingEventEmitter();

// These event handlers will be fired in this order and the output of the first will be passed to the input of the second.
events.on('my-event', (event, array) => array.map(value => value + 10));
events.on('my-event', (event, array) => array.map(value => value * 2));

const data = events.emitWaterfall('my-event', [0, 5, 10]);
console.log(data); // [20, 30, 40]

Be aware that it's fully possible for one handler to break the data structure for another handler if you are not careful when using the waterfall functions. In order to mitigate this, it may be worth using hooks to ensure the order is appropriate.

API

The API docs are available here: https://alcumus.github.io/aggregating-event-emitter/

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free