https://github.com/gulpjs/sparkles

Namespaced global event emitter.
https://github.com/gulpjs/sparkles

command-line eventemitter global gulpjs javascript namespace nodejs

Last synced: 3 months ago
JSON representation

Namespaced global event emitter.

• Host: GitHub
• URL: https://github.com/gulpjs/sparkles
• Owner: gulpjs
• License: mit
• Created: 2014-12-09T01:47:12.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2024-03-23T21:42:39.000Z (9 months ago)
• Last Synced: 2024-05-22T22:24:04.136Z (7 months ago)
• Topics: command-line, eventemitter, global, gulpjs, javascript, namespace, nodejs
• Language: JavaScript
• Homepage:
• Size: 29.3 KB
• Stars: 20
• Watchers: 6
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

    

  



# sparkles

[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][ci-image]][ci-url] [![Coveralls Status][coveralls-image]][coveralls-url]

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.

```js

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

[downloads-image]: https://img.shields.io/npm/dm/sparkles.svg?style=flat-square

[npm-url]: https://www.npmjs.com/package/sparkles

[npm-image]: https://img.shields.io/npm/v/sparkles.svg?style=flat-square

[ci-url]: https://github.com/gulpjs/sparkles/actions?query=workflow:dev

[ci-image]: https://img.shields.io/github/actions/workflow/status/gulpjs/sparkles/dev.yml?branch=master&style=flat-square

[coveralls-url]: https://coveralls.io/r/gulpjs/sparkles

[coveralls-image]: https://img.shields.io/coveralls/gulpjs/sparkles/master.svg?style=flat-square