Defines options to configure Puppeteer’s behavior during installation and runtime.
See individual properties for more information.
export interface Configuration
Property | Modifiers | Type | Description | Default |
---|---|---|---|---|
"chrome-headless-shell" | `optional` | [ChromeHeadlessShellSettings](./puppeteer.chromeheadlessshellsettings.md) | ||
cacheDirectory | `optional` | string | Defines the directory to be used by Puppeteer for caching. Can be overridden by `PUPPETEER_CACHE_DIR`. | `path.join(os.homedir(), '.cache', 'puppeteer')` |
chrome | `optional` | [ChromeSettings](./puppeteer.chromesettings.md) | ||
defaultBrowser | `optional` | [SupportedBrowser](./puppeteer.supportedbrowser.md) | Specifies which browser you'd like Puppeteer to use. Can be overridden by `PUPPETEER_BROWSER`. | `chrome` |
executablePath | `optional` | string | Specifies an executable path to be used in [puppeteer.launch](./puppeteer.puppeteernode.launch.md). Can be overridden by `PUPPETEER_EXECUTABLE_PATH`. | **Auto-computed.** |
experiments | `optional` | [ExperimentsConfiguration](./puppeteer.experimentsconfiguration.md) | Defines experimental options for Puppeteer. | |
firefox | `optional` | [FirefoxSettings](./puppeteer.firefoxsettings.md) | ||
logLevel | `optional` | 'silent' \| 'error' \| 'warn' | Tells Puppeteer to log at the given level. | `warn` |
skipDownload | `optional` | boolean | Tells Puppeteer to not download during installation. Can be overridden by `PUPPETEER_SKIP_DOWNLOAD`. | |
temporaryDirectory | `optional` | string | Defines the directory to be used by Puppeteer for creating temporary files. Can be overridden by `PUPPETEER_TMP_DIR`. | `os.tmpdir()` |