puppeteer/website/versioned_docs/version-22.10.0/api/puppeteer.pageevent.md
release-please[bot] d963fcdd80
chore: release main (#12456)
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2024-05-24 07:26:52 +00:00

4.5 KiB

sidebar_label
PageEvent

PageEvent enum

All the events that a page instance may emit.

Signature:

export declare const enum PageEvent

Enumeration Members

Member

Value

Description

Close

"close"

Emitted when the page closes.

Console

"console"

Emitted when JavaScript within the page calls one of console API methods, e.g. console.log or console.dir. Also emitted if the page throws an error or a warning.

Remarks:

A console event provides a ConsoleMessage representing the console message that was logged.

Dialog

"dialog"

Emitted when a JavaScript dialog appears, such as alert, prompt, confirm or beforeunload. Puppeteer can respond to the dialog via Dialog.accept() or Dialog.dismiss().

DOMContentLoaded

"domcontentloaded"

Emitted when the JavaScript DOMContentLoaded event is dispatched.

Error

"error"

Emitted when the page crashes. Will contain an Error.

FrameAttached

"frameattached"

Emitted when a frame is attached. Will contain a Frame.

FrameDetached

"framedetached"

Emitted when a frame is detached. Will contain a Frame.

FrameNavigated

"framenavigated"

Emitted when a frame is navigated to a new URL. Will contain a Frame.

Load

"load"

Emitted when the JavaScript load event is dispatched.

Metrics

"metrics"

Emitted when the JavaScript code makes a call to console.timeStamp. For the list of metrics see page.metrics.

Remarks:

Contains an object with two properties:

  • title: the title passed to console.timeStamp - metrics: object containing metrics as key/value pairs. The values will be numbers.

PageError

"pageerror"

Emitted when an uncaught exception happens within the page. Contains an Error.

Popup

"popup"

Emitted when the page opens a new tab or window.

Contains a Page corresponding to the popup window.

Request

"request"

Emitted when a page issues a request and contains a HTTPRequest.

Remarks:

The object is readonly. See Page.setRequestInterception() for intercepting and mutating requests.

RequestFailed

"requestfailed"

Emitted when a request fails, for example by timing out.

Contains a HTTPRequest.

Remarks:

HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will complete with requestfinished event and not with requestfailed.

RequestFinished

"requestfinished"

Emitted when a request finishes successfully. Contains a HTTPRequest.

RequestServedFromCache

"requestservedfromcache"

Emitted when a request ended up loading from cache. Contains a HTTPRequest.

Remarks:

For certain requests, might contain undefined. https://crbug.com/750469

Response

"response"

Emitted when a response is received. Contains a HTTPResponse.

WorkerCreated

"workercreated"

Emitted when a dedicated WebWorker is spawned by the page.

WorkerDestroyed

"workerdestroyed"

Emitted when a dedicated WebWorker is destroyed by the page.