History

Brandon Nozaki Miller 0189a44ee3 fleshing out testHarness		2014-09-02 23:25:35 -07:00
..
examples	added ipc.disconnect method and multiple client example	2014-03-01 04:13:06 -08:00
event-pubsub-browser.js	added ipc.disconnect method and multiple client example	2014-03-01 04:13:06 -08:00
event-pubsub.js	added ipc.disconnect method and multiple client example	2014-03-01 04:13:06 -08:00
LICENSE	first commit	2014-02-22 01:13:31 -08:00
package.json	fleshing out testHarness	2014-09-02 23:25:35 -07:00
README.md	added ipc.disconnect method and multiple client example	2014-03-01 04:13:06 -08:00

README.md

Event PubSub

Pubsub events for Node and the browser allowing event scoping and multiple scopes. Easy for any developer level. No frills, just high speed pubsub events!

Pretty GitHub.io site

EXAMPLE FILES

Node Install
npm install event-pubsub

Browser Install
see browser examples above or below

Basic Example

NOTE - the only diffeence between node and browser code is how the events variable is created

node var events = new require('../../event-pubsub.js')();
browser var events = new window.pubsub();

Node

var events = new require('../../event-pubsub.js')();

events.on(
    'hello',
    function(data){
        console.log('hello event recieved ', data);
    }
);

events.on(
    '*',
    function(type){
        console.log('Catch all detected event type of : ',type, '. List of all the sent arguments ',arguments);
    }
);

events.on(
    'removeEvents',
    function(){
        events.off('*');
        console.log('Removed all events');
    }
);

/************************************\
 * trigger events for testing
 * **********************************/
events.trigger(
    'hello',
    'world'
);

events.trigger(
    'removeEvents'
);

Browser

HTML

<!DOCTYPE html>
<html>
    <head>
        <title>PubSub Example</title>
        <script src='../../event-pubsub-browser.js'></script>
        <script src='yourAmazingCode.js'></script>
    </head>
    <body>
        ...
    </body>
</html>

Inside Your Amazing Code

var events = new window.pubsub();

events.on(
    'hello',
    function(data){
        console.log('hello event recieved ', data);
    }
);

events.on(
    '*',
    function(type){
        console.log('Catch all detected event type of : ',type, '. List of all the sent arguments ',arguments);
    }
);

events.on(
    'removeEvents',
    function(){
        events.off('*');
        console.log('Removed all events');
    }
);

/************************************\
 * trigger events for testing
 * **********************************/
events.trigger(
    'hello',
    'world'
);

events.trigger(
    'removeEvents'
);