This PR adds configurations files to `puppeteer`'s methods for configuration. Under the hood, `puppeteer` relies on https://www.npmjs.com/package/cosmiconfig which resolves several formats of configuration: - a `puppeteer` property in package.json - a `.puppeteerrc` file in JSON or YAML format - a `.puppeteerrc.json`, `.puppeteerrc.yaml`, `.puppeteerrc.yml`, `.puppeteerrc.js`, or `.puppeteerrc.cjs` file - a `puppeteer.config.js` or `puppeteer.config.cjs` CommonJS module exporting an object Documentation will be added later. Fixed: #9128
3.5 KiB
sidebar_label |
---|
PuppeteerNode |
PuppeteerNode class
Extends the main Puppeteer class with Node specific behaviour for fetching and downloading browsers.
If you're using Puppeteer in a Node environment, this is the class you'll get when you run require('puppeteer')
(or the equivalent ES import
).
Signature:
export declare class PuppeteerNode extends Puppeteer
Extends: Puppeteer
Remarks
The most common method to use is launch, which is used to launch and connect to a new browser instance.
See the main Puppeteer class for methods common to all environments, such as Puppeteer.connect().
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the PuppeteerNode
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();
})();
Once you have created a page
you have access to a large API to interact with the page, navigate, or find certain elements in that page. The `page` documentation lists all the available methods.
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
defaultProduct | readonly |
Product | |
lastLaunchedProduct | readonly |
Product | |
product | readonly |
string |
Methods
Method | Modifiers | Description |
---|---|---|
connect(options) | This method attaches Puppeteer to an existing browser instance. | |
createBrowserFetcher(options) | ||
defaultArgs(options) | ||
executablePath(channel) | ||
launch(options) | Launches a browser instance with given arguments and options when specified. |