README.md

pubsub.js

A tiny (~600 bytes when minified, ~300 bytes when gzip'd) and robust pubsub implementation in the spirit of microjs.com evolved from an original implementation by Daniel Lamb (of which, after refactoring and optimizing, only the method names have been kept, hence the change in the project's name).

The library is implemented as a universal module to support CommonJS-enabled, AMD-enabled and traditional Javascript environments and the code is optimized to be as compact, fast and memory-savvy as possible.

The code has also been tested toroughly and the functionality is secured with a complete set of unit tests built with Jasmine.

Supported platforms

• Node.js
• Rhino
• Appcelerator Titanium Mobile 2.0+
• EcmaScript 5 capable browsers
  • Google Chrome 5+
  • Safari 4+
  • Internet Explorer 5+
  • Firefox 3+
  • Opera 10+
  • Android
  • Mobile Safari
  • Firefox Mobile (Fennec)
  • Opera Mobile 10+

Documentation

The description of each method and its' parameters are inlined in the library's source using the Javadoc syntax.

Examples

Using the library as a traditional Javascript module:

	var p = PubSub;

	//subscribe to a channel
	var handle = p.subscribe("/some/channel", function(msg){
		console.log(msg);
	});

	//publish a message
	p.publish("/some/channel", "Hello!");

	//unsubscribe from the topic
	p.unsubscribe(handle);

Here's the same example using the library as a standard CommonJS module:

	var p = require('pubsub');

	//subscribe to a channel
	var handle = p.subscribe("/some/channel", function(msg){
		console.log(msg);
	});

	//publish a message
	p.publish("/some/channel", "Hello!");

	//unsubscribe from the topic
	p.unsubscribe(handle);

Alternatively using the library as an AMD module (where possible, see RequireJS for more info):

	require('pubsub', function(p){
		//subscribe to a channel
		var handle = p.subscribe("some/channel", function(msg){
			console.log(msg);
		});
	
		//publish a message
		p.publish("/some/channel", "Hello!");
	
		//unsubscribe from the topic
		p.unsubscribe(handle);
	});

The publish function support any number and type of data parameters:

	PubSub.subscribe('/some/channel', function( a, b, c, d ){ /* ... */ });
	PubSub.publish('/some/channel', 1 /* a */, "two" /* b */, [3, 4, 5] /* c */, {total: 15} /* d */);

Credits

• Federico "Lox" Lucignano, creator and mantainer
• Daniel Lamb, original code
• All the contributors