sparkles

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.

Note: If you put an event handler in a file in your application, that file must be loaded in via an import somewhere in your application, even if it's not directly being used. Otherwise, it will not be loaded into memory.

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

Changelog

2.1.0 (2024-03-23)

Features

• Add module for accessing legacy store (#10) (7f8b667)

2.0.0 (2022-02-01)

⚠ BREAKING CHANGES

• Use a Symbol for attaching the default namespace to the store
• Use a Symbol for attaching the store to the global (#9)
• Normalize repository, dropping node <10.13 support (#6)

Features

• Use a Symbol for attaching the default namespace to the store (2196fb1)
• Use a Symbol for attaching the store to the global (#9) (2196fb1)
• Use Symbol.for so other applications can create the same Symbol (2196fb1)

Miscellaneous Chores

• Normalize repository, dropping node <10.13 support (#6) (6d6f7a8)