Methods
(static) call(hook, …args)
- Source:
Call hook listeners in the order in which they were registered.
Continue calling hooks until either all have been called or one returns false.
Hook listeners which return false denote that the original event has been adequately handled and no further
hooks should be called.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
hook |
string | The hook being triggered |
|
args |
* |
<repeatable> |
Arguments passed to the hook callback functions |
(static) callAll(hook, …args)
- Source:
Call all hook listeners in the order in which they were registered Hooks called this way can not be handled by returning false and will always trigger every hook callback.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
hook |
string | The hook being triggered |
|
args |
* |
<repeatable> |
Arguments passed to the hook callback functions |
(static) off(hook, fn)
- Source:
Unregister a callback handler for a particular hook event
Parameters:
| Name | Type | Description |
|---|---|---|
hook |
string | The unique name of the hooked event |
fn |
function | number | The function, or ID number for the function, that should be turned off |
(static) on(hook, fn) → {number}
- Source:
Register a callback handler which should be triggered when a hook is triggered.
Parameters:
| Name | Type | Description |
|---|---|---|
hook |
string | The unique name of the hooked event |
fn |
function | The callback function which should be triggered when the hook event occurs |
Returns:
An ID number of the hooked function which can be used to turn off the hook later
- Type
- number
(static) once(hook, fn) → {number}
- Source:
Register a callback handler for an event which is only triggered once the first time the event occurs. After a "once" hook is triggered the hook is automatically removed.
Parameters:
| Name | Type | Description |
|---|---|---|
hook |
string | The unique name of the hooked event |
fn |
function | The callback function which should be triggered when the hook event occurs |
Returns:
An ID number of the hooked function which can be used to turn off the hook later
- Type
- number