Version: Next

ChromeHeadlessShellSettings interface

export interface ChromeHeadlessShellSettings

Properties

Property	Modifiers	Type	Description	Default
downloadBaseUrl	`optional`	string	Specifies the URL prefix that is used to download the browser. Can be overridden by `PUPPETEER_CHROME_HEADLESS_SHELL_DOWNLOAD_BASE_URL`. Remarks: This must include the protocol and may even need a path prefix. This must not include a trailing slash similar to the default.	https://storage.googleapis.com/chrome-for-testing-public
skipDownload	`optional`	boolean	Tells Puppeteer to not download the browser during installation. Can be overridden by `PUPPETEER_CHROME_HEADLESS_SHELL_SKIP_DOWNLOAD` or `PUPPETEER_SKIP_CHROME_HEADLESS_SHELL_DOWNLOAD`.	false
version	`optional`	string	Specifies a certain version of the browser you'd like Puppeteer to use. Can be overridden by `PUPPETEER_CHROME_HEADLESS_SHELL_VERSION`. See puppeteer.launch on how executable path is inferred.	The pinned browser version supported by the current Puppeteer version.

Property

Modifiers

Type

Description

Default

downloadBaseUrl

optional

string

Specifies the URL prefix that is used to download the browser.

Can be overridden by PUPPETEER_CHROME_HEADLESS_SHELL_DOWNLOAD_BASE_URL.

Remarks:

This must include the protocol and may even need a path prefix. This must not include a trailing slash similar to the default.

skipDownload

optional

boolean

Tells Puppeteer to not download the browser during installation.

Can be overridden by PUPPETEER_CHROME_HEADLESS_SHELL_SKIP_DOWNLOAD or PUPPETEER_SKIP_CHROME_HEADLESS_SHELL_DOWNLOAD.

false

version

optional

string

Specifies a certain version of the browser you'd like Puppeteer to use.

Can be overridden by PUPPETEER_CHROME_HEADLESS_SHELL_VERSION.

See puppeteer.launch on how executable path is inferred.

The pinned browser version supported by the current Puppeteer version.