hxsf / event-pubsub

Event Pubsub for Javascript will work in node js or browser

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Event PubSub

npm info :
event-pubsub npm version total npm downloads for event-pubsub monthly npm downloads for event-pubsub

GitHub info :
event-pubsub GitHub Release GitHub license event-pubsub license open issues for event-pubsub on GitHub

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

See NPM stats for event-pubsub

EXAMPLE FILES

  1. Node Pubsub Event Examples
  2. Browser Pubsub Event Examples

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'
);

About

Event Pubsub for Javascript will work in node js or browser

License:The Unlicense


Languages

Language:JavaScript 100.0%