Skip to main content
Version: 15.5.0

EventEmitter.emit() method

Emit an event and call any associated listeners.

Signature:

class EventEmitter {
emit(event: EventType, eventData?: unknown): boolean;
}

Parameters

ParameterTypeDescription
eventEventTypethe event you'd like to emit
eventDataunknown(Optional) any data you'd like to emit with the event

Returns:

boolean

true if there are any listeners, false if there are not.