Oblivion

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
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
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

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
Returns:
The subscription definition
Type
object