puppeteer/new-docs/puppeteer.puppeteer.md
Jack Franklin 12434663e2
chore: remove installAsyncStackHooks helper (#6186)
* chore: remove `installAsyncStackHooks` helper

This code was written when browsers/Node didn't support errors in async
functions very well. They now do a much better job of this, so we can
lose the additonal complexity from our codebase and leave it to the host
environment :)

* lazy launcher is private

* remove async stack test
2020-07-09 11:38:25 +01:00

2.2 KiB

Home > puppeteer > Puppeteer

Puppeteer class

The main Puppeteer class Puppeteer module provides a method to launch a browser instance.

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
__productName string
_changedProduct boolean
_isPuppeteerCore boolean
_preferredRevision string
devices DevicesMap
errors PuppeteerErrors
product string

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.