new Signal( host, name )

Description

A signal that can be raised on an object. When you deploy the Signalable mixin, it
creates instances of these for you.

Parameters
Name Type Attributes Description
host object <nullable>

If hosted, you can identify the host here.

name string <nullable>

The name of the signal

Methods


<private> destroy()

Description

Cleans up

Details

on( listener, listenerContext, priority ) → {SignalBinding}

Description

Ties a listener to a signal.

Parameters
Name Type Attributes Description
listener function

The function to call when the signal is raised

listenerContext object <nullable>

A context to set for the listener. The event host may set a default for this value, but you may override that here.

priority number <nullable>

A priority for the listener.

Returns
Details

once( listener, listenerContext, priority ) → {SignalBinding}

Description

Ties a listener to for a signal for one execution.

Parameters
Name Type Attributes Description
listener function

The function to call when the signal is raised

listenerContext object <nullable>

A context to set for the listener. The event host may set a default for this value, but you may override that here.

priority number <nullable>

A priority for the listener.

Returns

off( listener, listenerContext ) → {function}

Description

Unbinds a listener to a signal.

Parameters
Name Type Attributes Description
listener function

The function to unbind

listenerContext object <nullable>

The context that was bound

Returns

has( listener, listenerContext ) → {boolean}

Description

Check if listener was attached to Signal.

Parameters
Name Type Attributes Description
listener function

The function to check

listenerContext object <nullable>

The context that was bound

Returns

toString()

Description

Strings!