Back to Puppeteer

EventEmitter.on() method

website/versioned_docs/version-24.40.0/api/puppeteer.eventemitter.on.md

19.2.2813 B
Original Source

EventEmitter.on() method

Bind an event listener to fire when an event occurs.

Signature

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

Parameters

<table><thead><tr><th>

Parameter

</th><th>

Type

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

type

</td><td>

Key

</td><td>

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

</td></tr> <tr><td>

handler

</td><td>

Handler<EventsWithWildcard<Events>[Key]>

</td><td>

the function to be called when the event occurs.

</td></tr> </tbody></table>

Returns:

this

this to enable you to chain method calls.