mixins/bussable

Descripción

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

Detalles

Miembros


<private> _subscriptions :Array

Descripción

The list of subscriptions maintained by the mixin

Detalles
Array

Métodos


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

Descripción

Subscribe to an event

Parámetros
Nombre Tipo Atributos Descripción
channel string

The channel to subscribe to

topic string

The topic to subscribe to

callback callback <optional>

What to do when you get the event

Returns

The subscription definition

Detalles

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

Descripción

Subscribe to an event once

Parámetros
Nombre Tipo Atributos Descripción
channel string

The channel to subscribe to

topic string <optional>

The topic to subscribe to

callback callback <optional>

What to do when you get the event

Returns

The subscription definition

Detalles

publish( [ channel [, topic [, options ] ] ] )

Descripción

Publish an event on the system bus

Parámetros
Nombre Tipo Atributos Valor por defecto Descripción
channel string <optional>
'2'

The channel to publish to

topic string <optional>
1

The topic to publish to

options object <optional>
{}

What to pass to the event

Nombre Tipo Atributos Valor por defecto Descripción
ha boolean <optional>
2

Test sub prop

Detalles

getSubscription( channel, topic ) → {object}

Descripción

Get a subscription definition

Parámetros
Nombre Tipo Descripción
channel string
topic string
Returns

The subscription definition

Detalles

<private> destroy()

Descripción

Gets rid of all subscriptions for this object.

Detalles