Class Evented

Methods mixed in to other classes for event capabilities.

Hierarchy (view full)

Evented

Index

Methods

listens off on once setEventedParent

Methods

listens

listens(type): boolean
Returns a true if this instance of Evented or any forwardeed instances of Evented have a listener for the specified type.
Parameters
- type: string
  The event type
Returns boolean
true if there is at least one registered listener for specified event type, false otherwise

off

off(type, listener): Evented
Removes a previously registered event listener.
Parameters
- type: string
  The event type to remove listeners for.
- listener: Listener
  The listener function to remove.
Returns Evented

on

on(type, listener): this
Adds a listener to a specified event type.
Parameters
- type: string
  The event type to add a listen for.
- listener: Listener
  The function to be called when the event is fired. The listener function is called with the data object passed to fire, extended with target and type properties.
Returns this

once

once(type, listener?): Promise<any> | Evented
Adds a listener that will be called only once to a specified event type.

The listener will be called first time the event fires after the listener is registered.
Parameters
- type: string
  The event type to listen for.
- Optional listener: Listener
  The function to be called when the event is fired the first time.
Returns Promise<any> | Evented
this or a promise if a listener is not provided

setEventedParent

setEventedParent(parent?, data?): Evented
Bubble all events fired by this instance of Evented to this parent instance of Evented.
Parameters
- Optional parent: Evented
- Optional data: any
Returns Evented