API

Classes

MiniSignalBinding

MiniSignal

## MiniSignalBinding **Kind**: global class **Api**: private ### new MiniSignalBinding(fn, [once]) MiniSignalBinding constructor.

Param	Type	Default	Description
fn	function		Event handler to be called.
[once]	Boolean	false	Should this listener be removed after dispatch

MiniSignal

Kind: global class
Api: public

• MiniSignal
  • new MiniSignal()
  • .handlers([exists]) ⇒ Array.<MiniSignalBinding> | Boolean
  • .dispatch() ⇒ Boolean
  • .add(fn) ⇒ MiniSignalBinding
  • .once(fn) ⇒ MiniSignalBinding
  • .detach(node) ⇒ MiniSignal
  • .detachAll() ⇒ MiniSignal

new MiniSignal()

MiniSignal constructor.

Example

let mySignal = new MiniSignal();
let binding = mySignal.add(onSignal);
mySignal.dispatch('foo', 'bar');
mySignal.detach(binding);

miniSignal.handlers([exists]) ⇒ Array.<MiniSignalBinding> | Boolean

Return an array of attached MiniSignalBinding.

Kind: instance method of MiniSignal
Returns: Array.<MiniSignalBinding> | Boolean - Array of attached MiniSignalBinding or Boolean if called with exists = true
Api: public

Param	Type	Default	Description
[exists]	Boolean	false	We only need to know if there are handlers.

miniSignal.dispatch() ⇒ Boolean

Dispaches a signal to all registered listeners.

Kind: instance method of MiniSignal
Returns: Boolean - Indication if we've emitted an event.
Api: public

miniSignal.add(fn) ⇒ MiniSignalBinding

Register a new listener.

Kind: instance method of MiniSignal
Returns: MiniSignalBinding - The MiniSignalBinding node that was added.
Api: public

Param	Type	Description
fn	function	Callback function.

miniSignal.once(fn) ⇒ MiniSignalBinding

Register a new listener that will be executed only once.

Kind: instance method of MiniSignal
Returns: MiniSignalBinding - The MiniSignalBinding node that was added.
Api: public

Param	Type	Description
fn	function	Callback function.

miniSignal.detach(node) ⇒ MiniSignal

Remove binding object.

Kind: instance method of MiniSignal
Returns: MiniSignal - The instance on which this method was called.
Api: public

Param	Type	Description
node	MiniSignalBinding	The binding node that will be removed.

miniSignal.detachAll() ⇒ MiniSignal

Detach all listeners.

Kind: instance method of MiniSignal
Returns: MiniSignal - The instance on which this method was called.
Api: public