puppeteer/docs/api/puppeteer.eventemitter.on.md
jrandolf f07ad2c661
fix: update documentation on configuring puppeteer (#9150)
This PR updates the docs regarding configuring puppeteer. In addition,
some changes have been made to the documentation generator to show
default values on the documentation site.

Also fixes: https://github.com/puppeteer/puppeteer/pull/9144
2022-10-24 09:07:05 +02:00

29 lines
848 B
Markdown

---
sidebar_label: EventEmitter.on
---
# EventEmitter.on() method
Bind an event listener to fire when an event occurs.
#### Signature:
```typescript
class EventEmitter {
on(event: EventType, handler: Handler): EventEmitter;
}
```
## Parameters
| Parameter | Type | Description |
| --------- | ------------------------------------- | ------------------------------------------------------------------ |
| event | [EventType](./puppeteer.eventtype.md) | the event type you'd like to listen to. Can be a string or symbol. |
| handler | [Handler](./puppeteer.handler.md) | the function to be called when the event occurs. |
**Returns:**
[EventEmitter](./puppeteer.eventemitter.md)
`this` to enable you to chain method calls.