puppeteer/next/api/puppeteer.puppeteernode/index.html

32 lines
89 KiB
HTML
Raw Normal View History

<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-api/puppeteer.puppeteernode" data-has-hydrated="false">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.4.0">
<title data-rh="true">PuppeteerNode class | 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/next/api/puppeteer.puppeteernode"><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="3"><meta data-rh="true" property="og:title" content="PuppeteerNode class | Puppeteer"><meta data-rh="true" name="description" content="Extends the main Puppeteer class with Node specific behaviour for fetching and downloading browsers."><meta data-rh="true" property="og:description" content="Extends the main Puppeteer class with Node specific behaviour for fetching and downloading browsers."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pptr.dev/next/api/puppeteer.puppeteernode"><link data-rh="true" rel="alternate" href="https://pptr.dev/next/api/puppeteer.puppeteernode" hreflang="en"><link data-rh="true" rel="alternate" href="https://pptr.dev/next/api/puppeteer.puppeteernode" 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.0f0da6ba.js" defer="defer"></script>
<script src="/assets/js/main.07d48909.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="/next/category/introduction">Docs</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/next/api/puppeteer.puppeteernode">Puppeteer API</a><a class="navbar__item navbar__link" href="/next/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="/next/">Next</a><ul class="dropdown__menu"><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/next/api/puppeteer.puppeteernode">Next</a></li><li><a class="dropdown__link" href="/api/puppeteer.puppeteernode">22.10.0</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.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-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.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">22.8.0<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_T11m"><path fill="currentColor" d="
<p>Extends the main <a href="/next/api/puppeteer.puppeteer">Puppeteer</a> class with Node specific behaviour for fetching and downloading browsers.</p>
<p>If you&#x27;re using Puppeteer in a Node environment, this is the class you&#x27;ll get when you run <code>require(&#x27;puppeteer&#x27;)</code> (or the equivalent ES <code>import</code>).</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="/next/api/puppeteer.puppeteernode#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">declare</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> </span><span class="token class-name">PuppeteerNode</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> </span><span class="token class-name">Puppeteer</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>
<p><strong>Extends:</strong> <a href="/next/api/puppeteer.puppeteer">Puppeteer</a></p>
<h2 class="anchor anchorWithStickyNavbar_FNw8" id="remarks">Remarks<a class="hash-link" aria-label="Direct link to Remarks" title="Direct link to Remarks" href="/next/api/puppeteer.puppeteernode#remarks"></a></h2>
<p>The most common method to use is <a href="/next/api/puppeteer.puppeteernode.launch">launch</a>, which is used to launch and connect to a new browser instance.</p>
<p>See <a href="/next/api/puppeteer.puppeteer">the main Puppeteer class</a> for methods common to all environments, such as <a href="/next/api/puppeteer.puppeteer.connect">Puppeteer.connect()</a>.</p>
<p>The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the <code>PuppeteerNode</code> class.</p>
<h2 class="anchor anchorWithStickyNavbar_FNw8" id="example">Example<a class="hash-link" aria-label="Direct link to Example" title="Direct link to Example" href="/next/api/puppeteer.puppeteernode#example"></a></h2>
<p>The following is a typical example of using Puppeteer to drive automation:</p>
<div class="language-ts codeBlockContainer_aalF theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_MHx8"><pre tabindex="0" class="prism-code language-ts 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">import</span><span class="token plain"> puppeteer </span><span class="token keyword" style="color:#00009f">from</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&#x27;puppeteer&#x27;</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">async</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=&gt;</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> browser </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">await</span><span class="token plain"> puppeteer</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">launch</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> page </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">await</span><span class="token plain"> browser</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">newPage</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token keyword" style="color:#00009f">await</span><span class="token plain"> page</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">goto</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">&#x27;https://www.google.com&#x27;</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// other actions...</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token keyword" style="color:#00009f">await</span><span class="token plain"> browser</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">
<p>Once you have created a <code>page</code> you have access to a large API to interact with the page, navigate, or find certain elements in that page. The <a href="/next/api/puppeteer.page">`page` documentation</a> lists all the available methods.</p>
<h2 class="anchor anchorWithStickyNavbar_FNw8" id="properties">Properties<a class="hash-link" aria-label="Direct link to Properties" title="Direct link to Properties" href="/next/api/puppeteer.puppeteernode#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></tr></thead><tbody><tr><td><span id="defaultproduct">defaultProduct</span></td><td><p><code>readonly</code></p></td><td><p><a href="/next/api/puppeteer.product">Product</a></p></td><td><p>The name of the browser that will be launched by default. For <code>puppeteer</code>, this is influenced by your configuration. Otherwise, it&#x27;s <code>chrome</code>.</p></td></tr><tr><td><span id="lastlaunchedproduct">lastLaunchedProduct</span></td><td><p><code>readonly</code></p></td><td><p><a href="/next/api/puppeteer.product">Product</a></p></td><td><p>The name of the browser that was last launched.</p></td></tr><tr><td><span id="product">product</span></td><td><p><code>readonly, deprecated</code></p></td><td><p>string</p></td><td><p><strong>Deprecated:</strong></p><p>Do not use as this field as it does not take into account multiple browsers of different types. Use <a href="/next/api/puppeteer.puppeteernode#defaultproduct">defaultProduct</a> or <a href="/next/api/puppeteer.puppeteernode#lastlaunchedproduct">lastLaunchedProduct</a>.</p></td></tr></tbody></table>
<h2 class="anchor anchorWithStickyNavbar_FNw8" id="methods">Methods<a class="hash-link" aria-label="Direct link to Methods" title="Direct link to Methods" href="/next/api/puppeteer.puppeteernode#methods"></a></h2>
<table><thead><tr><th><p>Method</p></th><th><p>Modifiers</p></th><th><p>Description</p></th></tr></thead><tbody><tr><td><span id="connect"><a href="/next/api/puppeteer.puppeteernode.connect">connect(options)</a></span></td><td></td><td><p>This method attaches Puppeteer to an existing browser instance.</p></td></tr><tr><td><span id="defaultargs"><a href="/next/api/puppeteer.puppeteernode.defaultargs">defaultArgs(options)</a></span></td><td></td><td></td></tr><tr><td><span id="executablepath"><a href="/next/api/puppeteer.puppeteernode.executablepath">executablePath(channel)</a></span></td><td></td><td><p>The default executable path.</p></td></tr><tr><td><span id="launch"><a href="/next/api/puppeteer.puppeteernode.launch">launch(options)</a></span></td><td></td><td><p>Launches a browser instance with given arguments and options when specified.</p><p>When using with <code>puppeteer-core</code>, <a href="/next/api/puppeteer.launchoptions#executablepath">options.executablePath</a> or <a href="/next/api/puppeteer.launchoptions#channel">options.channel</a> must be provided.</p><p><strong>Remarks:</strong></p><p>Puppeteer can also be used to control the Chrome browser, but it works best with the version of Chrome for Testing downloaded by default. There is no guarantee it will work with any other version. If Google Chrome (rather than Chrome for Testing) is preferred, a <a href="https://www.google.com/chrome/browser/canary.html" target="_blank" rel="noopener noreferrer">Chrome Canary</a> or <a href="https://www.chromium.org/getting-involved/dev-channel" target="_blank" rel="noopener noreferrer">Dev Channel</a> build is suggested. See <a href="https://www.howtogeek.com/202825/what%E2%80%99s-the-difference-between-chromium-and-chrome/" target="_blank" rel="noopener noreferrer">this article</a> for a description of the differences between Chromium and Chrome. <a href="https://chromium.googlesource.com/chromium/src/+/lkgr/docs/chromium_browser_vs_google_chrome.md" target="_blank" rel="noopener noreferrer">This article</a> describes some differences for Linux users. See <a href="https://developer.chrome.com/blog/chrome-for-testing/" target="_blank" rel="noopener noreferrer">this doc</a> for the description of Chrome for Testing.</p></td></tr><tr><td><span id="trimcache"><a href="/next/api/puppeteer.puppeteernode.trimcache">trimCache()</a></span></td><td></td><td><p>Removes all non-current Firefox and Chrome binaries in the cache directory identified by the provided Puppeteer configuration. The current browser version is determined by resolving PUPPETEER_REVISIONS from Puppeteer unless <code>configuration.browserRevision</code> is provided.</p><p><strong>Remarks:</strong></p><p>Note that the method does not check if any other Puppeteer versions installed on the host that use the same cache directory require the non-current binaries.</p></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="/next/api/puppeteer.puppeteernode.connect"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">PuppeteerNode.connect</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_IS5x thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a class="table-of-contents__link toc-highlight" href="/next/api/puppeteer.puppeteernode#remarks">Remarks</a></li><li><a class="table-of-contents__link toc-highlight" href="/next/api/puppeteer.puppeteernode#example">Example</a></li><li><a class="table-of-contents__link toc-highlight" href="/next/api/puppeteer.puppeteernode#properties">Properties</a></li><li><a class="table-of-contents__link toc-highlight" href="/next/api/puppeteer.puppeteernode#methods">Methods</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 cl
</body>
</html>