BrowserType

BrowserType 提供方法来启动特定的浏览器实例或连接到现有实例。以下是使用 Playwright 驱动自动化的典型示例

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();
})();

方法

connect

v1.9 之前添加

browserType.connect

此方法将 Playwright 附加到通过 Node.js 中的 BrowserType.launchServer 创建的现有浏览器实例。

注意

连接的 Playwright 实例的主版本和次版本需要与启动浏览器的 Playwright 版本匹配（1.2.3 → 兼容 1.2.x）。

用法

await browserType.connect(endpoint);
await browserType.connect(endpoint, options);

参数

endpoint string新增于: v1.10#

要连接的 Playwright 浏览器 WebSocket 端点。您可以通过 BrowserServer.wsEndpoint 获取此端点。
options Object (可选)
- exposeNetwork string (可选)新增于：v1.37#
  
  此选项将连接客户端上可用的网络暴露给要连接的浏览器。由逗号分隔的规则列表组成。
  
  可用规则
  1. 主机名模式，例如：example.com、*.org:99、x.*.y.com、*foo.org。
  2. IP 字面量，例如：127.0.0.1、0.0.0.0:99、[::1]、[0:0::1]:99。
  3. <loopback> 匹配本地回环接口：localhost、*.localhost、127.0.0.1、[::1]。
  一些常见示例
  1. "*" 暴露所有网络。
  2. "<loopback>" 暴露本地网络。
  3. "*.test.internal-domain,*.staging.internal-domain,<loopback>" 暴露测试/预发布部署和本地主机。
- headers Object<string, string> (可选)添加于：v1.11#
  
  要随 WebSocket 连接请求发送的额外 HTTP 头。可选。
- slowMo number (可选)新增于: v1.10#
  
  将 Playwright 操作减慢指定的毫秒数。有助于您查看正在发生的事情。默认为 0。
- timeout number (可选)新增于: v1.10#
  
  等待连接建立的最大时间（毫秒）。默认为 0（无超时）。

Promise<Browser>#

connectOverCDP

添加于：v1.9

browserType.connectOverCDP

此方法使用 Chrome DevTools 协议将 Playwright 附加到现有浏览器实例。

默认浏览器上下文可以通过 browser.contexts() 访问。

注意

通过 Chrome DevTools 协议连接仅支持基于 Chromium 的浏览器。

注意

此连接的保真度明显低于通过 browserType.connect() 进行的 Playwright 协议连接。如果您遇到问题或尝试使用高级功能，建议使用 browserType.connect()。

用法

const browser = await playwright.chromium.connectOverCDP('https://:9222');
const defaultContext = browser.contexts()[0];
const page = defaultContext.pages()[0];

参数

endpointURL string添加于：v1.11#

要连接的 CDP WebSocket 端点或 HTTP URL。例如 https://:9222/ 或 ws://127.0.0.1:9222/devtools/browser/387adf4c-243f-4051-a181-46798f4a46f4。
options Object (可选)
- artifactsDir string (可选)添加于：v1.61#
  
  如果指定，浏览器产物（如追踪记录和下载文件）将被保存到此目录中。
- endpointURL string (可选)新增于：v1.14#
  
  已弃用
  请改用第一个参数。
- headers Object<string, string> (可选)添加于：v1.11#
  
  要随连接请求发送的额外 HTTP 头。可选。
- isLocal boolean (可选)添加于: v1.58#
  
  告诉 Playwright 它与 CDP 服务器运行在同一台主机上。它将启用某些依赖于 Playwright 和浏览器之间文件系统相同的优化。
- noDefaults boolean (可选)添加于: v1.60#
  
  当为 true 时，Playwright 将不会对现有的默认浏览器上下文应用其默认覆盖。具体来说，acceptDownloads 将保持浏览器设置，不启用焦点模拟，且媒体模拟选项（如 colorScheme, reducedMotion, forcedColors 和 contrast）将不会被应用。当附加到用户日常使用的浏览器时非常有用，因为这些覆盖会干扰现有的浏览器状态。通过 browser.newContext() 创建的新上下文不受影响。默认为 false。
- slowMo number (可选)添加于：v1.11#
  
  将 Playwright 操作减慢指定的毫秒数。有助于您查看正在发生的事情。默认为 0。
