puppeteer/new-docs/puppeteer.puppeteer.md
Jack Franklin 9fdf2ba280
chore(docs): migrate page.pdf() docs (#6228)
Also took the opportunity to pull out the PDF types into their own file
to clear up `Page.ts` slightly and give the PDF code a more natural
place to live.
2020-07-17 13:58:56 +01:00

2.3 KiB

Home > puppeteer > Puppeteer

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();
})();

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
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.