Constructor
new Signal(hostnullable, namenullable)
- Source:
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
has(listener, listenerContextnullable) → {boolean}
- Source:
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:
- Type
- boolean
off(listener, listenerContextnullable) → {function}
- Source:
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:
- Type
- function
on(listener, listenerContextnullable, prioritynullable) → {SignalBinding}
- Source:
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:
- Type
- SignalBinding
once(listener, listenerContextnullable, prioritynullable) → {SignalBinding}
- Source:
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:
- Type
- SignalBinding
toString()
- Source:
Strings!