new EventTarget()
EventTarget is a class that can have the same API as the DOM EventTarget. It adds shorthand functions that wrap around lengthy functions. For example: the on function is a wrapper around addEventListener.
- Source
Members
(protected) allowedEvents_
An object containing event names as keys and booleans as values.
NOTE: If an event name is set to a true value here EventTarget#trigger will have extra functionality. See that function for more information.
| Name | Type | Description |
|---|---|---|
EventTarget.prototype.allowedEvents_ |
- Source
Methods
addEventListener()
An alias of EventTarget#on. Allows EventTarget to mimic the standard DOM API.
- Source
any(type, fn)
This function will add an event listener that gets triggered only once and is removed from all events. This is like adding an array of event listeners with EventTarget#on that calls EventTarget#off on all events the first time it is triggered.
| Name | Type | Description |
|---|---|---|
type | string | | An event name or an array of event names. |
fn | function | The function to be called once for each event name. |
- Source
dispatchEvent()
An alias of EventTarget#trigger. Allows EventTarget to mimic the standard DOM API.
- Source
off(type, fn)
Removes an event listener for a specific event from an instance of EventTarget. This makes it so that the event listener will no longer get called when the named event happens.
| Name | Type | Description |
|---|---|---|
type | string | | An event name or an array of event names. |
fn | function | The function to remove. |
- Source
on(type, fn)
Adds an event listener to an instance of an EventTarget. An event listener is a function that will get called when an event with a certain name gets triggered.
| Name | Type | Description |
|---|---|---|
type | string | | An event name or an array of event names. |
fn | function | The function to call with |
- Source
one(type, fn)
This function will add an event listener that gets triggered only once. After the first trigger it will get removed. This is like adding an event listener with EventTarget#on that calls EventTarget#off on itself.
| Name | Type | Description |
|---|---|---|
type | string | | An event name or an array of event names. |
fn | function | The function to be called once for each event name. |
- Source
removeEventListener()
An alias of EventTarget#off. Allows EventTarget to mimic the standard DOM API.
- Source
trigger(event)
This function causes an event to happen. This will then cause any event listeners that are waiting for that event, to get called. If there are no event listeners for an event then nothing will happen.
If the name of the Event that is being triggered is in EventTarget.allowedEvents_. Trigger will also call the on + uppercaseEventName function.
Example: 'click' is in EventTarget.allowedEvents_, so, trigger will attempt to call onClick if it exists.
| Name | Type | Description |
|---|---|---|
event | string | | The name of the event, an |
- Source