- timeout number (可选)添加于：v1.11#
  
  等待连接建立的最大时间（毫秒）。默认为 30000（30 秒）。传递 0 禁用超时。

Promise<Browser>#

executablePath

v1.9 之前添加

browserType.executablePath

Playwright 期望找到捆绑浏览器可执行文件的路径。

用法

browserType.executablePath();

string #

launch

v1.9 之前添加

browserType.launch

返回浏览器实例。

用法

您可以使用 ignoreDefaultArgs 从默认参数中过滤掉 --mute-audio。

const browser = await chromium.launch({  // Or 'firefox' or 'webkit'.
  ignoreDefaultArgs: ['--mute-audio']
});

仅限 Chromium Playwright 也可以用来控制 Google Chrome 或 Microsoft Edge 浏览器，但它与随附的 Chromium 版本配合效果最佳。不保证能与其他任何版本协同工作。使用 executablePath 选项时请务必极其谨慎。

如果首选 Google Chrome（而不是 Chromium），建议使用 Chrome Canary 或 Dev Channel 构建版本。

像 Google Chrome 和 Microsoft Edge 这样的现成浏览器适合需要专有媒体编解码器进行视频播放的测试。参见这篇文章了解 Chromium 和 Chrome 之间的其他差异。这篇文章描述了 Linux 用户的一些差异。

参数

options Object (可选)
- args Array<string> (可选)#
  
  警告
  使用自定义浏览器参数需自行承担风险，因为其中一些参数可能会破坏 Playwright 的功能。
  
  传递给浏览器实例的附加参数。Chromium 标志列表可以在这里找到。
- artifactsDir string (可选)#
  
  如果指定，产物（追踪记录、视频、下载文件、HAR 文件等）将保存到此目录中。当浏览器关闭时，该目录不会被自动清理。如果未指定，则使用临时目录，并在浏览器关闭时清理。
- channel string (可选)#
  
  浏览器分发渠道。
  
  使用 "chromium" 以选择加入新的无头模式。
  
  使用 "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev" 或 "msedge-canary" 来使用品牌化的 Google Chrome 和 Microsoft Edge。
- chromiumSandbox boolean (可选)#
  
  启用 Chromium 沙盒。默认为 false。
- downloadsPath string (可选)#
  
  如果指定，接受的下载将下载到此目录。否则，将创建临时目录并在浏览器关闭时删除。在这两种情况下，下载将在创建它们的浏览器上下文关闭时删除。
- env Object<string, string | [undefined]> (可选)#
- executablePath string (可选)#
  
  要运行的浏览器可执行文件的路径，而不是使用随附的版本。如果 executablePath 是相对路径，则它会相对于当前工作目录进行解析。请注意，Playwright 仅适用于随附的 Chromium、Firefox 或 WebKit，使用风险自负。
- firefoxUserPrefs Object<string, string | number | boolean> (可选)#
  
  Firefox 用户偏好设置。在 about:config 了解更多关于 Firefox 用户偏好设置的信息。
  
  您还可以通过 PLAYWRIGHT_FIREFOX_POLICIES_JSON 环境变量提供自定义 policies.json 文件的路径。
- handleSIGHUP boolean (可选)#
  
  在收到 SIGHUP 信号时关闭浏览器进程。默认为 true。
- handleSIGINT boolean (可选)#
  
  在收到 Ctrl-C 信号时关闭浏览器进程。默认为 true。
- handleSIGTERM boolean (可选)#
  
  在收到 SIGTERM 信号时关闭浏览器进程。默认为 true。
- headless boolean (可选)#
  
  是否以无头模式运行浏览器。有关 Chromium 和 Firefox 的更多详细信息。默认为 true。
- ignoreDefaultArgs boolean | Array<string> (可选)#
  
  如果为 true，Playwright 将不会传递其自己的配置参数，而仅使用来自 args 的参数。如果给定一个数组，则过滤掉给定的默认参数。危险选项；请谨慎使用。默认为 false。
- logger Logger (可选)#
  
  已弃用
  日志记录器收到的日志不完整。请改用跟踪。
  
  Playwright 日志记录的日志接收器。
