puppeteer/api/puppeteer.configuration/index.html

21 lines
111 KiB
HTML
Raw Normal View History

<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-22.10.1 docs-doc-page docs-doc-id-api/puppeteer.configuration" data-has-hydrated="false">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.4.0">
<title data-rh="true">Configuration interface | Puppeteer</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pptr.dev/api/puppeteer.configuration"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:counter" content="2"><meta data-rh="true" property="og:title" content="Configuration interface | Puppeteer"><meta data-rh="true" name="description" content="Defines options to configure Puppeteer&#x27;s behavior during installation and runtime."><meta data-rh="true" property="og:description" content="Defines options to configure Puppeteer&#x27;s behavior during installation and runtime."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pptr.dev/api/puppeteer.configuration"><link data-rh="true" rel="alternate" href="https://pptr.dev/api/puppeteer.configuration" hreflang="en"><link data-rh="true" rel="alternate" href="https://pptr.dev/api/puppeteer.configuration" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://DVKY664LG7-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Puppeteer" href="/opensearch.xml">
<script src="/fix-location.js"></script><link rel="stylesheet" href="/assets/css/styles.67634aff.css">
<script src="/assets/js/runtime~main.f491cfc9.js" defer="defer"></script>
<script src="/assets/js/main.45c35d14.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"light")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var[t,e]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_gu5v" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="https://user-images.githubusercontent.com/10379601/29446482-04f7036a-841f-11e7-9872-91d1fc2ea683.png" alt="Puppeteer Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="https://user-images.githubusercontent.com/10379601/29446482-04f7036a-841f-11e7-9872-91d1fc2ea683.png" alt="Puppeteer Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div><b class="navbar__title text--truncate">Puppeteer</b></a><a class="navbar__item navbar__link" href="/category/introduction">Docs</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/api/puppeteer.puppeteernode">Puppeteer API</a><a class="navbar__item navbar__link" href="/browsers-api/">@puppeteer/browsers API</a></div><div class="navbar__items navbar__items--right"><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a class="navbar__link" aria-haspopup="true" aria-expanded="false" role="button" href="/">22.10.1</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/next/api/puppeteer.configuration">Next</a></li><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/api/puppeteer.configuration">22.10.1</a></li><li><hr class="dropdown-separator"></li><li class="dropdown-archived-versions"><b>Archived versions</b></li><li><a href="https://github.com/puppeteer/puppeteer/blob/puppeteer-v22.10.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">22.10.0<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_T11m"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://github.com/puppeteer/puppeteer/blob/puppeteer-v22.9.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">22.9.0<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_T11m"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://github.com/puppeteer/puppeteer/blob/puppeteer-v22.8.2/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">22.8.2<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_T11m"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://github.com/puppeteer/puppeteer/blob/puppeteer-v22.8.1/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">22.8.1<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_T11m"><path fill="currentColor" d="M21 13v10h-21v-
<p>Defines options to configure Puppeteer&#x27;s behavior during installation and runtime.</p>
<p>See individual properties for more information.</p>
<h4 class="anchor anchorWithStickyNavbar_FNw8" id="signature">Signature:<a class="hash-link" aria-label="Direct link to Signature:" title="Direct link to Signature:" href="/api/puppeteer.configuration#signature"></a></h4>
<div class="language-typescript codeBlockContainer_aalF theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_MHx8"><pre tabindex="0" class="prism-code language-typescript codeBlock_zHgq thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_RjmQ"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">export</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">interface</span><span class="token plain"> </span><span class="token class-name">Configuration</span><br></span></code></pre><div class="buttonGroup_Sd8_"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_LnQD" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_t3l1"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_IiZV"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
<h2 class="anchor anchorWithStickyNavbar_FNw8" id="properties">Properties<a class="hash-link" aria-label="Direct link to Properties" title="Direct link to Properties" href="/api/puppeteer.configuration#properties"></a></h2>
<table><thead><tr><th><p>Property</p></th><th><p>Modifiers</p></th><th><p>Type</p></th><th><p>Description</p></th><th><p>Default</p></th></tr></thead><tbody><tr><td><span id="browserrevision">browserRevision</span></td><td><p><code>optional</code></p></td><td><p>string</p></td><td><p>Specifies a certain version of the browser you&#x27;d like Puppeteer to use.</p><p>Can be overridden by <code>PUPPETEER_BROWSER_REVISION</code>.</p><p>See <a href="/api/puppeteer.puppeteernode.launch">puppeteer.launch</a> on how executable path is inferred.</p><p>Use a specific browser version (e.g., 119.0.6045.105). If you use an alias such <code>stable</code> or <code>canary</code> it will only work during the installation of Puppeteer and it will fail when launching the browser.</p></td><td><p>The pinned browser version supported by the current Puppeteer version.</p></td></tr><tr><td><span id="cachedirectory">cacheDirectory</span></td><td><p><code>optional</code></p></td><td><p>string</p></td><td><p>Defines the directory to be used by Puppeteer for caching.</p><p>Can be overridden by <code>PUPPETEER_CACHE_DIR</code>.</p></td><td><p><code>path.join(os.homedir(), &#x27;.cache&#x27;, &#x27;puppeteer&#x27;)</code></p></td></tr><tr><td><span id="defaultproduct">defaultProduct</span></td><td><p><code>optional</code></p></td><td><p><a href="/api/puppeteer.product">Product</a></p></td><td><p>Specifies which browser you&#x27;d like Puppeteer to use.</p><p>Can be overridden by <code>PUPPETEER_PRODUCT</code>.</p></td><td><p><code>chrome</code></p></td></tr><tr><td><span id="downloadbaseurl">downloadBaseUrl</span></td><td><p><code>optional</code></p></td><td><p>string</p></td><td><p>Specifies the URL prefix that is used to download the browser.</p><p>Can be overridden by <code>PUPPETEER_DOWNLOAD_BASE_URL</code>.</p><p><strong>Remarks:</strong></p><p>This must include the protocol and may even need a path prefix.</p></td><td><p>Either <a href="https://storage.googleapis.com/chrome-for-testing-public" target="_blank" rel="noopener noreferrer">https://storage.googleapis.com/chrome-for-testing-public</a> or <a href="https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central" target="_blank" rel="noopener noreferrer">https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central</a>, depending on the product.</p></td></tr><tr><td><span id="executablepath">executablePath</span></td><td><p><code>optional</code></p></td><td><p>string</p></td><td><p>Specifies an executable path to be used in <a href="/api/puppeteer.puppeteernode.launch">puppeteer.launch</a>.</p><p>Can be overridden by <code>PUPPETEER_EXECUTABLE_PATH</code>.</p></td><td><p><strong>Auto-computed.</strong></p></td></tr><tr><td><span id="experiments">experiments</span></td><td><p><code>optional</code></p></td><td><p><a href="/api/puppeteer.experimentsconfiguration">ExperimentsConfiguration</a></p></td><td><p>Defines experimental options for Puppeteer.</p></td><td></td></tr><tr><td><span id="loglevel">logLevel</span></td><td><p><code>optional</code></p></td><td><p>&#x27;silent&#x27; | &#x27;error&#x27; | &#x27;warn&#x27;</p></td><td><p>Tells Puppeteer to log at the given level.</p></td><td><p><code>warn</code></p></td></tr><tr><td><span id="skipchromedownload">skipChromeDownload</span></td><td><p><code>optional</code></p></td><td><p>boolean</p></td><td><p>Tells Puppeteer to not Chrome download during installation.</p><p>Can be overridden by <code>PUPPETEER_SKIP_CHROME_DOWNLOAD</code>.</p></td><td></td></tr><tr><td><span id="skipchromeheadlessshelldownload">skipChromeHeadlessShellDownload</span></td><td><p><code>optional</code></p></td><td><p>boolean</p></td><td><p>Tells Puppeteer to not chrome-headless-shell download during installation.</p><p>Can be overridden by <code>PUPPETEER_SKIP_CHROME_HEADLESS_SHELL_DOWNLOAD</code>.</p></td><td></td></tr><tr><td><span id="skipdownload">skipDownload</span></td><td><p><code>optional</code></p></td><td><p>boolean</p></td><td><p>Tells Puppeteer to not download during installation.</p><p>Can be overridden by <code>PUPPETEER_SKIP_DOWNLOAD</co
</body>
</html>