Event Handle that is created by EventHandler and can be used for easier event removal and management.

Example

const evt = obj.on('test', (a, b) => {
console.log(a + b);
});
obj.fire('test');

evt.off(); // easy way to remove this event
obj.fire('test'); // this will not trigger an event

Example

// store an array of event handles
let events = [ ];

events.push(objA.on('testA', () => { }));
events.push(objB.on('testB', () => { }));

// when needed, remove all events
events.forEach((evt) => {
evt.off();
});
events = [ ];

Constructors

Properties

Accessors

Methods

Constructors

  • Parameters

    • handler: EventHandler

      source object of the event.

    • name: string

      Name of the event.

    • callback: HandleEventCallback

      Function that is called when event is fired.

    • scope: object

      Object that is used as this when event is fired.

    • Optional once: boolean = false

      If this is a single event and will be removed after event is fired.

    Returns EventHandle

Properties

_removed: boolean = false

True if event has been removed.

handler: EventHandler
name: string

Accessors

Methods