Skip to main content
Version: 22.13.1

EventEmitter.on() method

Bind an event listener to fire when an event occurs.

Signature:

class EventEmitter {
on<Key extends keyof EventsWithWildcard<Events>>(
type: Key,
handler: Handler<EventsWithWildcard<Events>[Key]>
): this;
}

Parameters

Parameter

Type

Description

type

Key

the event type you'd like to listen to. Can be a string or symbol.

handler

Handler<EventsWithWildcard<Events>[Key]>

the function to be called when the event occurs.

Returns:

this

this to enable you to chain method calls.