kist-pubsub

Simple publish/subscribe system.

Installation

npm install kist-pubsub --save
 
bower install kist-pubsub --save

API

new PubSub(options)

Returns: PubSub

options

Type: Object

Instance options.

.publish(event, data)

Publish data for specific event.

event

Type: String
Required

Event to publish.

data

Type: Array|Object
Required

Data to pass via published event. Behaves same as trigger in standard jQuery event system.

In addition to behaving like jQuery trigger, if you pass more than one argument (not counting event), all arguments will be passed as list of arguments to subscribe methods.

.subscribe(event, callback, condition)

Subscribe to specific event.

event

Type: String
Required

Event to subscribe to.

callback

Type: Function
Required

Callback to run when event is published. Provided arguments are:

condition

Type: Function

If return value is truthy value, it will activate callback function. Gets same arguments like callback.

.subscribeOnce(event, callback, condition)

Subscribe to specific event only once.

API is same as for subscribe.

.unsubscribe(event)

Unsubscribes from specific event.

event

Type: String
Required

Event to unsubscribe from.

.destroy()

Destroy/unsubscribe from all events.

Examples

Initialization.

var PubSub = require('kist-pubsub');
var pubsub = new PubSub({
    event: true,
    queue: false,
    namespace: 'appNs'
});

Trigger event with specific data.

pubsub.publish('foo.bar', 1);
pubsub.publish('foo.bar', 'foobar');
pubsub.publish('foo.bar', ['foo', 'bar']);
pubsub.publish('foo.bar', {'foo':'bar'});

Subscribe to event foo.bar.

pubsub.subscribe('foo.bar', function ( e, arg1, arg2 ) {});
pubsub.subscribe('foo.bar', function ( e, arg1, arg2 ) {}, function () {
    if ( condition ) {
        return true;
    }
    return false;
});

Subscribe only once to event foo.bar.

pubsub.subscribeOnce('foo.bar', function ( e, arg1, arg2 ) {});
pubsub.subscribeOnce('foo.bar', function ( e, arg1, arg2 ) {}, function () {
    if ( condition ) {
        return true;
    }
    return false;
});

Unsubscribe from event foo.bar.

pubsub.unsubscribe('foo.bar');

Destroy/unsubscribe from all events.

pubsub.destroy();

AMD and global

define(['kist-pubsub'], cb);
 
window.$.kist.PubSub;

Browser support

Tested in IE8+ and all modern browsers.

Acknowledgments

Plugin is based on jQuery tiny pub/sub but implements some options available either in previous versions or from community contributions.

• Event argument removal
• Queue system

License

MIT © Ivan Nikolić