puppeteer/docs/api/puppeteer.eventemitter.on.md

67 lines
854 B
Markdown
Raw Permalink Normal View History

2022-07-05 13:41:43 +00:00
---
sidebar_label: EventEmitter.on
---
# EventEmitter.on() method
Bind an event listener to fire when an event occurs.
#### Signature:
2022-07-05 13:41:43 +00:00
```typescript
class EventEmitter {
2023-09-13 13:47:55 +00:00
on<Key extends keyof EventsWithWildcard<Events>>(
type: Key,
handler: Handler<EventsWithWildcard<Events>[Key]>
): this;
2022-07-05 13:41:43 +00:00
}
```
## Parameters
<table><thead><tr><th>
2022-07-05 13:41:43 +00:00
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](./puppeteer.handler.md)&lt;[EventsWithWildcard](./puppeteer.eventswithwildcard.md)&lt;Events&gt;\[Key\]&gt;
</td><td>
the function to be called when the event occurs.
</td></tr>
</tbody></table>
2022-07-05 13:41:43 +00:00
**Returns:**
this
2022-07-05 13:41:43 +00:00
`this` to enable you to chain method calls.