Oblivion

Mixin: mixins/signalable

mixins/signalable

Make an object capable of handling a signal. Or many signals.

Extends

Members

autoLoadSignals :boolean

When true, the class will load the `signals` hash and create the signal definitions during construction
Type:
  • boolean

signals :hash|function

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
Type:
  • hash | function

Methods

<private> _addSignal(name, options)

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

<private> _addSignals(signals)

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

<private> _loadSignals()

Interprets the `signals` hash and instantiates it

<private> destroy()

Clean up

refreshSignals()

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