publisher.js's Introduction

publisher.js

feature-rich publish / subscribe system.

Guide

Read the guide to learn how to use publisher.

Installation and Universal JavaScript Support

publisher works as an AMD module, a Node.js module, or a plain object.

AMD (RequireJS) installation

Place publisher.js in your application and require it as usual, it registers anonymously.

require(['path/to/publisher'], function (publisher) {
  /* Do stuff with publisher here */
});

Node.js Installation

Install with npm

npm install publisher

Include like everything else

var publisher = require('publisher');

Other browser usage

If neither AMD nor Node.js are detected, publisher is global with a noConflict that restores the previous publisher definition and returns the publisher object.

publisher
publisher.noConflict();

License & Copyright

MIT-Style License

Contributing

Fork, create a topic branch, send a pull request :D

Development dependencies

While publisher has no dependencies, developing it does.

You'll need to install some stuff to run the tests and generate docs. There's a script in bin to help. First make sure you've got Node.js, npm, and Python installed, then simply run from the repository root:

$ ./bin/setup-dev

Running tests

$ ./bin/run-tests
# or
$ tap test/test.js

Generating docs

$ ./bin/generate-docs

publisher.js's People

Contributors

Stargazers

Watchers

publisher.js's Issues

adds `$.publisher` in MooTools?

Please say it isn't so

`noConflict` to keep from clobbering `window.publisher`

Feature request: add a way to handle all messages of a topic

Whats currently missing is a way to subscribe to all messages of a topic or even all messages flowing to publisher to log them. This could be useful for automatically do something with sub topics which the system dosent know before.

An possible way to do this, would be something like that:

publisher.subscribe('sensors/*', function(data){
..
});

Errors as AMD module with RequireJS Optimization

When run as an AMD module and optimized by @jrburke 's RequireJS, Publisher fails to be defined as a module. Instead an empty define('publisher', function(){}) is produced, breaking any code Publisher-dependent code.

Quoting @jrburke from ded/morpheus#19 , in which an identical problem and its solution are discussed:

The issue is that the requirejs optimizer uses an AST to find define() calls that look like AMD define calls. Since define(definition) is a bit too generic it skips it and puts in an empty module for the 'morpheus' name.

Two possible easy fixes:

Use a function literal:

if (typeof define == 'function') define(function(){return definition()})

Or just pass name to the function:

if (typeof define == 'function') define(name, definition)

access the arguments in an after callback

the registration of an after callback is currently function(returnValue, object), ideally it should be something like function(returnValue, object, arg1, arg2, …) so that you can access the arguments without having to also create a before and cache them.

Recommend Projects

ryanflorence / publisher.js Goto Github PK