raptor-pubsub

Support for Pub/Sub communication in the browser

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
raptor-pubsub
601.0.58 years ago9 years agoMinified + gzip package size for raptor-pubsub in KB

Readme

raptor-pubsub
Super lightweight module to support EventEmitter-based Pub/Sub communication in the browser and on the server.
Installation
npm install raptor-pubsub --save
Usage

Communicating on the global pub/sub channel

var raptorPubsub = require('raptor-pubsub');

// Subscribe to an event
raptorPubsub.on('someEvent', function(arg) {
  // Do something...
});

// Publish an event
raptorPubsub.emit('someEvent', 'Hello World');

Communicating on named pub/sub channels

// Get a reference to named pub/sub channel
var channel = require('raptor-pubsub').channel('my-channel');

// Subscribe to an event
channel.on('someEvent', function(arg) {
  // Do something...
});

// Publish an event
channel.emit('someEvent', 'Hello World');

// Removing a channel
require('raptor-pubsub').removeChannel('my-channel');

The global pub/sub channel and named channels are simply EventEmitter instances.
Contributors
Contribute
Pull Requests welcome. Please submit Github issues for any feature enhancements, bugs or documentation problems.
License
Apache License v2.0