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

signals :module:mixins/signalable.SignalOptions

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

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

Source:

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

<private> _loadSignals()

Interprets the signals hash and instantiates it

Source:

<private> destroy()

Clean up

Source:

refreshSignals()

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

Source:
DocStrap Copyright © 2012-2014 The contributors to the JSDoc3 and DocStrap projects.
Documentation generated by JSDoc 3.3.0-alpha5 on Fri Jun 27th 2014 using the DocStrap template.