- proxy Object (可选)#
  - server string
    
    用于所有请求的代理。支持 HTTP 和 SOCKS 代理，例如 http://myproxy.com:3128 或 socks5://myproxy.com:3128。简写形式 myproxy.com:3128 被视为 HTTP 代理。
  - bypass string (可选)
    
    可选的逗号分隔的域以绕过代理，例如 ".com, chromium.org, .domain.com"。
  - username string (可选)
    
    如果 HTTP 代理需要身份验证，则使用的可选用户名。
  - password string (可选)
    
    如果 HTTP 代理需要身份验证，则使用的可选密码。
  网络代理设置。
- slowMo number (可选)#
  
  将 Playwright 操作减慢指定的毫秒数。有助于您查看正在发生的事情。
- timeout number (可选)#
  
  等待浏览器实例启动的最大时间（毫秒）。默认为 30000（30 秒）。传递 0 禁用超时。
- tracesDir string (可选)#
  
  如果指定，追踪将保存到此目录。

Promise<Browser>#

launchPersistentContext

v1.9 之前添加

browserType.launchPersistentContext

返回持久浏览器上下文实例。

启动使用位于 userDataDir 的持久化存储的浏览器，并返回唯一的上下文。关闭此上下文将自动关闭浏览器。

用法

await browserType.launchPersistentContext(userDataDir);
await browserType.launchPersistentContext(userDataDir, options);

参数

userDataDir string #

用户数据目录的路径，该目录存储浏览器会话数据，如 Cookie 和本地存储。传递空字符串以创建临时目录。

有关 Chromium 和 Firefox 的更多详细信息。Chromium 的用户数据目录是 chrome://version 中显示的“个人资料路径 (Profile Path)”的父目录。

请注意，浏览器不允许使用相同的用户数据目录启动多个实例。

警告
Chromium/Chrome：由于 Chrome 最近的政策变更，不支持自动化处理默认的 Chrome 用户个人资料。将 userDataDir 指向 Chrome 的主要“用户数据”目录（您日常浏览使用的个人资料）可能会导致页面无法加载或浏览器退出。请改为创建并使用一个单独的目录（例如，一个空文件夹）作为您的自动化个人资料。有关详情，请参见 https://developer.chrome.com/blog/remote-debugging-port。
options Object (可选)
- acceptDownloads boolean (可选)#
  
  是否自动下载所有附件。默认为 true，即接受所有下载。
- args Array<string> (可选)#
  
  警告
  使用自定义浏览器参数需自行承担风险，因为其中一些参数可能会破坏 Playwright 的功能。
  
  传递给浏览器实例的附加参数。Chromium 标志列表可以在这里找到。
- artifactsDir string (可选)#
  
  如果指定，产物（追踪记录、视频、下载文件、HAR 文件等）将保存到此目录中。当浏览器关闭时，该目录不会被自动清理。如果未指定，则使用临时目录，并在浏览器关闭时清理。
- baseURL string (可选)#
  
  当使用 page.goto(), page.route(), page.waitForURL(), page.waitForRequest() 或 page.waitForResponse() 时，它会通过使用 URL() 构造函数构建相应的 URL 来考虑基 URL。默认未设置。示例
  - baseURL: https://:3000，导航到 /bar.html 会得到 https://:3000/bar.html
  - baseURL: https://:3000/foo/，导航到 ./bar.html 会得到 https://:3000/foo/bar.html
  - baseURL: https://:3000/foo (不带尾部斜杠)，导航到 ./bar.html，结果为 https://:3000/bar.html
- bypassCSP boolean (可选)#
  
  切换是否绕过页面的 Content-Security-Policy。默认为 false。
- channel string (可选)#
  
  浏览器分发渠道。
  
  使用 "chromium" 以选择加入新的无头模式。
  
  使用 "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev" 或 "msedge-canary" 来使用品牌化的 Google Chrome 和 Microsoft Edge。
- chromiumSandbox boolean (可选)#
  
  启用 Chromium 沙盒。默认为 false。
