thunderstrike/puppeteer
thunderstrike/puppeteer
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
f04bec5a15
puppeteer/new-docs/puppeteer.puppeteer.launch.md
Jack Franklin f04bec5a15
chore: update eslint & eslint plugins (#6487) 
Updates ESLint, the TypeScript ESLint plugins, and updates code where
the rules have changed.
2020-10-12 10:30:35 +01:00

2.2 KiB
Raw Blame History

Home > puppeteer > Puppeteer > launch

Puppeteer.launch() method

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

Signature:

launch(options?: LaunchOptions & ChromeArgOptions & BrowserOptions & {
        product?: string;
        extraPrefsFirefox?: Record<string, unknown>;
    }): Promise<Browser>;

Parameters

Parameter Type Description
options LaunchOptions & ChromeArgOptions & BrowserOptions & { product?: string; extraPrefsFirefox?: Record<string, unknown>; } Set of configurable options to set on the browser.

Returns:

Promise<Browser>

Promise which resolves to browser instance.

Remarks

Example

You can use ignoreDefaultArgs to filter out --mute-audio from default arguments:

const browser = await puppeteer.launch({
  ignoreDefaultArgs: ['--mute-audio']
});

**NOTE** Puppeteer can also be used to control the Chrome browser, but it works best with the version of Chromium it is bundled with. There is no guarantee it will work with any other version. Use executablePath option with extreme caution. If Google Chrome (rather than Chromium) is preferred, a Chrome Canary or Dev Channel build is suggested. In puppeteer.launch([options]), any mention of Chromium also applies to Chrome. See this article for a description of the differences between Chromium and Chrome. This article describes some differences for Linux users.