puppeteer/docs/api/puppeteer.puppeteer.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

2.0 KiB

sidebar_label
Puppeteer

Puppeteer class

The main Puppeteer class.

IMPORTANT: if you are using Puppeteer in a Node environment, you will get an instance of PuppeteerNode when you import or require puppeteer. That class extends Puppeteer, so has all the methods documented below as well as all that are defined on PuppeteerNode.

Signature:

export declare class Puppeteer

Remarks

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Puppeteer class.

Methods

Method Modifiers Description
clearCustomQueryHandlers() static Unregisters all custom query handlers.
connect(options) This method attaches Puppeteer to an existing browser instance.
customQueryHandlerNames() static Gets the names of all custom query handlers.
registerCustomQueryHandler(name, queryHandler) static Registers a custom query handler.
unregisterCustomQueryHandler(name) static Unregisters a custom query handler for a given name.