puppeteer/docs/api/puppeteer.page.on.md
jrandolf f07ad2c661
fix: update documentation on configuring puppeteer ()
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

36 lines
966 B
Markdown

---
sidebar_label: Page.on
---
# Page.on() method
Listen to page events.
:::note
This method exists to define event typings and handle proper wireup of cooperative request interception. Actual event listening and dispatching is delegated to [EventEmitter](./puppeteer.eventemitter.md).
:::
#### Signature:
```typescript
class Page {
on<K extends keyof PageEventObject>(
eventName: K,
handler: (event: PageEventObject[K]) => void
): EventEmitter;
}
```
## Parameters
| Parameter | Type | Description |
| --------- | -------------------------------------------------------------------------- | ----------- |
| eventName | K | |
| handler | (event: [PageEventObject](./puppeteer.pageeventobject.md)\[K\]) =&gt; void | |
**Returns:**
[EventEmitter](./puppeteer.eventemitter.md)