underpub-js

Simple pubsub lib

npm install underpub-js
1 downloads in the last week
4 downloads in the last month

UnderPub.js - Simple PubSub Module

A simple pubsub implementation for JavaScript. Can be used both in the browser and on the server.

If Underscore.js is present, this module will extend it with mixins:

  • _.publish
  • _.subscribe
  • _.unsubscribe

Examples

PubSub.subscribe('demo:test', function() {
    console.log('Test pubsub');
});

PubSub.publish('demo:test'); //console: Test pubsub

The subscribe method will pass back an array with the event name and supplied callback. You can use this later to unsubscribe if you want.

You can also pass an array of arguments to the publish method, and these will be sent down to subscriber callbacks:

PubSub.subscribe('demo:msg', function(msg) {
    console.log(msg);
});

PubSub.publish('demo:msg', 'Figs the cat'); // console: Figs the cat

If you ever want to unsubscribe, just pass in the event name (ex: 'demo:name') and the callback:

handle = PubSub.subscribe('demo:unsubscribe', function() {
    alert('test');
});

PubSub.unsubscribe(handle[0], handle[1]);

PubSub.publish('demo:unsubscribe'); // nothing happens

Tests

Tests were written using Mocha and can be run from the command line (assuming you installed via NPM):

  • First install dependencies: npm install
  • Then run the test: make test

The License (MIT)

Copyright (c) 2013 TJ Eastmond

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.

npm loves you