BrowserType
Added in: v1.8BrowserType provides methods to launch a specific browser instance or connect to an existing one. The following is a typical example of using Playwright to drive automation:
const { chromium } = require('playwright'); // Or 'firefox' or 'webkit'.
(async () => {
const browser = await chromium.launch();
const page = await browser.newPage();
await page.goto('https://example.com');
// other actions...
await browser.close();
})();Methods
browserType.connect()
Added in: v1.8 asyncThis method attaches Playwright to an existing browser instance created via BrowserType.launchServer in Node.js.
INFO
The major and minor version of the Playwright instance that connects needs to match the version of Playwright that launches the browser (1.2.3 → is compatible with 1.2.x).
Arguments
endpointstringAdded in: v1.10A Playwright browser websocket endpoint to connect to. You obtain this endpoint via
BrowserServer.wsEndpoint.exposeNetworkstring(optional) Added in: v1.37This option exposes network available on the connecting client to the browser being connected to. Consists of a list of rules separated by comma.
Available rules:
- Hostname pattern, for example:
example.com,*.org:99,x.*.y.com,*foo.org. - IP literal, for example:
127.0.0.1,0.0.0.0:99,[::1],[0:0::1]:99. <loopback>that matches local loopback interfaces:localhost,*.localhost,127.0.0.1,[::1].
Some common examples:
"*"to expose all network."<loopback>"to expose localhost network."*.test.internal-domain,*.staging.internal-domain,<loopback>"to expose test/staging deployments and localhost.
- Hostname pattern, for example:
headersObject<string, string>(optional) Added in: v1.11Additional HTTP headers to be sent with web socket connect request. Optional.
launchOptionsLaunchOptions(optional) Added in: v1.66Options used to launch the browser, as passed to
browserType.launch(). Only applies when the server launches a browser for each connection. The server ignores the options that it does not allow.slowMofloat(optional) Added in: v1.10Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on. Defaults to 0.
timeoutfloat(optional) Added in: v1.10Maximum time in milliseconds to wait for the connection to be established. Defaults to
0(no timeout).
Returns
Promise<Browser>
browserType.connectOverCDP()
Added in: v1.9 asyncThis method attaches Playwright to an existing browser instance using the Chrome DevTools Protocol.
The default browser context is accessible via browser.contexts().
INFO
Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers.
INFO
This connection is significantly lower fidelity than the Playwright protocol connection via browserType.connect(). If you are experiencing issues or attempting to use advanced functionality, you probably want to use browserType.connect().
WARNING
Playwright maintains a curated list of arguments for launching the browser. If you launch the browser without Playwright and do not pass the exact same arguments, some of Playwright functionality may be broken upon connecting to the browser.
Usage
const browser = await playwright.chromium.connectOverCDP('http://localhost:9222');
const defaultContext = browser.contexts()[0];
const page = defaultContext.pages()[0];Arguments
endpointURLstringAdded in: v1.11A CDP websocket endpoint or http url to connect to. For example
http://localhost:9222/orws://127.0.0.1:9222/devtools/browser/387adf4c-243f-4051-a181-46798f4a46f4.Alternatively, a URL that tells which running browser to connect to:
remote-debugging://<channel>- a browser with remote debugging enabled, for exampleremote-debugging://msedge. The optionaluserDataDirparameter is the user data directory of the browser, when it is not the default one:remote-debugging://chrome?userDataDir=/path/to/data. A bare channel name such aschromeis the same asremote-debugging://chrome.extension://<channel>/<profile directory>- the tabs of a browser profile, through the Playwright Extension, for exampleextension://chrome/Profile 1. Playwright opens the connect page of the extension in that profile, and the user selects the tabs to share. Without the profile directory, Playwright uses theDefaultprofile. The optional parameters areuserDataDir, the user data directory of the browser when it is not the default one, andexecutablePath, the path to the browser executable when it is not at the standard location:extension://chromium?executablePath=/path/to/chrome&userDataDir=/path/to/data. Pass the other options of this connection inheaders.
The values of
userDataDirandexecutablePathmust be URL-encoded, for example withencodeURIComponentorURLSearchParams. The channel is a browser channel name such aschrome,chrome-betaormsedge. The default user data directory of the channel is where the browser keeps its data. On Linux, Playwright usesCHROME_USER_DATA_DIRwhen set. Otherwise, it usesCHROME_CONFIG_HOME, thenXDG_CONFIG_HOME, then~/.configto locate that directory.artifactsDirpath(optional) Added in: v1.61If specified, browser artifacts (such as traces and downloads) are saved into this directory.
headersObject<string, string>(optional) Added in: v1.11Additional HTTP headers to be sent with connect request. Optional.
When
endpointURLis an extension URL such asextension://chrome, the headers are not sent. They are the options of the connection:x-playwright-extension-token- the token of the extension. With the token, the user does not have to approve the connection. Without the token, the user must approve the connection beforetimeoutexpires, so set it to a value that gives the user enough time.x-playwright-extension-client-name- the name of the client that the extension shows to the user.x-playwright-extension-tab-group- passfalseto keep the tabs out of a tab group.x-playwright-extension-tab-group-title- the title of the tab group.x-playwright-extension-tab-group-color- the color of the tab group:green,blue,purple,orange,pink,cyan,yelloworred.x-playwright-extension-background- passtrueto keep the tabs from becoming active.
isLocalboolean(optional) Added in: v1.58Tells Playwright that it runs on the same host as the CDP server. It will enable certain optimizations that rely upon the file system being the same between Playwright and the Browser.
noDefaultsboolean(optional) Added in: v1.60When true, Playwright will not apply its default overrides to the existing default browser context. Specifically,
acceptDownloadsand font families are left at the browser's settings, focus emulation is not enabled, and media emulation options (such ascolorScheme,reducedMotion,forcedColors, andcontrast) are not applied. Useful when attaching to a user's daily-driver browser where these overrides would interfere with existing browser state. New contexts created viabrowser.newContext()are not affected. Defaults tofalse.slowMofloat(optional) Added in: v1.11Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on. Defaults to 0.
timeoutfloat(optional) Added in: v1.11Maximum time in milliseconds to wait for the connection to be established. Defaults to
30000(30 seconds). Pass0to disable timeout.
Returns
Promise<Browser>
browserType.executablePath()
Added in: v1.8A path where Playwright expects to find a bundled browser executable.
Returns
string
browserType.launch()
Added in: v1.8 asyncReturns the browser instance.
Usage
You can use ignoreDefaultArgs to filter out --mute-audio from default arguments:
const browser = await chromium.launch({ // Or 'firefox' or 'webkit'.
ignoreDefaultArgs: ['--mute-audio']
});Chromium-only Playwright can also be used to control the Google Chrome or Microsoft Edge browsers, but it works best with the version of Chromium it is bundled with. There is no guarantee it will work with any other version. Use
executablePathoption with extreme caution.If Google Chrome (rather than Chromium) is preferred, a Chrome Canary or Dev Channel build is suggested.
Stock browsers like Google Chrome and Microsoft Edge are suitable for tests that require proprietary media codecs for video playback. See this article for other differences between Chromium and Chrome. This article describes some differences for Linux users.
Arguments
WARNING
Use custom browser args at your own risk, as some of them may break Playwright functionality.
Additional arguments to pass to the browser instance. The list of Chromium flags can be found here.
If specified, artifacts (traces, videos, downloads, HAR files, etc.) are saved into this directory. The directory is not cleaned up when the browser closes. If not specified, a temporary directory is used and cleaned up when the browser closes.
Browser distribution channel.
Use "chromium" to opt in to new headless mode.
Use "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev", or "msedge-canary" to use branded Google Chrome and Microsoft Edge.
chromiumSandboxboolean(optional)Enable Chromium sandboxing. Defaults to
false.If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and is deleted when browser is closed. In either case, the downloads are deleted when the browser context they were created in is closed.
executablePathpath(optional)Path to a browser executable to run instead of the bundled one. If
executablePathis a relative path, then it is resolved relative to the current working directory. Note that Playwright only works with the bundled Chromium, Firefox or WebKit, use at your own risk.firefoxUserPrefsObject<string, string | float | boolean>(optional)Firefox user preferences. Learn more about the Firefox user preferences at
about:config.You can also provide a path to a custom
policies.jsonfile viaPLAYWRIGHT_FIREFOX_POLICIES_JSONenvironment variable.handleSIGHUPboolean(optional)Close the browser process on SIGHUP. Defaults to
true.handleSIGINTboolean(optional)Close the browser process on Ctrl-C. Defaults to
true.handleSIGTERMboolean(optional)Close the browser process on SIGTERM. Defaults to
true.Whether to run browser in headless mode. More details for Chromium and Firefox. Defaults to
true.ignoreDefaultArgsboolean | Array<string>(optional)If
true, Playwright does not pass its own configurations args and only uses the ones fromargs. If an array is given, then filters out the given default arguments. Dangerous option; use with care. Defaults tofalse.Logger sink for Playwright logging.
Network proxy settings.
serverstringProxy to be used for all requests. HTTP and SOCKS proxies are supported, for example
http://myproxy.com:3128orsocks5://myproxy.com:3128. Short formmyproxy.com:3128is considered an HTTP proxy.bypassstring(optional)Optional comma-separated domains to bypass proxy, for example
".com, chromium.org, .domain.com".usernamestring(optional)Optional username to use if HTTP proxy requires authentication.
passwordstring(optional)Optional password to use if HTTP proxy requires authentication.
Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on.
Maximum time in milliseconds to wait for the browser instance to start. Defaults to
180000(3 minutes). Pass0to disable timeout.If specified, traces are saved into this directory.
Returns
Promise<Browser>
browserType.launchPersistentContext()
Added in: v1.8 asyncReturns the persistent browser context instance.
Launches browser that uses persistent storage located at userDataDir and returns the only context. Closing this context will automatically close the browser.
Arguments
Path to a User Data Directory, which stores browser session data like cookies and local storage. Pass an empty string to create a temporary directory.
More details for Chromium and Firefox. Chromium's user data directory is the parent directory of the "Profile Path" seen at
chrome://version.Note that browsers do not allow launching multiple instances with the same User Data Directory.
WARNING
Chromium/Chrome: Due to recent Chrome policy changes, automating the default Chrome user profile is not supported. Pointing
userDataDirto Chrome's main "User Data" directory (the profile used for your regular browsing) may result in pages not loading or the browser exiting. Create and use a separate directory (for example, an empty folder) as your automation profile instead. See https://developer.chrome.com/blog/remote-debugging-port for details.acceptDownloadsboolean(optional)Whether to automatically download all the attachments. Defaults to
truewhere all the downloads are accepted.WARNING
Use custom browser args at your own risk, as some of them may break Playwright functionality.
Additional arguments to pass to the browser instance. The list of Chromium flags can be found here.
If specified, artifacts (traces, videos, downloads, HAR files, etc.) are saved into this directory. The directory is not cleaned up when the browser closes. If not specified, a temporary directory is used and cleaned up when the browser closes.
When using
page.goto(),page.route(),page.waitForURL(),page.waitForRequest(), orpage.waitForResponse()it takes the base URL in consideration by using theURL()constructor for building the corresponding URL. Unset by default. Examples:- baseURL:
http://localhost:3000and navigating to/bar.htmlresults inhttp://localhost:3000/bar.html - baseURL:
http://localhost:3000/foo/and navigating to./bar.htmlresults inhttp://localhost:3000/foo/bar.html - baseURL:
http://localhost:3000/foo(without trailing slash) and navigating to./bar.htmlresults inhttp://localhost:3000/bar.html
- baseURL:
Toggles bypassing page's Content-Security-Policy. Defaults to
false.Browser distribution channel.
Use "chromium" to opt in to new headless mode.
Use "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev", or "msedge-canary" to use branded Google Chrome and Microsoft Edge.
chromiumSandboxboolean(optional)Enable Chromium sandboxing. Defaults to
false.clientCertificatesArray<Object>(optional) Added in: v1.46TLS Client Authentication allows the server to request a client certificate and verify it.
Details
An array of client certificates to be used. Each certificate object must have either both
certPathandkeyPath, a singlepfxPath, or their corresponding direct value equivalents (certandkey, orpfx). Optionally,passphraseproperty should be provided if the certificate is encrypted. Theoriginproperty should be provided with an exact match to the request origin that the certificate is valid for.Client certificate authentication is only active when at least one client certificate is provided. If you want to reject all client certificates sent by the server, you need to provide a client certificate with an
originthat does not match any of the domains you plan to visit.INFO
When using WebKit on macOS, accessing
localhostwill not pick up client certificates. You can make it work by replacinglocalhostwithlocal.playwright.originstringAdded in: v1.46Exact origin that the certificate is valid for. Origin includes
httpsprotocol, a hostname and optionally a port.certPathpath(optional) Added in: v1.46Path to the file with the certificate in PEM format.
certBuffer(optional) Added in: v1.46Direct value of the certificate in PEM format.
keyPathpath(optional) Added in: v1.46Path to the file with the private key in PEM format.
keyBuffer(optional) Added in: v1.46Direct value of the private key in PEM format.
pfxPathpath(optional) Added in: v1.46Path to the PFX or PKCS12 encoded private key and certificate chain.
pfxBuffer(optional) Added in: v1.46Direct value of the PFX or PKCS12 encoded private key and certificate chain.
passphrasestring(optional) Added in: v1.46Passphrase for the private key (PEM or PFX).
colorSchemenull | "light" | "dark" | "no-preference"(optional)Emulates prefers-colors-scheme media feature, supported values are
'light'and'dark'. Seepage.emulateMedia()for more details. Passingnullresets emulation to system defaults. Defaults to'light'.contrastnull | "no-preference" | "more"(optional)Emulates
'prefers-contrast'media feature, supported values are'no-preference','more'. Seepage.emulateMedia()for more details. Passingnullresets emulation to system defaults. Defaults to'no-preference'.deviceScaleFactorfloat(optional)Specify device scale factor (can be thought of as dpr). Defaults to
1. Learn more about emulating devices with device scale factor.If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and is deleted when browser is closed. In either case, the downloads are deleted when the browser context they were created in is closed.
executablePathpath(optional)Path to a browser executable to run instead of the bundled one. If
executablePathis a relative path, then it is resolved relative to the current working directory. Note that Playwright only works with the bundled Chromium, Firefox or WebKit, use at your own risk.extraHTTPHeadersObject<string, string>(optional)An object containing additional HTTP headers to be sent with every request. Defaults to none.
firefoxUserPrefsObject<string, string | float | boolean>(optional) Added in: v1.40Firefox user preferences. Learn more about the Firefox user preferences at
about:config.You can also provide a path to a custom
policies.jsonfile viaPLAYWRIGHT_FIREFOX_POLICIES_JSONenvironment variable.forcedColorsnull | "active" | "none"(optional)Emulates
'forced-colors'media feature, supported values are'active','none'. Seepage.emulateMedia()for more details. Passingnullresets emulation to system defaults. Defaults to'none'.latitudefloatLatitude between -90 and 90.
longitudefloatLongitude between -180 and 180.
accuracyfloat(optional)Non-negative accuracy value. Defaults to
0.
handleSIGHUPboolean(optional)Close the browser process on SIGHUP. Defaults to
true.handleSIGINTboolean(optional)Close the browser process on Ctrl-C. Defaults to
true.handleSIGTERMboolean(optional)Close the browser process on SIGTERM. Defaults to
true.Specifies if viewport supports touch events. Defaults to false. Learn more about mobile emulation.
Whether to run browser in headless mode. More details for Chromium and Firefox. Defaults to
true.httpCredentialsObject | Array<Object>(optional)Credentials for HTTP authentication. If no origin is specified, the username and password are sent to any servers upon unauthorized responses.
Pass an array to use different credentials for different origins. The first entry that matches the request origin is used, and entries with no origin match any request.
usernamestringpasswordstringoriginstring(optional)Restrain sending http credentials on specific origin (scheme://host:port).
send"unauthorized" | "always"(optional)This option only applies to the requests sent from corresponding APIRequestContext and does not affect requests sent from the browser.
'always'-Authorizationheader with basic authentication credentials will be sent with the each API request.'unauthorized- the credentials are only sent when 401 (Unauthorized) response withWWW-Authenticateheader is received. Defaults to'unauthorized'.
ignoreDefaultArgsboolean | Array<string>(optional)If
true, Playwright does not pass its own configurations args and only uses the ones fromargs. If an array is given, then filters out the given default arguments. Dangerous option; use with care. Defaults tofalse.ignoreHTTPSErrorsboolean(optional)Whether to ignore HTTPS errors when sending network requests. Defaults to
false.Whether the
meta viewporttag is taken into account and touch events are enabled. isMobile is a part of device, so you don't actually need to set it manually. Defaults tofalse. Learn more about mobile emulation.javaScriptEnabledboolean(optional)Whether or not to enable JavaScript in the context. Defaults to
true. Learn more about disabling JavaScript.Specify user locale, for example
en-GB,de-DE, etc. Locale will affectnavigator.languagevalue,Accept-Languagerequest header value as well as number and date formatting rules. Defaults to the system default locale. Learn more about emulation in our emulation guide.locateOnlyVisibleboolean(optional)Whether locators in this context find only visible elements. Defaults to
false.When enabled, Playwright applies two rules:
- The element that a locator finds must be visible. Actions, assertions and queries behave as if
locator.visible()was called at the end of the locator chain. locator.first(),locator.last()andlocator.nth()select among visible elements. They behave as iflocator.visible()was called immediately before them.
js// <div hidden>One</div> <div>Two</div> <div>Three</div> await expect(page.locator('div')).toHaveCount(2); await expect(page.locator('div').first()).toHaveText('Two'); await expect(page.locator('div').last()).toHaveText('Three');An explicit visibility filter always has priority. Playwright does not add its own filter in a position that already has one. For example,
page.locator('div').filter({ visible: false }).first()finds the first hidden element.All other parts of the locator chain are not filtered. In
page.locator('section').getByRole('button'), the button must be visible, but the section can be hidden by the visibility rules, for example because it has zero size. The same applies to the inner locators oflocator.filter(),locator.and()andlocator.or(): only the second rule applies to them.This option does not change the accessibility rules of
page.getByRole()or the behavior of selector-based methods such aspage.$().- The element that a locator finds must be visible. Actions, assertions and queries behave as if
Logger sink for Playwright logging.
Whether to emulate network being offline. Defaults to
false. Learn more about network emulation.permissionsArray<string>(optional)A list of permissions to grant to all pages in this context. See
browserContext.grantPermissions()for more details. Defaults to none.Network proxy settings.
serverstringProxy to be used for all requests. HTTP and SOCKS proxies are supported, for example
http://myproxy.com:3128orsocks5://myproxy.com:3128. Short formmyproxy.com:3128is considered an HTTP proxy.bypassstring(optional)Optional comma-separated domains to bypass proxy, for example
".com, chromium.org, .domain.com".usernamestring(optional)Optional username to use if HTTP proxy requires authentication.
passwordstring(optional)Optional password to use if HTTP proxy requires authentication.
Enables HAR recording for all pages into
recordHar.pathfile. If not specified, the HAR is not recorded. Make sure to awaitbrowserContext.close()for the HAR to be saved.omitContentboolean(optional)Optional setting to control whether to omit request content from the HAR. Defaults to
false. Deprecated, usecontentpolicy instead.content"omit" | "embed" | "attach"(optional)Optional setting to control resource content management. If
omitis specified, content is not persisted. Ifattachis specified, resources are persisted as separate files or entries in the ZIP archive. Ifembedis specified, content is stored inline the HAR file as per HAR specification. Defaults toattachfor.zipoutput files and toembedfor all other file extensions.pathpathPath on the filesystem to write the HAR file to. If the file name ends with
.zip,content: 'attach'is used by default.mode"full" | "minimal"(optional)When set to
minimal, only record information necessary for routing from HAR. This omits sizes, timing, page, cookies, security and other types of HAR information that are not used when replaying from HAR. Defaults tofull.urlFilterstring | RegExp(optional)A glob or regex pattern to filter requests that are stored in the HAR. When a
baseURLvia the context options was provided and the passed URL is a path, it gets merged via thenew URL()constructor. Defaults to none.
Enables video recording for all pages into
recordVideo.dirdirectory. If not specified videos are not recorded. Make sure to awaitbrowserContext.close()for videos to be saved.dirpath(optional)Path to the directory to put videos into. If not specified, the videos will be stored in
artifactsDir(seebrowserType.launch()options).sizeObject(optional)Optional dimensions of the recorded videos. If not specified the size will be equal to
viewportscaled down to fit into 800x800. Ifviewportis not configured explicitly the video size defaults to 800x450. Actual picture of each page will be scaled down if necessary to fit the specified size.widthintVideo frame width.
heightintVideo frame height.
fpsint(optional)Frame rate of the recorded videos in frames per second. Defaults to
25. Firefox and WebKit currently capture up to 25 frames per second.showActionsObject(optional)If specified, enables visual annotations on interacted elements during video recording.
durationfloat(optional)How long each annotation is displayed in milliseconds. Defaults to
500.position"top-left" | "top" | "top-right" | "bottom-left" | "bottom" | "bottom-right"(optional)Position of the action title overlay. Defaults to
"top-right".fontSizeint(optional)Font size of the action title in pixels. Defaults to
24. Deprecated, usestyle.titleinstead.cursor"none" | "pointer"(optional)Cursor decoration shown for pointer actions.
"pointer"(the default) renders a mouse pointer that animates from the previous action point to the next one."none"disables the cursor decoration.styleObject(optional)Styles of the action decorations.
pointstring(optional)CSS declarations for the zero-sized marker centered on the action point. Not shown when omitted.
highlightstring(optional)CSS declarations for the box that covers the target element. Not shown when omitted.
titlestring(optional)CSS declarations for the action title.
reducedMotionnull | "reduce" | "no-preference"(optional)Emulates
'prefers-reduced-motion'media feature, supported values are'reduce','no-preference'. Seepage.emulateMedia()for more details. Passingnullresets emulation to system defaults. Defaults to'no-preference'.Emulates consistent window screen size available inside web page via
window.screen. Is only used when theviewportis set.widthintpage width in pixels.
heightintpage height in pixels.
serviceWorkers"allow" | "block"(optional)Whether to allow sites to register Service workers. Defaults to
'allow'.'allow': Service Workers can be registered.'block': Playwright will block all registration of Service Workers.
Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on.
strictSelectorsboolean(optional)If set to true, enables strict selectors mode for this context. In the strict selectors mode all operations on selectors that imply single target DOM element will throw when more than one element matches the selector. This option does not affect any Locator APIs (Locators are always strict). Defaults to
false. See Locator to learn more about the strict mode.Maximum time in milliseconds to wait for the browser instance to start. Defaults to
180000(3 minutes). Pass0to disable timeout.Changes the timezone of the context. See ICU's metaZones.txt for a list of supported timezone IDs. Defaults to the system timezone.
If specified, traces are saved into this directory.
Specific user agent to use in this context.
viewportnull | Object(optional)Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use
nullto disable the consistent viewport emulation. Learn more about viewport emulation.INFO
The
nullvalue opts out from the default presets, makes viewport depend on the host window size defined by the operating system. It makes the execution of the tests non-deterministic.widthintpage width in pixels.
heightintpage height in pixels.
Returns
Promise<BrowserContext>
browserType.launchServer()
Added in: v1.8 asyncReturns the browser app instance. You can connect to it via browserType.connect(), which requires the major/minor client/server version to match (1.2.3 → is compatible with 1.2.x).
Usage
Launches browser server that client can connect to. An example of launching a browser executable and connecting to it later:
const { chromium } = require('playwright'); // Or 'webkit' or 'firefox'.
(async () => {
const browserServer = await chromium.launchServer();
const wsEndpoint = browserServer.wsEndpoint();
// Use web socket endpoint later to establish a connection.
const browser = await chromium.connect(wsEndpoint);
// Close browser instance.
await browserServer.close();
})();Arguments
WARNING
Use custom browser args at your own risk, as some of them may break Playwright functionality.
Additional arguments to pass to the browser instance. The list of Chromium flags can be found here.
If specified, artifacts (traces, videos, downloads, HAR files, etc.) are saved into this directory. The directory is not cleaned up when the browser closes. If not specified, a temporary directory is used and cleaned up when the browser closes.
Browser distribution channel.
Use "chromium" to opt in to new headless mode.
Use "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev", or "msedge-canary" to use branded Google Chrome and Microsoft Edge.
chromiumSandboxboolean(optional)Enable Chromium sandboxing. Defaults to
false.If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and is deleted when browser is closed. In either case, the downloads are deleted when the browser context they were created in is closed.
executablePathpath(optional)Path to a browser executable to run instead of the bundled one. If
executablePathis a relative path, then it is resolved relative to the current working directory. Note that Playwright only works with the bundled Chromium, Firefox or WebKit, use at your own risk.firefoxUserPrefsObject<string, string | float | boolean>(optional)Firefox user preferences. Learn more about the Firefox user preferences at
about:config.You can also provide a path to a custom
policies.jsonfile viaPLAYWRIGHT_FIREFOX_POLICIES_JSONenvironment variable.handleSIGHUPboolean(optional)Close the browser process on SIGHUP. Defaults to
true.handleSIGINTboolean(optional)Close the browser process on Ctrl-C. Defaults to
true.handleSIGTERMboolean(optional)Close the browser process on SIGTERM. Defaults to
true.Whether to run browser in headless mode. More details for Chromium and Firefox. Defaults to
true.hoststring(optional) Added in: v1.45Host to use for the web socket. It is optional and defaults to
localhost, accepting connections only from the loopback interface. Pass an explicit address (e.g.0.0.0.0) to accept connections from the network.WARNING
The Browser Server has no authentication. A client that can reach the listening port and knows the
wsPathgets full control of the browser and can act as the OS user that started the server. When you pass an explicit host, restrict access to the port with your network configuration, for example a firewall, a private network or an authenticating proxy. Do not rely on thewsPathalone.ignoreDefaultArgsboolean | Array<string>(optional)If
true, Playwright does not pass its own configurations args and only uses the ones fromargs. If an array is given, then filters out the given default arguments. Dangerous option; use with care. Defaults tofalse.Logger sink for Playwright logging.
Port to use for the web socket. Defaults to 0 that picks any available port.
Network proxy settings.
serverstringProxy to be used for all requests. HTTP and SOCKS proxies are supported, for example
http://myproxy.com:3128orsocks5://myproxy.com:3128. Short formmyproxy.com:3128is considered an HTTP proxy.bypassstring(optional)Optional comma-separated domains to bypass proxy, for example
".com, chromium.org, .domain.com".usernamestring(optional)Optional username to use if HTTP proxy requires authentication.
passwordstring(optional)Optional password to use if HTTP proxy requires authentication.
Maximum time in milliseconds to wait for the browser instance to start. Defaults to
180000(3 minutes). Pass0to disable timeout.If specified, traces are saved into this directory.
wsPathstring(optional) Added in: v1.15Path at which to serve the Browser Server. For security, this defaults to an unguessable string.
WARNING
Any process or web page (including those running in Playwright) with knowledge of the
wsPathcan take control of the OS user. For this reason, you should use an unguessable token when using this option.The unguessable path protects a server on the loopback interface from web pages and from other local processes. It is not a replacement for network access control: the path is a part of the URL and is sent in plain text over
ws://. Seehost.
Returns
Promise<BrowserServer>
browserType.name()
Added in: v1.8Returns browser name. For example: 'chromium', 'webkit' or 'firefox'.
Returns
string