ballyhoo

Ballyhoo

Bloody simple, super tiny, pub/sub JS events class based on https://davidwalsh.name/pubsub-javascript implemented in ES6, maintained with 100% test coverage. In production since 2016.

Install

via npm:

npm install ballyhoo --save

via yarn:

yarn add ballyhoo

Getting Started

Using this couldn't be easier. Create a new instance:

import Ballyhoo from 'ballyhoo';
const events = new Ballyhoo();

The create the listener / subscriber:

events.on('namespace/event', function(data) {
    //... do something when the event fires
});

note that the on function returns a remove handler, should you wish to unbind it.

const event = events.on('namespace/event', function(data) {
    //... do something when the event fires
});

// remove event
event.remove();

Then publish an event at an appropriate time:

events.emit('namespace/event', {});

You can pass any data you wish along to the handler function when emitting (or publishing an event) via the second argument.

Contributions and Suggestions Welcome!

Have something you think this needs or could use as an improvement, let me know. add an issue on github or fork and create a pull request.

Changelog

This includes notable changes to the package

• 2.0.x - universal
  • remove meteor files
  • add eslint & prettier
  • update dependencies
  • use rollup for universal exports
  • update readme
  • add tests
  • add cxircleCI
  • add codeclimate
• 0.0.4 - setup proper ES6 export

License MIT

Copyright (c) 2019 Paul van Zyl

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.