ba7624a6df
* chore(docs): migrate & document all Page events Rather than a generic `Events.ts` file we can instead document events as an enum within each individual class. It's easier to document and work with, and it's clearer where events originate from.
38 lines
3.6 KiB
Markdown
38 lines
3.6 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [puppeteer](./puppeteer.md) > [PageEmittedEvents](./puppeteer.pageemittedevents.md)
|
|
|
|
## PageEmittedEvents enum
|
|
|
|
All the events that a page instance may emit.
|
|
|
|
<b>Signature:</b>
|
|
|
|
```typescript
|
|
export declare const enum PageEmittedEvents
|
|
```
|
|
|
|
## Enumeration Members
|
|
|
|
| Member | Value | Description |
|
|
| --- | --- | --- |
|
|
| Close | <code>"close"</code> | Emitted when the page closes. |
|
|
| Console | <code>"console"</code> | Emitted when JavaScript within the page calls one of console API methods, e.g. <code>console.log</code> or <code>console.dir</code>. Also emitted if the page throws an error or a warning. |
|
|
| Dialog | <code>"dialog"</code> | Emitted when a JavaScript dialog appears, such as <code>alert</code>, <code>prompt</code>, <code>confirm</code> or <code>beforeunload</code>. Puppeteer can respond to the dialog via [Dialog.accept()](./puppeteer.dialog.accept.md) or [Dialog.dismiss()](./puppeteer.dialog.dismiss.md)<!-- -->. |
|
|
| DOMContentLoaded | <code>"domcontentloaded"</code> | Emitted when the JavaScript [DOMContentLoaded](https://developer.mozilla.org/en-US/docs/Web/Events/DOMContentLoaded) event is dispatched. |
|
|
| Error | <code>"error"</code> | Emitted when the page crashes. Will contain an <code>Error</code>. |
|
|
| FrameAttached | <code>"frameattached"</code> | Emitted when a frame is attached. Will contain a [Frame](./puppeteer.frame.md)<!-- -->. |
|
|
| FrameDetached | <code>"framedetached"</code> | Emitted when a frame is detached. Will contain a [Frame](./puppeteer.frame.md)<!-- -->. |
|
|
| FrameNavigated | <code>"framenavigated"</code> | Emitted when a frame is navigated to a new URL. Will contain a [Frame](./puppeteer.frame.md)<!-- -->. |
|
|
| Load | <code>"load"</code> | Emitted when the JavaScript [load](https://developer.mozilla.org/en-US/docs/Web/Events/load) event is dispatched. |
|
|
| Metrics | <code>"metrics"</code> | Emitted when the JavaScript code makes a call to <code>console.timeStamp</code>. For the list of metrics see [page.metrics](./puppeteer.page.metrics.md)<!-- -->. |
|
|
| PageError | <code>"pageerror"</code> | Emitted when an uncaught exception happens within the page. Contains an <code>Error</code>. |
|
|
| Popup | <code>"popup"</code> | Emitted when the page opens a new tab or window.<!-- -->Contains a [Page](./puppeteer.page.md) corresponding to the popup window. |
|
|
| Request | <code>"request"</code> | Emitted when a page issues a request and contains a [HTTPRequest](./puppeteer.httprequest.md)<!-- -->. |
|
|
| RequestFailed | <code>"requestfailed"</code> | Emitted when a request fails, for example by timing out.<!-- -->Contains a [HTTPRequest](./puppeteer.httprequest.md)<!-- -->. |
|
|
| RequestFinished | <code>"requestfinished"</code> | Emitted when a request finishes successfully. Contains a [HTTPRequest](./puppeteer.httprequest.md)<!-- -->. |
|
|
| Response | <code>"response"</code> | Emitted when a response is received. Contains a [HTTPResponse](./puppeteer.httpresponse.md)<!-- -->. |
|
|
| WorkerCreated | <code>"workercreated"</code> | Emitted when a dedicated [WebWorker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) is spawned by the page. |
|
|
| WorkerDestroyed | <code>"workerdestroyed"</code> | Emitted when a dedicated [WebWorker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) is destroyed by the page. |
|
|
|