mixins/signalable

Members

---

autoLoadSignals :boolean

Description

When true, the class will load the signals hash and create the signal definitions during construction

Details

Type

boolean

Source

mixins/signalable.js, line 230

---

signals :hash|function

Description

A hash of signals to create automatically. Each definition consists of a name for the signal as the key
and then a hash of options (nullable) for each signal

Details

Type

hash | function

Source

mixins/signalable.js, line 238

Methods

---

refreshSignals()

Description

When you make a change to the signals hash after loading, then you can make it reload

Details

Source

mixins/signalable.js, line 165

---

<private> _loadSignals()

Description

Interprets the signals hash and instantiates it

Details

Source

mixins/signalable.js, line 173

---

<private> _addSignal( name, options )

Description

Creates a single signal

Parameters

Name	Type	Description
name	string	The name of the signal
options	module:mixins/signalable~SignalOptions	The options the signal expects

Details

Source

mixins/signalable.js, line 197

---

<private> _addSignals( signals )

Description

Add a signal to an object. If any members of the hash already exist in this.signals, they will be overwritten.

Parameters

Name	Type	Description
signals	module:mixins/signalable.SignalOptions

Details

Source

mixins/signalable.js, line 208

---

<private> destroy()

Description

Clean up

Details

Source

mixins/signalable.js, line 217