Skip to main content
Version: 22.12.0

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:

import puppeteer from '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

The name of the browser that will be launched by default. For puppeteer, this is influenced by your configuration. Otherwise, it's chrome.

lastLaunchedProduct

readonly

Product

The name of the browser that was last launched.

product

readonly, deprecated

string

Deprecated:

Do not use as this field as it does not take into account multiple browsers of different types. Use defaultProduct or lastLaunchedProduct.

Methods

Method

Modifiers

Description

connect(options)

This method attaches Puppeteer to an existing browser instance.

defaultArgs(options)
executablePath(channel)

The default executable path.

launch(options)

Launches a browser instance with given arguments and options when specified.

When using with puppeteer-core, options.executablePath or options.channel must be provided.

Remarks:

Puppeteer can also be used to control the Chrome browser, but it works best with the version of Chrome for Testing downloaded by default. There is no guarantee it will work with any other version. If Google Chrome (rather than Chrome for Testing) is preferred, a Chrome Canary or Dev Channel build is suggested. See this article for a description of the differences between Chromium and Chrome. This article describes some differences for Linux users. See this doc for the description of Chrome for Testing.

trimCache()

Removes all non-current Firefox and Chrome binaries in the cache directory identified by the provided Puppeteer configuration. The current browser version is determined by resolving PUPPETEER_REVISIONS from Puppeteer unless configuration.browserRevision is provided.

Remarks:

Note that the method does not check if any other Puppeteer versions installed on the host that use the same cache directory require the non-current binaries.