pencil.js / event-emitter / EventEmitter

Class: EventEmitter

Defined in: event-emitter.ts:31

Able to listen and fire events

Extended by

• Container

Constructors

Constructor

new EventEmitter(): EventEmitter;

Defined in: event-emitter.ts:38

EventEmitter constructor

Returns

EventEmitter

Properties

Property	Type	Description	Defined in
eventListeners	Record<string, EventListener[]>	Set of event listeners of this component	event-emitter.ts:33

Accessors

events

Get Signature

get static events(): Record<string, string>;

Defined in: event-emitter.ts:135

Set of events for easy access

Returns

Record<string, string>

Methods

fire()

fire(event): this;

Defined in: event-emitter.ts:84

Trigger an event

Parameters

Parameter	Type	Description
event	BaseEvent	Event to trigger

Returns

this

Itself

---

on()

on(
   eventName, 
   callback, 
   isTargeted?
): this;

Defined in: event-emitter.ts:51

Listen to an event or multiple events

Parameters

Parameter	Type	Default value	Description
eventName	string | string[]	undefined	Name of event (or a list of event names) to listen to. The event name can be followed by a modifier (separated by a ".")
callback	EventCallback	undefined	Function to call when event fire
isTargeted?	boolean	false	Should only listen to event targeting itself

Returns

this

Itself

Example

component.on("event.modifier", () => console.log("Event fired with modifier"));

---

once()

once(
   eventName, 
   callback, 
   isTargeted?
): this;

Defined in: event-emitter.ts:71

Listen to an event only once

Parameters

Parameter	Type	Default value	Description
eventName	string | string[]	undefined	Name of event (or a list of event names) to listen to.
callback	EventCallback	undefined	Function to call when event fire
isTargeted?	boolean	false	Should only listen to event targeting itself

Returns

this

Itself

---

removeAllListener()

removeAllListener(): this;

Defined in: event-emitter.ts:127

Remove all event listeners

Returns

this

Itself

---

removeListener()

removeListener(eventName, callback?): this;

Defined in: event-emitter.ts:105

Remove an event or multiple events

Parameters

Parameter	Type	Description
eventName	string | string[]	Name of event (or a list of event names) to remove
callback?	EventCallback<any>	Specify the callback to remove, if not defined remove all listeners

Returns

this

Itself