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.
- See:
Methods
-
addEventListener()
-
An alias of EventTarget#on. Allows
EventTargetto mimic the standard DOM API.- See:
-
any(type, fn)
-
This function will add an
event listenerthat gets triggered only once and is removed from all events. This is like adding an array ofevent listeners with EventTarget#on that calls EventTarget#off on all events the first time it is triggered.Parameters:
Name Type Description typestring | Array.<string> An event name or an array of event names.
fnfunction The function to be called once for each event name.
-
dispatchEvent()
-
An alias of EventTarget#trigger. Allows
EventTargetto mimic the standard DOM API.- See:
-
off(type, fn)
-
Removes an
event listenerfor a specific event from an instance ofEventTarget. This makes it so that theevent listenerwill no longer get called when the named event happens.Parameters:
Name Type Description typestring | Array.<string> An event name or an array of event names.
fnfunction The function to remove.
-
on(type, fn)
-
Adds an
event listenerto an instance of anEventTarget. Anevent listeneris a function that will get called when an event with a certain name gets triggered.Parameters:
Name Type Description typestring | Array.<string> An event name or an array of event names.
fnfunction The function to call with
EventTargets -
one(type, fn)
-
This function will add an
event listenerthat gets triggered only once. After the first trigger it will get removed. This is like adding anevent listenerwith EventTarget#on that calls EventTarget#off on itself.Parameters:
Name Type Description typestring | Array.<string> An event name or an array of event names.
fnfunction The function to be called once for each event name.
-
removeEventListener()
-
An alias of EventTarget#off. Allows
EventTargetto mimic the standard DOM API.- See:
-
trigger(event)
-
This function causes an event to happen. This will then cause any
event listenersthat are waiting for that event, to get called. If there are noevent listenersfor an event then nothing will happen.If the name of the
Eventthat is being triggered is inEventTarget.allowedEvents_. Trigger will also call theon+uppercaseEventNamefunction.Example: 'click' is in
EventTarget.allowedEvents_, so, trigger will attempt to callonClickif it exists.Parameters:
Name Type Description eventstring | EventTarget~Event | Object The name of the event, an
Event, or an object with a key of type set to an event name.
Type Definitions
-
EventListener(event, hashopt)
-
All event listeners should follow the following format.
This:
Parameters:
Name Type Attributes Description eventEvent the event that triggered this function
hashObject <optional>
hash of data sent during the event