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
9af680d3e5
puppeteer/docs/api/puppeteer.configuration.md

31 lines
7.2 KiB
Markdown
Raw Normal View History

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 13:09:21 +00:00
---
sidebar_label: Configuration
---
# Configuration interface
fix: update documentation on configuring puppeteer (#9150) This PR updates the docs regarding configuring puppeteer. In addition, some changes have been made to the documentation generator to show default values on the documentation site. Also fixes: https://github.com/puppeteer/puppeteer/pull/9144
2022-10-24 07:07:05 +00:00
Defines options to configure Puppeteer's behavior during installation and runtime.
See individual properties for more information.
#### Signature:
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 13:09:21 +00:00
```typescript
export interface Configuration
```
## Properties
chore: Bump website dependencies (#9739)
2023-02-23 12:31:23 +00:00
| Property | Modifiers | Type | Description | Default |
| ---------------------------------------------------------------------- | --------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [browserRevision?](./puppeteer.configuration.browserrevision.md) | | string | <p>_(Optional)_ Specifies a certain version of the browser you'd like Puppeteer to use.</p><p>Can be overridden by <code>PUPPETEER_BROWSER_REVISION</code>.</p><p>See [puppeteer.launch](./puppeteer.puppeteernode.launch.md) on how executable path is inferred.</p> | A compatible-revision of the browser. |
| [cacheDirectory?](./puppeteer.configuration.cachedirectory.md) | | string | <p>_(Optional)_ Defines the directory to be used by Puppeteer for caching.</p><p>Can be overridden by <code>PUPPETEER_CACHE_DIR</code>.</p> | <code>path.join(os.homedir(), '.cache', 'puppeteer')</code> |
| [defaultProduct?](./puppeteer.configuration.defaultproduct.md) | | [Product](./puppeteer.product.md) | <p>_(Optional)_ Specifies which browser you'd like Puppeteer to use.</p><p>Can be overridden by <code>PUPPETEER_PRODUCT</code>.</p> | <code>'chrome'</code> |
| [downloadHost?](./puppeteer.configuration.downloadhost.md) | | string | <p>_(Optional)_ Specifies the URL prefix that is used to download Chromium.</p><p>Can be overridden by <code>PUPPETEER_DOWNLOAD_HOST</code>.</p> | Either https://storage.googleapis.com or https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central, depending on the product. |
| [downloadPath?](./puppeteer.configuration.downloadpath.md) | | string | <p>_(Optional)_ Specifies the path for the downloads folder.</p><p>Can be overridden by <code>PUPPETEER_DOWNLOAD_PATH</code>.</p> | <code>&lt;cache&gt;/&lt;product&gt;</code> where <code>&lt;cache&gt;</code> is Puppeteer's cache directory and <code>&lt;product&gt;</code> is the name of the browser. |
| [executablePath?](./puppeteer.configuration.executablepath.md) | | string | <p>_(Optional)_ Specifies an executable path to be used in [puppeteer.launch](./puppeteer.puppeteernode.launch.md).</p><p>Can be overridden by <code>PUPPETEER_EXECUTABLE_PATH</code>.</p> | Auto-computed. |
| [experiments?](./puppeteer.configuration.experiments.md) | | [ExperimentsConfiguration](./puppeteer.experimentsconfiguration.md) | _(Optional)_ Defines experimental options for Puppeteer. | |
| [logLevel?](./puppeteer.configuration.loglevel.md) | | 'silent' \| 'error' \| 'warn' | <p>_(Optional)_ Tells Puppeteer to log at the given level.</p><p>At the moment, any option silences logging.</p> | <code>undefined</code> |
| [skipDownload?](./puppeteer.configuration.skipdownload.md) | | boolean | <p>_(Optional)_ Tells Puppeteer to not download during installation.</p><p>Can be overridden by <code>PUPPETEER_SKIP_DOWNLOAD</code>.</p> | |
| [temporaryDirectory?](./puppeteer.configuration.temporarydirectory.md) | | string | <p>_(Optional)_ Defines the directory to be used by Puppeteer for creating temporary files.</p><p>Can be overridden by <code>PUPPETEER_TMP_DIR</code>.</p> | <code>os.tmpdir()</code> |
Reference in New Issue Copy Permalink