sparkles

    2.0.0 • Public • Published

    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 😄

    License

    MIT

    Install

    npm i sparkles

    DownloadsWeekly Downloads

    1,690,270

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    6 kB

    Total Files

    5

    Last publish

    Collaborators

    • sttk
    • phated
    • yocontra