API Reference

Class List

EventHandle

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

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
// 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 = [ ];

Summary

Properties

removed

Mark if event has been removed.

Methods

off

Remove this event from its handler.

Details

Constructor

EventHandle(handler, name, callback, scope, [once])

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
// 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 = [ ];

Parameters

handlerEventHandler

source object of the event.

namestring

Name of the event.

callbackHandleEventCallback

Function that is called when event is fired.

scopeobject

Object that is used as this when event is fired.

onceboolean

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

Properties

booleanremoved

Mark if event has been removed.

Methods

off()

Remove this event from its handler.