- clientCertificates Array<Object> (可选)添加于: 1.46#
  - origin string
    
    证书有效的精确源。源包括 https 协议、主机名和可选的端口。
  - certPath string (可选)
    
    PEM 格式证书文件的路径。
  - cert Buffer (可选)
    
    PEM 格式证书的直接值。
  - keyPath string (可选)
    
    PEM 格式私钥文件的路径。
  - key Buffer (可选)
    
    PEM 格式私钥的直接值。
  - pfxPath string (可选)
    
    PFX 或 PKCS12 编码的私钥和证书链文件的路径。
  - pfx Buffer (可选)
    
    PFX 或 PKCS12 编码的私钥和证书链的直接值。
  - passphrase string (可选)
    
    私钥（PEM 或 PFX）的密码。
  TLS 客户端认证允许服务器请求并验证客户端证书。
  
  详情
  
  要使用的客户端证书数组。每个证书对象必须同时包含 certPath 和 keyPath，单个 pfxPath，或其相应的直接值（cert 和 key，或 pfx）。如果证书已加密，可以选择提供 passphrase 属性。origin 属性应提供与证书有效的请求源的确切匹配。
  
  仅当提供至少一个客户端证书时，客户端证书身份验证才处于活动状态。如果您想拒绝服务器发送的所有客户端证书，您需要提供一个 origin 与您计划访问的任何域都不匹配的客户端证书。
  
  注意
  在 macOS 上使用 WebKit 时，访问 localhost 将不会选取客户端证书。您可以通过将 localhost 替换为 local.playwright 来使其工作。
- colorScheme null | "light" | "dark" | "no-preference" (可选)#
  
  模拟 prefers-colors-scheme 媒体特性，支持的值为 'light' 和 'dark'。有关详细信息，请参见 page.emulateMedia()。传递 null 可将模拟重置为系统默认值。默认为 'light'。
- contrast null | "no-preference" | "more" (可选)#
  
  模拟 'prefers-contrast' 媒体特性，支持的值为 'no-preference' 和 'more'。有关详细信息，请参见 page.emulateMedia()。传递 null 可将模拟重置为系统默认值。默认为 'no-preference'。
- deviceScaleFactor number (可选)#
  
  指定设备缩放因子（可视为 dpr）。默认为 1。了解更多关于使用设备缩放因子模拟设备的信息。
- downloadsPath string (可选)#
  
  如果指定，接受的下载将下载到此目录。否则，将创建临时目录并在浏览器关闭时删除。在这两种情况下，下载将在创建它们的浏览器上下文关闭时删除。
- env Object<string, string | [undefined]> (可选)#
- executablePath string (可选)#
  
  要运行的浏览器可执行文件的路径，而不是使用随附的版本。如果 executablePath 是相对路径，则它会相对于当前工作目录进行解析。请注意，Playwright 仅适用于随附的 Chromium、Firefox 或 WebKit，使用风险自负。
- extraHTTPHeaders Object<string, string> (可选)#
  
  一个对象，包含要随每个请求发送的附加 HTTP 头。默认为无。
- firefoxUserPrefs Object<string, string | number | boolean> (可选)添加于：v1.40#
  
  Firefox 用户偏好设置。在 about:config 了解更多关于 Firefox 用户偏好设置的信息。
  
  您还可以通过 PLAYWRIGHT_FIREFOX_POLICIES_JSON 环境变量提供自定义 policies.json 文件的路径。
- forcedColors null | "active" | "none" (可选)#
  
  模拟 'forced-colors' 媒体特性，支持的值为 'active' 和 'none'。有关详细信息，请参见 page.emulateMedia()。传递 null 可将模拟重置为系统默认值。默认为 'none'。
- geolocation Object (可选)#
  - latitude number
    
    纬度，介于 -90 和 90 之间。
  - longitude number
    
    经度，介于 -180 和 180 之间。
  - accuracy number (可选)
    
    非负精度值。默认为 0。
- handleSIGHUP boolean (可选)#
  
  在收到 SIGHUP 信号时关闭浏览器进程。默认为 true。
- handleSIGINT boolean (可选)#
  
  在收到 Ctrl-C 信号时关闭浏览器进程。默认为 true。
- handleSIGTERM boolean (可选)#
  
  在收到 SIGTERM 信号时关闭浏览器进程。默认为 true。
- hasTouch boolean (可选)#
  
  指定视口是否支持触摸事件。默认为 false。了解更多关于移动设备模拟的信息。
- headless boolean (可选)#
  
  是否以无头模式运行浏览器。有关 Chromium 和 Firefox 的更多详细信息。默认为 true。
