EventBus
Kind: global interface
eventBus.fire(eventTarget, eventName, data, [options]) ⇒ EventBus
Fires a new custom event of the specified name, carrying the provided data.
Note that this method does not prevent the event listeners to modify the data in any way. The order in which the event listeners will be executed is unspecified and should not be relied upon.
Note that the default options are
{ bubbles: true, cancelable: true
}, which is different from the
default values used in the native custom events
({ bubbles: false, cancelable: false
}).
Kind: instance method of EventBus
Returns: EventBus
- This custom event bus.
Throws:
Error
Thrown if the provided event target cannot be used to fire the event.
See: https://developer.mozilla.org/en-US/docs/Web/API/Event/Event
Param | Type | Default | Description |
---|---|---|---|
eventTarget | EventTarget |
The event target at which the event will be dispatched (e.g. element/document/window). | |
eventName | string |
The name of the event to fire. | |
data | \* |
The data to pass to the event listeners. | |
[options] | Object |
{} |
The override of the default options passed to the constructor of the custom event fired by this event bus. The default options passed to the custom event constructor are { bubbles: true, cancelable: true }. |
eventBus.listenAll(eventTarget, listener) ⇒ EventBus
Registers the provided event listener to be executed when any custom event is fired using the same implementation of the event bus and passes through the specified event target.
When the specified event is fired, the event listener will be executed with the event passed as the first argument.
The order in which the event listeners will be executed is unspecified and should not be relied upon.
Kind: instance method of EventBus
Returns: EventBus
- This event bus.
Param | Type | Description |
---|---|---|
eventTarget | EventTarget |
The event target at which the listener should listen for all event bus events. |
listener | function |
The event listener to register. |
eventBus.listen(eventTarget, eventName, listener) ⇒ EventBus
Registers the provided event listener to be executed when the specific custom event is fired by the same implementation of the event bus and passes through the specified event target.
When the specified event is fired, the event listener will be executed with the event passed as the first argument.
The order in which the event listeners will be executed is unspecified and should not be relied upon.
Kind: instance method of EventBus
Returns: EventBus
- This event bus.
Param | Type | Description |
---|---|---|
eventTarget | EventTarget |
The event target at which the listener should listen for the specified event. |
eventName | string |
The name of the event to listen for. |
listener | function |
The event listener to register. |
eventBus.unlistenAll(eventTarget, listener) ⇒ EventBus
Removes the provided event listener from the set of event listeners executed when the any custom event fired by the same implementation passes through the specified event target.
The method has no effect if the listener is not registered at the specified event target.
Kind: instance method of EventBus
Returns: EventBus
- This event bus.
Param | Type | Description |
---|---|---|
eventTarget | EventTarget |
The event target at which the event listener listens for events. |
listener | function |
The event listener to deregister. |
eventBus.unlisten(eventTarget, eventName, listener) ⇒ EventBus
Removes the provided event listener from the set of event listeners executed when the specified custom event fired by the same implementation passes through the specified event target.
The method has no effect if the listener is not registered for the specified event at the specified event target.
Kind: instance method of EventBus
Returns: EventBus
- This event bus.
Param | Type | Description |
---|---|---|
eventTarget | EventTarget |
The event target at which the listener is listening for the event. |
eventName | string |
The name of the event listened for. |
listener | function |
The event listener to deregister. |