mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
03a87e814d
* Mark properties as `private` or `@internal` so they don't get documented. * Fix the `@returns` on a getter which gets ignored.
2.1 KiB
2.1 KiB
Puppeteer class
The main Puppeteer class. Provides the launch method to launch a browser.
When you require or import the Puppeteer npm package you get back an instance of this class.
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.
Example
The following is a typical example of using Puppeteer to drive automation:
const puppeteer = require('puppeteer');
(async () => {
const browser = await puppeteer.launch();
const page = await browser.newPage();
await page.goto('https://www.google.com');
// other actions...
await browser.close();
})();
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| devices | DevicesMap | ||
| errors | PuppeteerErrors | ||
| product | string | The name of the browser that is under automation ("chrome" or "firefox") |
Methods
| Method | Modifiers | Description |
|---|---|---|
| connect(options) | This method attaches Puppeteer to an existing browser instance. | |
| createBrowserFetcher(options) | ||
| defaultArgs(options) | ||
| executablePath() | ||
| launch(options) | Launches puppeteer and launches a browser instance with given arguments and options when specified. |