- httpCredentials Object (可选)#
  - username string
  - password string
  - origin string (可选)
    
    限制在特定源（scheme://host:port）上发送 http 凭据).
  - send "unauthorized" | "always" (可选)
    
    此选项仅适用于从相应的 APIRequestContext 发送的请求，不会影响从浏览器发送的请求。'always' - 带有基本身份验证凭据的 Authorization 头将随每个 API 请求发送。'unauthorized' - 仅当收到带有 WWW-Authenticate 头的 401（未授权）响应时，才会发送凭据。默认为 'unauthorized'。
  HTTP 身份验证的凭据。如果未指定 origin，则用户名和密码将在收到未授权响应时发送给任何服务器。
- ignoreDefaultArgs boolean | Array<string> (可选)#
  
  如果为 true，Playwright 将不会传递其自己的配置参数，而仅使用来自 args 的参数。如果给定一个数组，则过滤掉给定的默认参数。危险选项；请谨慎使用。默认为 false。
- ignoreHTTPSErrors boolean (可选)#
  
  发送网络请求时是否忽略 HTTPS 错误。默认为 false。
- isMobile boolean (可选)#
  
  是否考虑 meta viewport 标签并启用触摸事件。isMobile 是设备的一部分，因此您实际上不需要手动设置它。默认为 false，Firefox 不支持。了解更多关于移动设备模拟的信息。
- javaScriptEnabled boolean (可选)#
  
  是否在上下文中启用 JavaScript。默认为 true。了解更多关于禁用 JavaScript 的信息。
- locale string (可选)#
  
  指定用户区域设置，例如 en-GB, de-DE 等。区域设置将影响 navigator.language 值、Accept-Language 请求头值以及数字和日期格式规则。默认为系统默认区域设置。在我们的模拟指南中了解更多关于模拟的信息。
- logger Logger (可选)#
  
  已弃用
  日志记录器收到的日志不完整。请改用跟踪。
  
  Playwright 日志记录的日志接收器。
- offline boolean (可选)#
  
  是否模拟网络离线。默认为 false。了解更多关于网络模拟的信息。
- permissions Array<string> (可选)#
  
  授予此上下文中所有页面的权限列表。有关详细信息，请参见 browserContext.grantPermissions()。默认无。
- proxy Object (可选)#
  - server string
    
    用于所有请求的代理。支持 HTTP 和 SOCKS 代理，例如 http://myproxy.com:3128 或 socks5://myproxy.com:3128。简写形式 myproxy.com:3128 被视为 HTTP 代理。
  - bypass string (可选)
    
    可选的逗号分隔的域以绕过代理，例如 ".com, chromium.org, .domain.com"。
  - username string (可选)
    
    如果 HTTP 代理需要身份验证，则使用的可选用户名。
  - password string (可选)
    
    如果 HTTP 代理需要身份验证，则使用的可选密码。
  网络代理设置。
- recordHar Object (可选)#
  - omitContent boolean (可选)
    
    控制是否从 HAR 中省略请求内容的设置。默认为 false。已弃用，请改用 content 策略。
  - content "omit" | "embed" | "attach" (可选)
    
    可选设置，用于控制资源内容管理。如果指定 omit，则不保留内容。如果指定 attach，则资源将作为单独的文件或 ZIP 存档中的条目进行持久化。如果指定 embed，则内容将内联存储在 HAR 文件中，符合 HAR 规范。对于 .zip 输出文件，默认为 attach；对于所有其他文件扩展名，默认为 embed。
  - path string
    
    将 HAR 文件写入的文件系统路径。如果文件名以 .zip 结尾，则默认使用 content: 'attach'。
  - mode "full" | "minimal" (可选)
    
    设置为 minimal 时，仅记录从 HAR 路由所需的信息。这会省略 HAR 的大小、时间、页面、Cookie、安全性和其他类型的 HAR 信息，这些信息在从 HAR 重放时不使用。默认为 full。
  - urlFilter string | RegExp (可选)
    
    用于过滤存储在 HAR 中请求的 glob 或正则表达式模式。当通过上下文选项提供了 baseURL 且传入的 URL 为路径时，它会通过 new URL() 构造函数进行合并。默认无。
  启用所有页面向 recordHar.path 文件的 HAR 记录。如果未指定，则不会记录 HAR。请确保等待 browserContext.close() 以保存 HAR。
