poopsoup

Minimal pubsub module.

Usage

Node

var pubsub = require("poopsoup");
// do stuff with pubsub

AMD

require(["poopsoup"], function (pubsub) {
    // do stuff with pubsub
});

Global in browser

// do stuff with globally available poopsoup

Universal

// define a topic.
var topic = "tweet";

// optionally keep track of new subscribers
// by subscribing to topic subscriptions.
pubsub.onSubscribe(topic, function (topic, data) {
    console.log("I now have", data.subscribers, "subscriber(s)! :)");
});

// unsubscriptions can be tracked in the same manner.
pubsub.onUnsubscribe(topic, function (topic, data) {
    console.log("I now have", data.subscribers, "subscriber(s)... :(");
});

// subscribe in regular pubsub fashion
// with a topic and a callback.
// a unique subscription object is returned
// for unsubscription later.
var subscription = pubsub.subscribe(topic, function (topic, data) {
    console.log("I just tweeted:", data);
});

// logged: I now have 1 subscriber(s)! :)

// publish data to all subscribers.
pubsub.publish(topic, "Woah! That's an unsanitary module name if I ever saw one... #yuck");

// logged: I just tweeted: Woah! That's an unsanitary module name if I ever saw one... #yuck

// unsubscribe.
subscription.remove();

// logged: I now have 0 subscriber(s)... :(

Methods

publish

Arguments

• topic - Topic to publish.
• data - Data to publish for topic.

Returns

null

subscribe

Arguments

• topic - Topic to subscribe to.
• callback - Callback to call when data is published for the given topic. The callback function receives the following arguments:
  • topic - The topic of the subscription.
  • data - The published data.

Returns

Object A subscription object containing a remove method that cancels the subscription when called.

onSubscribe

Can be used to be messaged whenever a topic gets subscribed to.

Arguments

• topic - Topic to subscribe receive subscription events for.
• callback - Callback for subscription events. The callback function receives the following arguments:
  • topic - The topic of the subscription.
  • data - The subscription status which is an object containing the following information:
    • subscribers - The number of current active subscribers.

onUnsubscribe

Can be used to be messaged whenever a topic gets unsubscribed.

Arguments

• topic - Topic to subscribe receive unsubscription events for.
• callback - Callback for unsubscription events. The callback function receives the following arguments:
  • topic - The topic of the subscription.
  • data - The subscription status which is an object containing the following information:
    • subscribers - The number of current active subscribers.