vmk-demo-bot / frontend / node_modules / sparkles /
..
LICENSE init 16 days ago
README.md init 16 days ago
index.js init 16 days ago
package.json init 16 days ago
README.md

sparkles

NPM version Downloads Travis Build Status AppVeyor Build Status Coveralls Status Gitter chat

Namespaced global event emitter

Usage

Sparkles exports a function that returns a singleton EventEmitter. This EE can be shared across your application, whether or not node loads multiple copies.

var sparkles = require('sparkles')(); // make sure to call the function

sparkles.on('my-event', function(evt){
  console.log('my-event handled', evt);
});

sparkles.emit('my-event', { my: 'event' });

API

sparkles(namespace)

Returns an EventEmitter that is shared amongst the provided namespace. If no namespace is provided, returns a default EventEmitter.

sparkles.exists(namespace);

Checks whether a namespace exists and returns true or false.

Why the name?

This is a "global emitter"; shortened: "glitter" but it was already taken; so we got sparkles instead :smile:

License

MIT