2022-07-01 15:15:07 +00:00
<!doctype html>
2023-11-29 13:34:30 +00:00
< 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.launch" data-has-hydrated = "false" >
2022-07-01 15:15:07 +00:00
< head >
< meta charset = "UTF-8" >
2024-06-04 08:22:15 +00:00
< meta name = "generator" content = "Docusaurus v3.4.0" >
2023-11-29 13:34:30 +00:00
< title data-rh = "true" > PuppeteerNode.launch() method | 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.launch" > < 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.launch() method | Puppeteer" > < meta data-rh = "true" name = "description" content = "Launches a browser instance with given arguments and options when specified." > < meta data-rh = "true" property = "og:description" content = "Launches a browser instance with given arguments and options when specified." > < link data-rh = "true" rel = "icon" href = "/img/favicon.ico" > < link data-rh = "true" rel = "canonical" href = "https://pptr.dev/next/api/puppeteer.puppeteernode.launch" > < link data-rh = "true" rel = "alternate" href = "https://pptr.dev/next/api/puppeteer.puppeteernode.launch" hreflang = "en" > < link data-rh = "true" rel = "alternate" href = "https://pptr.dev/next/api/puppeteer.puppeteernode.launch" 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" >
2023-01-11 15:09:01 +00:00
2024-05-06 08:01:08 +00:00
< script src = "/fix-location.js" > < / script > < link rel = "stylesheet" href = "/assets/css/styles.67634aff.css" >
2024-06-07 09:36:52 +00:00
< script src = "/assets/js/runtime~main.2bf375d0.js" defer = "defer" > < / script >
2024-06-04 08:22:15 +00:00
< script src = "/assets/js/main.07d48909.js" defer = "defer" > < / script >
2022-07-01 15:15:07 +00:00
< / head >
< body class = "navigation-with-keyboard" >
2024-06-04 08:22:15 +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 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.launch" > Next< / a > < / li > < li > < a class = "dropdown__link" href = "/api/puppeteer.puppeteernode.launch" > 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 = "cur
2023-11-29 13:34:30 +00:00
< p > Launches a browser instance with given arguments and options when specified.< / p >
2024-04-11 12:01:20 +00:00
< 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 >
2024-06-04 08:22:15 +00:00
< 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.launch#signature" > < / a > < / h4 >
2024-05-06 08:01:08 +00:00
< 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" > class< / span > < span class = "token plain" > < / span > < span class = "token class-name" > PuppeteerNode< / 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 function" style = "color:#d73a49" > launch< / span > < span class = "token punctuation" style = "color:#393A34" > (< / span > < span class = "token plain" > options< / span > < span class = "token operator" style = "color:#393A34" > ?< / span > < span class = "token operator" style = "color:#393A34" > :< / span > < span class = "token plain" > PuppeteerLaunchOptions< / span > < span class = "token punctuation" style = "color:#393A34" > )< / span > < span class = "token operator" style = "color:#393A34" > :< / span > < span class = "token plain" > < / span > < span class = "token builtin" > Promise< / span > < span class = "token operator" style = "color:#393A34" > < < / span > < span class = "token plain" > Browser< / span > < span class = "token operator" 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 punctuation" style = "color:#393A34" > }< / 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 >
2024-06-04 08:22:15 +00:00
< h2 class = "anchor anchorWithStickyNavbar_FNw8" id = "parameters" > Parameters< a class = "hash-link" aria-label = "Direct link to Parameters" title = "Direct link to Parameters" href = "/next/api/puppeteer.puppeteernode.launch#parameters" > < / a > < / h2 >
2024-03-20 15:05:54 +00:00
< table > < thead > < tr > < th > < p > Parameter< / p > < / th > < th > < p > Type< / p > < / th > < th > < p > Description< / p > < / th > < / tr > < / thead > < tbody > < tr > < td > < p > options< / p > < / td > < td > < p > < a href = "/next/api/puppeteer.puppeteerlaunchoptions" > PuppeteerLaunchOptions< / a > < / p > < / td > < td > < p > < em > (Optional)< / em > Options to configure launching behavior.< / p > < / td > < / tr > < / tbody > < / table >
2023-11-29 13:34:30 +00:00
< p > < strong > Returns:< / strong > < / p >
< p > Promise< < a href = "/next/api/puppeteer.browser" > Browser< / a > > < / p >
2024-06-04 08:22:15 +00:00
< 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.launch#remarks" > < / a > < / h2 >
2023-11-29 13:34:30 +00:00
< 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 >
2024-06-04 08:22:15 +00:00
< 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.launch#example" > < / a > < / h2 >
2024-04-11 12:01:20 +00:00
< p > You can use < a href = "/next/api/puppeteer.launchoptions#ignoredefaultargs" > options.ignoreDefaultArgs< / a > to filter out < code > --mute-audio< / code > from default arguments:< / p >
2024-06-04 08:22:15 +00:00
< 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" > 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 plain" > < / span > < br > < / span > < span class = "token-line" style = "color:#393A34" > < span class = "token plain" > ignoreDefaultArgs< / span > < span class = "token operator" style = "color:#393A34" > :< / span > < span class = "token plain" > < / span > < span class = "token punctuation" style = "color:#393A34" > [< / span > < span class = "token string" style = "color:#e3116c" > ' --mute-audio' < / 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 punctuation" style = "color:#393A34" > }< / span > < span class = "token punctuation" style = "color:#393A34" > )< / span > < span class = "token punctuation" style = "color:#393A34" > ;< / 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 > < / div > < / article > < nav class = "pagination-nav docusaurus-mt-lg" aria-label = "Docs pages" > < a class = "pagination-nav__link pagination-nav__link--prev" href = "/next/api/puppeteer.puppeteernode.executablepath" > < div class = "pagination-nav__sublabel" > Previous< / div > < div class = "pagination-nav__label" > PuppeteerNode.executablePath< / div > < / a > < a class = "pagination-nav__link pagination-nav__link--next" href = "/next/api/puppeteer.puppeteernode.trimcache" > < div class = "pagination-nav__sublabel" > Next< / div > < div class = "pagination-nav__label" > PuppeteerNode.trimCache< / 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.launch#parameters" > Parameters< / a > < / li > < li > < a class = "table-of-contents__link toc-highlight" href = "/next/api/puppeteer.puppeteernode.launch#remarks" > Remarks< / a > < / li > < li > < a class = "table-of-contents__link toc-highlight" href = "/next/api/puppeteer.puppeteernode.launch#example" > Example< / 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_T11m" > < path fill = "currentColor" d = "M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10 . 988l4 . 035 4-6 . 977 7 . 07 2 . 828
2022-07-01 15:15:07 +00:00
< / body >
< / html >
