github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
4bf338b26d
puppeteer/docs/api/puppeteer.configuration.md
jrandolf ec201744f0
feat: use configuration files (#9140) 
This PR adds configurations files to `puppeteer`'s methods for
configuration. Under the hood, `puppeteer` relies on
https://www.npmjs.com/package/cosmiconfig which resolves several formats
of configuration:

- a `puppeteer` property in package.json
- a `.puppeteerrc` file in JSON or YAML format
- a `.puppeteerrc.json`, `.puppeteerrc.yaml`, `.puppeteerrc.yml`,
`.puppeteerrc.js`, or `.puppeteerrc.cjs` file
- a `puppeteer.config.js` or `puppeteer.config.cjs` CommonJS module
exporting an object

Documentation will be added later.

Fixed: #9128
2022-10-21 15:09:21 +02:00

1.9 KiB
Raw Blame History

sidebar_label
Configuration

Configuration interface

Signature:

export interface Configuration

Properties

Property Modifiers Type Description
browserRevision? string (Optional)
cacheDirectory? string (Optional)
defaultProduct? Product (Optional)
downloadHost? string (Optional)
downloadPath? string (Optional)
executablePath? string (Optional)
experiments? { macArmChromiumEnabled?: boolean; } (Optional)
logLevel? 'silent' | 'error' | 'warn' (Optional)
skipDownload? boolean (Optional)
temporaryDirectory? string (Optional)