- recordVideo Object (可选)#
  - dir string (可选)
    
    存放视频的目录路径。如果未指定，视频将存储在 artifactsDir 中（参见 browserType.launch() 选项）。
  - size Object (可选)
    - width number
      
      视频帧宽度。
    - height number
      
      视频帧高度。
    已录制视频的可选尺寸。如果未指定，则尺寸将等于viewport，并缩小以适应 800x800。如果未明确配置viewport，则视频尺寸默认为 800x450。每页的实际图像在必要时将缩小以适应指定的尺寸。
  - showActions Object (可选)
    - duration number (可选)
      
      每个注释显示的持续时间（以毫秒为单位）。默认为 500。
    - position "top-left" | "top" | "top-right" | "bottom-left" | "bottom" | "bottom-right" (可选)
      
      操作标题覆盖层的位置。默认为 "top-right"。
    - fontSize number (可选)
      
      操作标题的字体大小（以像素为单位）。默认为 24。
    如果指定，则在录制视频期间启用对交互元素的视觉标注。
  启用所有页面向 recordVideo.dir 目录的视频记录。如果未指定，则不会记录视频。请确保等待 browserContext.close() 以保存视频。
- reducedMotion null | "reduce" | "no-preference" (可选)#
  
  模拟 'prefers-reduced-motion' 媒体特性，支持的值为 'reduce' 和 'no-preference'。有关详细信息，请参见 page.emulateMedia()。传递 null 可将模拟重置为系统默认值。默认为 'no-preference'。
- screen Object (可选)#
  - width number
    
    页面宽度（像素）。
  - height number
    
    页面高度（像素）。
  模拟网页内通过 window.screen 可用的统一窗口屏幕尺寸。仅在设置了 viewport 时使用。
- serviceWorkers "allow" | "block" (可选)#
  
  是否允许站点注册 Service Workers。默认为 'allow'。
  - 'allow'：可以注册 Service Workers。
  - 'block': Playwright 将阻止所有 Service Workers 的注册。
- slowMo number (可选)#
  
  将 Playwright 操作减慢指定的毫秒数。有助于您查看正在发生的事情。
- strictSelectors boolean (可选)#
  
  如果设置为 true，则为该上下文启用严格选择器模式。在严格选择器模式下，所有暗示单个目标 DOM 元素的选择器操作，当超过一个元素匹配选择器时，都会抛出异常。此选项不影响任何定位器 (Locator) API（定位器始终是严格的）。默认为 false。查看 Locator 以了解更多关于严格模式的信息。
- timeout number (可选)#
  
  等待浏览器实例启动的最大时间（毫秒）。默认为 30000（30 秒）。传递 0 禁用超时。
- timezoneId string (可选)#
  
  更改上下文的时区。查看 ICU 的 metaZones.txt 获取支持的时区 ID 列表。默认为系统时区。
- tracesDir string (可选)#
  
  如果指定，追踪将保存到此目录。
- userAgent string (可选)#
  
  此上下文中使用的特定用户代理。
- viewport null | Object (可选)#
  - width number
    
    页面宽度（像素）。
  - height number
    
    页面高度（像素）。
  为每个页面模拟统一的视口。默认为 1280x720 的视口。使用 null 可禁用统一视口模拟。了解更多关于视口模拟的信息。
  
  注意
  null 值会取消默认预设，使视口取决于操作系统定义的主机窗口大小。这会使测试的执行不确定。

Promise<BrowserContext>#

launchServer

v1.9 之前添加

browserType.launchServer

返回浏览器应用实例。您可以通过 browserType.connect() 连接到它，该连接要求主/次客户端/服务器版本匹配 (1.2.3 → 与 1.2.x 兼容)。

用法

启动浏览器服务器，客户端可以连接到它。一个启动浏览器可执行文件并稍后连接到它的示例

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();
})();

参数

options Object (可选)
- args Array<string> (可选)#
  
  警告
  使用自定义浏览器参数需自行承担风险，因为其中一些参数可能会破坏 Playwright 的功能。
  
  传递给浏览器实例的附加参数。Chromium 标志列表可以在这里找到。
- artifactsDir string (可选)#
  
  如果指定，产物（追踪记录、视频、下载文件、HAR 文件等）将保存到此目录中。当浏览器关闭时，该目录不会被自动清理。如果未指定，则使用临时目录，并在浏览器关闭时清理。
