Mixin: mixins/bussable

mixins/bussable

Provides easy access to the system bus and provides some helper methods for doing so

Methods

getSubscription(channel, topic) → {object}

Get a subscription definition

Parameters:
Name Type Description
channel string
topic string
Source:
Returns:

The subscription definition

Type
object

once(channel, topic, callback) → {object}

Subscribe to an event once

Parameters:
Name Type Description
channel string

The channel to subscribe to

topic string

The topic to subscribe to

callback callback

What to do when you get the event

Source:
Returns:

The subscription definition

Type
object

publish(channel, topic, options)

Publish an event on the system bus

Parameters:
Name Type Argument Description
channel string

The channel to publish to

topic string

The topic to publish to

options object <optional>

What to pass to the event

Source:

subscribe(channel, topic, callback) → {object}

Subscribe to an event

Parameters:
Name Type Description
channel string

The channel to subscribe to

topic string

The topic to subscribe to

callback callback

What to do when you get the event

Source:
Returns:

The subscription definition

Type
object
DocStrap Copyright © 2012-2013 The contributors to the JSDoc3 and DocStrap projects.
Documentation generated by JSDoc 3.3.0-alpha5 on Mon Jul 7th 2014 using the DocStrap template.