2022-07-05 13:41:43 +00:00
|
|
|
---
|
2023-09-13 13:47:55 +00:00
|
|
|
sidebar_label: PageEvents
|
2022-07-05 13:41:43 +00:00
|
|
|
---
|
|
|
|
|
2023-09-13 13:47:55 +00:00
|
|
|
# PageEvents interface
|
2022-07-05 13:41:43 +00:00
|
|
|
|
|
|
|
Denotes the objects received by callback functions for page events.
|
|
|
|
|
2023-09-13 13:47:55 +00:00
|
|
|
See [PageEvent](./puppeteer.pageevent.md) for more detail on the events and when they are emitted.
|
2022-07-05 13:41:43 +00:00
|
|
|
|
2022-10-24 07:07:05 +00:00
|
|
|
#### Signature:
|
2022-07-05 13:41:43 +00:00
|
|
|
|
|
|
|
```typescript
|
2023-09-13 13:47:55 +00:00
|
|
|
export interface PageEvents extends Record<EventType, unknown>
|
2022-07-05 13:41:43 +00:00
|
|
|
```
|
|
|
|
|
2023-11-13 12:27:17 +00:00
|
|
|
**Extends:** Record<[EventType](./puppeteer.eventtype.md), unknown>
|
2023-09-13 13:47:55 +00:00
|
|
|
|
2022-07-05 13:41:43 +00:00
|
|
|
## Properties
|
|
|
|
|
2024-03-20 15:03:14 +00:00
|
|
|
<table><thead><tr><th>
|
|
|
|
|
|
|
|
Property
|
|
|
|
|
|
|
|
</th><th>
|
|
|
|
|
|
|
|
Modifiers
|
|
|
|
|
|
|
|
</th><th>
|
|
|
|
|
|
|
|
Type
|
|
|
|
|
|
|
|
</th><th>
|
|
|
|
|
|
|
|
Description
|
|
|
|
|
|
|
|
</th><th>
|
|
|
|
|
|
|
|
Default
|
|
|
|
|
|
|
|
</th></tr></thead>
|
|
|
|
<tbody><tr><td>
|
|
|
|
|
|
|
|
close
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
undefined
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
|
|
|
console
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
[ConsoleMessage](./puppeteer.consolemessage.md)
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
|
|
|
dialog
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
[Dialog](./puppeteer.dialog.md)
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
|
|
|
domcontentloaded
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
undefined
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
|
|
|
error
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
Error
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
|
|
|
frameattached
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
[Frame](./puppeteer.frame.md)
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
|
|
|
framedetached
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
[Frame](./puppeteer.frame.md)
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
|
|
|
framenavigated
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
[Frame](./puppeteer.frame.md)
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
|
|
|
load
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
undefined
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
|
|
|
metrics
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
{ title: string; metrics: [Metrics](./puppeteer.metrics.md); }
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
|
|
|
pageerror
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
Error
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
|
|
|
popup
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
[Page](./puppeteer.page.md) \| null
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
|
|
|
request
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
[HTTPRequest](./puppeteer.httprequest.md)
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
|
|
|
requestfailed
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
[HTTPRequest](./puppeteer.httprequest.md)
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
|
|
|
requestfinished
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
[HTTPRequest](./puppeteer.httprequest.md)
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
|
|
|
requestservedfromcache
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
[HTTPRequest](./puppeteer.httprequest.md)
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
|
|
|
response
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
[HTTPResponse](./puppeteer.httpresponse.md)
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
|
|
|
workercreated
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
[WebWorker](./puppeteer.webworker.md)
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
|
|
|
workerdestroyed
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
[WebWorker](./puppeteer.webworker.md)
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
</tbody></table>
|