Skip to content

Latest commit

 

History

History
70 lines (44 loc) · 2.28 KB

README.md

File metadata and controls

70 lines (44 loc) · 2.28 KB

sparkles

NPM version Downloads Build Status Coveralls Status

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 😄

Strict No LLM / No AI Policy

No LLMs for issues.

No LLMs for patches / pull requests.

No LLMs for comments on the bug tracker, including translation.

English is encouraged, but not required. You are welcome to post in your native language and rely on others to have their own translation tools of choice to interpret your words.

License

MIT