- channel string (可选)#
  
  浏览器分发渠道。
  
  使用 "chromium" 以选择加入新的无头模式。
  
  使用 "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev" 或 "msedge-canary" 来使用品牌化的 Google Chrome 和 Microsoft Edge。
- chromiumSandbox boolean (可选)#
  
  启用 Chromium 沙盒。默认为 false。
- downloadsPath string (可选)#
  
  如果指定，接受的下载将下载到此目录。否则，将创建临时目录并在浏览器关闭时删除。在这两种情况下，下载将在创建它们的浏览器上下文关闭时删除。
- env Object<string, string | [undefined]> (可选)#
- executablePath string (可选)#
  
  要运行的浏览器可执行文件的路径，而不是使用随附的版本。如果 executablePath 是相对路径，则它会相对于当前工作目录进行解析。请注意，Playwright 仅适用于随附的 Chromium、Firefox 或 WebKit，使用风险自负。
- firefoxUserPrefs Object<string, string | number | boolean> (可选)#
  
  Firefox 用户偏好设置。在 about:config 了解更多关于 Firefox 用户偏好设置的信息。
  
  您还可以通过 PLAYWRIGHT_FIREFOX_POLICIES_JSON 环境变量提供自定义 policies.json 文件的路径。
- handleSIGHUP boolean (可选)#
  
  在收到 SIGHUP 信号时关闭浏览器进程。默认为 true。
- handleSIGINT boolean (可选)#
  
  在收到 Ctrl-C 信号时关闭浏览器进程。默认为 true。
- handleSIGTERM boolean (可选)#
  
  在收到 SIGTERM 信号时关闭浏览器进程。默认为 true。
- headless boolean (可选)#
  
  是否以无头模式运行浏览器。有关 Chromium 和 Firefox 的更多详细信息。默认为 true。
- host string (可选)新增于: v1.45#
  
  用于 web socket 的主机。它是可选的，默认值为 localhost，仅接受来自回环接口的连接。传递一个明确的地址（例如 0.0.0.0）以接受来自网络的连接——请注意，这会将浏览器 RPC 暴露给任何可以到达监听端口的实体。
- ignoreDefaultArgs boolean | Array<string> (可选)#
  
  如果为 true，Playwright 将不会传递其自己的配置参数，而仅使用来自 args 的参数。如果给定一个数组，则过滤掉给定的默认参数。危险选项；请谨慎使用。默认为 false。
- logger Logger (可选)#
  
  已弃用
  日志记录器收到的日志不完整。请改用跟踪。
  
  Playwright 日志记录的日志接收器。
- port number (可选)#
  
  用于 web socket 的端口。默认为 0，即选择任何可用的端口。
- proxy Object (可选)#
  - server string
    
    用于所有请求的代理。支持 HTTP 和 SOCKS 代理，例如 http://myproxy.com:3128 或 socks5://myproxy.com:3128。简写形式 myproxy.com:3128 被视为 HTTP 代理。
  - bypass string (可选)
    
    可选的逗号分隔的域以绕过代理，例如 ".com, chromium.org, .domain.com"。
  - username string (可选)
    
    如果 HTTP 代理需要身份验证，则使用的可选用户名。
  - password string (可选)
    
    如果 HTTP 代理需要身份验证，则使用的可选密码。
  网络代理设置。
- timeout number (可选)#
  
  等待浏览器实例启动的最大时间（毫秒）。默认为 30000（30 秒）。传递 0 禁用超时。
- tracesDir string (可选)#
  
  如果指定，追踪将保存到此目录。
- wsPath string (可选)新增于: v1.15#
  
  提供浏览器服务器的路径。为了安全起见，此项默认为一个不可猜测的字符串。
  
  警告
  任何了解 wsPath 的进程或网页（包括在 Playwright 中运行的那些）都可以控制操作系统用户。因此，在使用此选项时，您应该使用一个不可猜测的令牌。

Promise<BrowserServer>#

name

v1.9 之前添加

browserType.name

返回浏览器名称。例如：'chromium'、'webkit' 或 'firefox'。

用法

browserType.name();

string #

方法​

connect​

connectOverCDP​

executablePath​

launch​

launchPersistentContext​

launchServer​

name​

方法

connect

connectOverCDP

executablePath

launch

launchPersistentContext

launchServer

name