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
2976ed215c
puppeteer/browsers-api/index.html

38 lines
73 KiB
HTML
Raw Normal View History

deploy: 75a136e0de1da574ad157296aea8488dda47006e
2023-04-06 12:32:02 +00:00
<!doctype html>
deploy: 3e1e419fe6358e624ff79b2a1c17a7cab13a65ba
2024-03-28 13:39:16 +00:00
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-22.6.2 docs-doc-page docs-doc-id-browsers-api/index" data-has-hydrated="false">
deploy: 75a136e0de1da574ad157296aea8488dda47006e
2023-04-06 12:32:02 +00:00
<head>
<meta charset="UTF-8">
deploy: 93e9acc410a16fbcfd679866ad37236f1b06f42e
2024-03-20 15:05:54 +00:00
<meta name="generator" content="Docusaurus v3.1.1">
deploy: 1014abc087e8bc549697fbc688dd332af4ec6959
2023-11-29 13:34:30 +00:00
<title data-rh="true">@puppeteer/browsers | 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/browsers-api/"><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="@puppeteer/browsers | Puppeteer"><meta data-rh="true" name="description" content="Manage and launch browsers/drivers from a CLI or programmatically."><meta data-rh="true" property="og:description" content="Manage and launch browsers/drivers from a CLI or programmatically."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pptr.dev/browsers-api/"><link data-rh="true" rel="alternate" href="https://pptr.dev/browsers-api/" hreflang="en"><link data-rh="true" rel="alternate" href="https://pptr.dev/browsers-api/" 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">
deploy: 75a136e0de1da574ad157296aea8488dda47006e
2023-04-06 12:32:02 +00:00
deploy: 93e9acc410a16fbcfd679866ad37236f1b06f42e
2024-03-20 15:05:54 +00:00
<script src="/fix-location.js"></script><link rel="stylesheet" href="/assets/css/styles.6fb25b18.css">
deploy: 3e1e419fe6358e624ff79b2a1c17a7cab13a65ba
2024-03-28 13:39:16 +00:00
<script src="/assets/js/runtime~main.dea93351.js" defer="defer"></script>
<script src="/assets/js/main.2a34fbdb.js" defer="defer"></script>
deploy: 75a136e0de1da574ad157296aea8488dda47006e
2023-04-06 12:32:02 +00:00
</head>
<body class="navigation-with-keyboard">
deploy: 3e1e419fe6358e624ff79b2a1c17a7cab13a65ba
2024-03-28 13:39:16 +00:00
<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 localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"light")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)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_fXgn" 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="/">Docs</a><a class="navbar__item navbar__link" href="/api/puppeteer.puppeteernode">Puppeteer API</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" 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.6.2</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/next/browsers-api/">Next</a></li><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/browsers-api/">22.6.2</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.6.1/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">22.6.1<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><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.6.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">22.6.0<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><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.5.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">22.5.0<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><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.4.1/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">22.4.1<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.82
deploy: 1014abc087e8bc549697fbc688dd332af4ec6959
2023-11-29 13:34:30 +00:00
<p>Manage and launch browsers/drivers from a CLI or programmatically.</p>
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="cli">CLI<a href="#cli" class="hash-link" aria-label="Direct link to CLI" title="Direct link to CLI">​</a></h2>
<p>Use <code>npx</code> to run the CLI:</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">npx @puppeteer/browsers </span><span class="token parameter variable" style="color:#36acaa">--help</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><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_LjdS"><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>
<p>CLI help will provide all documentation you need to use the CLI.</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">npx @puppeteer/browsers </span><span class="token parameter variable" style="color:#36acaa">--help</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic"># help for all commands</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">npx @puppeteer/browsers </span><span class="token function" style="color:#d73a49">install</span><span class="token plain"> </span><span class="token parameter variable" style="color:#36acaa">--help</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic"># help for the install command</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">npx @puppeteer/browsers launch </span><span class="token parameter variable" style="color:#36acaa">--help</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic"># help for the launch command</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><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_LjdS"><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_LWe7" id="known-limitations">Known limitations<a href="#known-limitations" class="hash-link" aria-label="Direct link to Known limitations" title="Direct link to Known limitations">​</a></h2>
<ol>
<li>We support installing and running Firefox, Chrome and Chromium. The <code>latest</code>, <code>beta</code>, <code>dev</code>, <code>canary</code>, <code>stable</code> keywords are only supported for the install command. For the <code>launch</code> command you need to specify an exact build ID. The build ID is provided by the <code>install</code> command (see <code>npx @puppeteer/browsers install --help</code> for the format).</li>
<li>Launching the system browsers is only possible for Chrome/Chromium.</li>
</ol>
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="api">API<a href="#api" class="hash-link" aria-label="Direct link to API" title="Direct link to API">​</a></h2>
<p>The programmatic API allows installing and launching browsers from your code. See the <code>test</code> folder for examples on how to use the <code>install</code>, <code>canInstall</code>, <code>launch</code>, <code>computeExecutablePath</code>, <code>computeSystemExecutablePath</code> and other methods.</p>
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="classes">Classes<a href="#classes" class="hash-link" aria-label="Direct link to Classes" title="Direct link to Classes">​</a></h2>
deploy: bf1fd1e8287a835b2306d8b3260e753e83a496a6
2024-03-25 13:06:32 +00:00
<table><thead><tr><th><p>Class</p></th><th><p>Description</p></th></tr></thead><tbody><tr><td><p><a href="/browsers-api/browsers.cli">CLI</a></p></td><td></td></tr><tr><td><p><a href="/browsers-api/browsers.installedbrowser">InstalledBrowser</a></p></td><td></td></tr><tr><td><p><a href="/browsers-api/browsers.process">Process</a></p></td><td></td></tr><tr><td><p><a href="/browsers-api/browsers.timeouterror">TimeoutError</a></p></td><td></td></tr></tbody></table>
deploy: 1014abc087e8bc549697fbc688dd332af4ec6959
2023-11-29 13:34:30 +00:00
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="enumerations">Enumerations<a href="#enumerations" class="hash-link" aria-label="Direct link to Enumerations" title="Direct link to Enumerations">​</a></h2>
deploy: bf1fd1e8287a835b2306d8b3260e753e83a496a6
2024-03-25 13:06:32 +00:00
<table><thead><tr><th><p>Enumeration</p></th><th><p>Description</p></th></tr></thead><tbody><tr><td><p><a href="/browsers-api/browsers.browser">Browser</a></p></td><td><p>Supported browsers.</p></td></tr><tr><td><p><a href="/browsers-api/browsers.browserplatform">BrowserPlatform</a></p></td><td><p>Platform names used to identify a OS platform x architecture combination in the way that is relevant for the browser download.</p></td></tr><tr><td><p><a href="/browsers-api/browsers.chromereleasechannel">ChromeReleaseChannel</a></p></td><td></td></tr></tbody></table>
deploy: 1014abc087e8bc549697fbc688dd332af4ec6959
2023-11-29 13:34:30 +00:00
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="functions">Functions<a href="#functions" class="hash-link" aria-label="Direct link to Functions" title="Direct link to Functions">​</a></h2>
deploy: bf1fd1e8287a835b2306d8b3260e753e83a496a6
2024-03-25 13:06:32 +00:00
<table><thead><tr><th><p>Function</p></th><th><p>Description</p></th></tr></thead><tbody><tr><td><p><a href="/browsers-api/browsers.candownload">canDownload(options)</a></p></td><td></td></tr><tr><td><p><a href="/browsers-api/browsers.computeexecutablepath">computeExecutablePath(options)</a></p></td><td></td></tr><tr><td><p><a href="/browsers-api/browsers.computesystemexecutablepath">computeSystemExecutablePath(options)</a></p></td><td></td></tr><tr><td><p><a href="/browsers-api/browsers.createprofile">createProfile(browser, opts)</a></p></td><td></td></tr><tr><td><p><a href="/browsers-api/browsers.detectbrowserplatform">detectBrowserPlatform()</a></p></td><td></td></tr><tr><td><p><a href="/browsers-api/browsers.getinstalledbrowsers">getInstalledBrowsers(options)</a></p></td><td><p>Returns metadata about browsers installed in the cache directory.</p></td></tr><tr><td><p><a href="/browsers-api/browsers.getversioncomparator">getVersionComparator(browser)</a></p></td><td><p>Returns a version comparator for the given browser that can be used to sort browser versions.</p></td></tr><tr><td><p><a href="/browsers-api/browsers.install">install(options)</a></p></td><td></td></tr><tr><td><p><a href="/browsers-api/browsers.install_1">install(options)</a></p></td><td></td></tr><tr><td><p><a href="/browsers-api/browsers.launch">launch(opts)</a></p></td><td></td></tr><tr><td><p><a href="/browsers-api/browsers.makeprogresscallback">makeProgressCallback(browser, buildId)</a></p></td><td></td></tr><tr><td><p><a href="/browsers-api/browsers.resolvebuildid">resolveBuildId(browser, platform, tag)</a></p></td><td></td></tr><tr><td><p><a href="/browsers-api/browsers.uninstall">uninstall(options)</a></p></td><td></td></tr></tbody></table>
deploy: 1014abc087e8bc549697fbc688dd332af4ec6959
2023-11-29 13:34:30 +00:00
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="interfaces">Interfaces<a href="#interfaces" class="hash-link" aria-label="Direct link to Interfaces" title="Direct link to Interfaces">​</a></h2>
deploy: bf1fd1e8287a835b2306d8b3260e753e83a496a6
2024-03-25 13:06:32 +00:00
<table><thead><tr><th><p>Interface</p></th><th><p>Description</p></th></tr></thead><tbody><tr><td><p><a href="/browsers-api/browsers.getinstalledbrowsersoptions">GetInstalledBrowsersOptions</a></p></td><td></td></tr><tr><td><p><a href="/browsers-api/browsers.installoptions">InstallOptions</a></p></td><td></td></tr><tr><td><p><a href="/browsers-api/browsers.launchoptions">LaunchOptions</a></p></td><td></td></tr><tr><td><p><a href="/browsers-api/browsers.options">Options</a></p></td><td></td></tr><tr><td><p><a href="/browsers-api/browsers.profileoptions">ProfileOptions</a></p></td><td></td></tr><tr><td><p><a href="/browsers-api/browsers.systemoptions">SystemOptions</a></p></td><td></td></tr><tr><td><p><a href="/browsers-api/browsers.uninstalloptions">UninstallOptions</a></p></td><td></td></tr></tbody></table>
deploy: 1014abc087e8bc549697fbc688dd332af4ec6959
2023-11-29 13:34:30 +00:00
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="variables">Variables<a href="#variables" class="hash-link" aria-label="Direct link to Variables" title="Direct link to Variables">​</a></h2>
deploy: bf1fd1e8287a835b2306d8b3260e753e83a496a6
2024-03-25 13:06:32 +00:00
<table><thead><tr><th><p>Variable</p></th><th><p>Description</p></th></tr></thead><tbody><tr><td><p><a href="/browsers-api/browsers.cdp_websocket_endpoint_regex">CDP_WEBSOCKET_ENDPOINT_REGEX</a></p></td><td></td></tr><tr><td><p><a href="/browsers-api/browsers.webdriver_bidi_websocket_endpoint_regex">WEBDRIVER_BIDI_WEBSOCKET_ENDPOINT_REGEX</a></p></td><td></td></tr></tbody></table></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--next" href="/browsers-api/browsers.launch"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">launch</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#cli" class="table-of-contents__link toc-highlight">CLI</a></li><li><a href="#known-limitations" class="table-of-contents__link toc-highlight">Known limitations</a></li><li><a href="#api" class="table-of-contents__link toc-highlight">API</a></li><li><a href="#classes" class="table-of-contents__link toc-highlight">Classes</a></li><li><a href="#enumerations" class="table-of-contents__link toc-highlight">Enumerations</a></li><li><a href="#functions" class="table-of-contents__link toc-highlight">Functions</a></li><li><a href="#interfaces" class="table-of-contents__link toc-highlight">Interfaces</a></li><li><a href="#variables" class="table-of-contents__link toc-highlight">Variables</a></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://stackoverflow.com/questions/tagged/puppeteer" target="_blank" rel="noopener noreferrer" class="footer__link-item">Stack Overflow<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><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 class="footer__item"><a href="https://twitter.com/chromedevtools" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><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 class="footer__item"><a href="https://goo.gle/devtools-youtube" target="_blank" rel="noopener noreferrer" class="footer__link-item">YouTube<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><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></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 Google, Inc.</div></div></div></footer></div>
deploy: 75a136e0de1da574ad157296aea8488dda47006e
2023-04-06 12:32:02 +00:00
</body>
</html>
Reference in New Issue Copy Permalink