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

• browserType.connect(wsEndpoint[, options])
• browserType.connectOverCDP(endpointURL[, options])
• browserType.executablePath()
• browserType.launch([options])
• browserType.launchPersistentContext(userDataDir[, options])
• browserType.launchServer([options])
• browserType.name()

browserType.connect(wsEndpoint[, options])

Added in: v1.8

• wsEndpoint <string> 要连接的浏览器 websocket 端点。Added in: v1.10#
• options? <Object>
  • headers? <Object<string, string>> 随 web socket 连接请求发送的附加 HTTP 标头。可选。Added in: v1.11#
  • logger? <Logger> Playwright 日志记录的日志接收器。可选。Added in: v1.14#
  • slowMo? <number> 将 Playwright 操作减慢指定的毫秒数。这很有用，这样你就可以看到发生了什么。默认为 0。Added in: v1.10#
  • timeout? <number> 等待连接建立的最大时间（毫秒）。默认为 0（无超时）。Added in: v1.10#
• returns: <Promise<Browser>>#

此方法将 Playwright 附加到现有的浏览器实例。当连接到通过 Node.js 中的 BrowserType.launchServer 启动的另一个浏览器时，主版本号和次版本号需要与客户端版本匹配（1.2.3 → 与 1.2.x 兼容）。

browserType.connectOverCDP(endpointURL[, options])

Added in: v1.9

• endpointURL <string> 要连接的 CDP websocket 端点或 http url。例如 http://localhost:9222/ 或 ws://127.0.0.1:9222/devtools/browser/387adf4c-243f-4051-a181-46798f4a46f4。Added in: v1.11#
• options? <Object>
  • endpointURL? <string> 已弃用，请改用第一个参数。可选。Added in: v1.14#
  • headers? <Object<string, string>> 随连接请求发送的附加 HTTP 标头。可选。Added in: v1.11#
  • logger? <Logger> Playwright 日志记录的日志接收器。可选。Added in: v1.14#
  • slowMo? <number> 将 Playwright 操作减慢指定的毫秒数。这很有用，这样你就可以看到发生了什么。默认为 0。Added in: v1.11#
  • timeout? <number> 等待连接建立的最大时间（毫秒）。默认为 30000（30 秒）。传递 0 以禁用超时。Added in: v1.11#
• returns: <Promise<Browser>>#

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

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

note

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

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

browserType.executablePath()

Added in: v1.8

• returns: <string>#

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

browserType.launch([options])

Added in: v1.8

• options? <Object>
  • args? <Array<string>> 传递给浏览器实例的附加参数。Chromium 标志列表可以在这里找到。#
  • channel? <string> 浏览器分发渠道。支持的值为 "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev", "msedge-canary"。阅读更多关于使用 Google Chrome 和 Microsoft Edge 的信息。#
  • chromiumSandbox? <boolean> 启用 Chromium 沙箱。默认为 false。#
  • devtools? <boolean> 仅限 Chromium 是否为每个选项卡自动打开开发者工具面板。如果此选项为 true，则 headless 选项将设置为 false。#
  • downloadsPath? <string> 如果指定，接受的下载将被下载到此目录中。否则，将创建临时目录并在浏览器关闭时删除。在任何一种情况下，当创建下载的浏览器上下文关闭时，下载都将被删除。#
  • env? <Object<string, string|number|boolean>> 指定对浏览器可见的环境变量。默认为 process.env。#
  • executablePath? <string> 运行浏览器可执行文件的路径，而不是捆绑的那个。如果 executablePath 是相对路径，则相对于当前工作目录解析。请注意，Playwright 仅适用于捆绑的 Chromium、Firefox 或 WebKit，使用风险自负。#
  • firefoxUserPrefs? <Object<string, string|number|boolean>> Firefox 用户首选项。在 about:config 中了解更多关于 Firefox 用户首选项的信息。#
  • handleSIGHUP? <boolean> 在 SIGHUP 上关闭浏览器进程。默认为 true。#
  • handleSIGINT? <boolean> 在 Ctrl-C 上关闭浏览器进程。默认为 true。#
  • handleSIGTERM? <boolean> 在 SIGTERM 上关闭浏览器进程。默认为 true。#
  • headless? <boolean> 是否以无头模式运行浏览器。有关 Chromium 和 Firefox 的更多详细信息。除非 devtools 选项为 true，否则默认为 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> 如果指定，跟踪将保存到此目录中。#
• returns: <Promise<Browser>>#

返回浏览器实例。

你可以使用 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 用户的一些差异。

browserType.launchPersistentContext(userDataDir[, options])

Added in: v1.8

• userDataDir <string> 用户数据目录的路径，其中存储浏览器会话数据，如 cookie 和本地存储。有关 Chromium 和 Firefox 的更多详细信息。请注意，Chromium 的用户数据目录是 chrome://version 中看到的“配置文件路径”的父目录。传递空字符串以使用临时目录。#
• options? <Object>
  • acceptDownloads? <boolean> 是否自动下载所有附件。默认为 true，即接受所有下载。#
  • args? <Array<string>> 传递给浏览器实例的附加参数。Chromium 标志列表可以在这里找到。#
  • baseURL? <string> 当使用 page.goto(url[, options])、page.route(url, handler[, options])、page.waitForURL(url[, options])、page.waitForRequest(urlOrPredicate[, options]) 或 page.waitForResponse(urlOrPredicate[, options]) 时，它通过使用 URL() 构造函数构建相应的 URL 来考虑基本 URL。示例：#
    • baseURL: http://localhost:3000 并且导航到 /bar.html 结果为 http://localhost:3000/bar.html
    • baseURL: http://localhost:3000/foo/ 并且导航到 ./bar.html 结果为 http://localhost:3000/foo/bar.html
    • baseURL: http://localhost:3000/foo (没有结尾斜杠) 并且导航到 ./bar.html 结果为 http://localhost:3000/bar.html
  • bypassCSP? <boolean> 切换绕过页面的内容安全策略。#
  • channel? <string> 浏览器分发渠道。支持的值为 "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev", "msedge-canary"。阅读更多关于使用 Google Chrome 和 Microsoft Edge 的信息。#
  • chromiumSandbox? <boolean> 启用 Chromium 沙箱。默认为 false。#
  • colorScheme? <"light"|"dark"|"no-preference"> 模拟 'prefers-colors-scheme' 媒体功能，支持的值为 'light'、'dark'、'no-preference'。有关更多详细信息，请参阅 page.emulateMedia([options])。默认为 'light'。#
  • deviceScaleFactor? <number> 指定设备缩放因子（可以认为是 dpr）。默认为 1。#
  • devtools? <boolean> 仅限 Chromium 是否为每个选项卡自动打开开发者工具面板。如果此选项为 true，则 headless 选项将设置为 false。#
  • downloadsPath? <string> 如果指定，接受的下载将被下载到此目录中。否则，将创建临时目录并在浏览器关闭时删除。在任何一种情况下，当创建下载的浏览器上下文关闭时，下载都将被删除。#
  • env? <Object<string, string|number|boolean>> 指定对浏览器可见的环境变量。默认为 process.env。#
  • executablePath? <string> 运行浏览器可执行文件的路径，而不是捆绑的那个。如果 executablePath 是相对路径，则相对于当前工作目录解析。请注意，Playwright 仅适用于捆绑的 Chromium、Firefox 或 WebKit，使用风险自负。#
  • extraHTTPHeaders? <Object<string, string>> 包含随每个请求发送的附加 HTTP 标头的对象。#
  • forcedColors? <"active"|"none"> 模拟 'forced-colors' 媒体功能，支持的值为 'active'、'none'。有关更多详细信息，请参阅 page.emulateMedia([options])。默认为 '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 的更多详细信息。除非 devtools 选项为 true，否则默认为 true。#
  • httpCredentials? <Object> HTTP 身份验证的凭据。#
    • username <string>
    • password <string>
  • ignoreDefaultArgs? <boolean|Array<string>> 如果为 true，Playwright 不会传递其自己的配置参数，而仅使用 args 中的参数。如果给出了数组，则过滤掉给定的默认参数。危险选项；请谨慎使用。默认为 false。#
  • ignoreHTTPSErrors? <boolean> 发送网络请求时是否忽略 HTTPS 错误。默认为 false。#
  • isMobile? <boolean> 是否考虑 meta viewport 标签并启用触摸事件。默认为 false。Firefox 不支持。#
  • javaScriptEnabled? <boolean> 是否在上下文中启用 JavaScript。默认为 true。#
  • locale? <string> 指定用户区域设置，例如 en-GB、de-DE 等。区域设置将影响 navigator.language 值、Accept-Language 请求标头值以及数字和日期格式规则。#
  • logger? <Logger> Playwright 日志记录的日志接收器。#
  • offline? <boolean> 是否模拟网络离线。默认为 false。#
  • permissions? <Array<string>> 授予此上下文中所有页面的权限列表。有关更多详细信息，请参阅 browserContext.grantPermissions(permissions[, options])。#
  • 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> 启用将所有页面的 HAR 录制到 recordHar.path 文件中。如果未指定，则不录制 HAR。确保等待 browserContext.close() 以保存 HAR。#
    • 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 信息。默认为 full。
    • urlFilter? <string|RegExp> 用于过滤存储在 HAR 中的请求的 glob 或 regex 模式。当通过上下文选项提供 baseURL 并且传递的 URL 是路径时，它将通过 new URL() 构造函数进行合并。
  • recordVideo? <Object> 启用将所有页面的视频录制到 recordVideo.dir 目录中。如果未指定，则不录制视频。确保等待 browserContext.close() 以保存视频。#
    • dir <string> 放置视频的目录路径。
    • size? <Object> 录制视频的可选尺寸。如果未指定，尺寸将等于 viewport 缩小以适应 800x800。如果未显式配置 viewport，则视频大小默认为 800x450。如果需要，每个页面的实际图片将按比例缩小以适应指定的大小。
      • width <number> 视频帧宽度。
      • height <number> 视频帧高度。
  • reducedMotion? <"reduce"|"no-preference"> 模拟 'prefers-reduced-motion' 媒体功能，支持的值为 'reduce'、'no-preference'。有关更多详细信息，请参阅 page.emulateMedia([options])。默认为 'no-preference'。#
  • screen? <Object> 通过 window.screen 模拟网页内可用的统一窗口屏幕大小。仅在设置了 viewport 时使用。#
    • width <number> 页面宽度（以像素为单位）。
    • height <number> 页面高度（以像素为单位）。
  • serviceWorkers? <"allow"|"block"> 是否允许站点注册 Service worker。默认为 'allow'。#
    • 'allow': 可以注册 Service Workers。
    • 'block': Playwright 将阻止所有 Service Worker 的注册。
  • slowMo? <number> 将 Playwright 操作减慢指定的毫秒数。这很有用，这样你就可以看到发生了什么。#
  • strictSelectors? <boolean> 如果指定，则为此上下文启用严格选择器模式。在严格选择器模式下，当多个元素与选择器匹配时，所有暗示单个目标 DOM 元素的选择器操作都将抛出异常。请参阅 Locator 以了解有关严格模式的更多信息。#
  • timeout? <number> 等待浏览器实例启动的最大时间（毫秒）。默认为 30000（30 秒）。传递 0 以禁用超时。#
  • timezoneId? <string> 更改上下文的时区。有关支持的时区 ID 列表，请参阅 ICU 的 metaZones.txt。#
  • tracesDir? <string> 如果指定，跟踪将保存到此目录中。#
  • userAgent? <string> 在此上下文中使用的特定用户代理。#
  • videoSize? <Object> 已弃用 请改用 recordVideo。#
    • width <number> 视频帧宽度。
    • height <number> 视频帧高度。
  • videosPath? <string> 已弃用 请改用 recordVideo。#
  • viewport? <null|Object> 为每个页面模拟一致的视口。默认为 1280x720 视口。null 禁用默认视口。#
    • width <number> 页面宽度（以像素为单位）。
    • height <number> 页面高度（以像素为单位）。
• returns: <Promise<BrowserContext>>#

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

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

browserType.launchServer([options])

Added in: v1.8

• options? <Object>

  • args? <Array<string>> 传递给浏览器实例的附加参数。Chromium 标志列表可以在这里找到。#

  • channel? <string> 浏览器分发渠道。支持的值为 "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev", "msedge-canary"。阅读更多关于使用 Google Chrome 和 Microsoft Edge 的信息。#

  • chromiumSandbox? <boolean> 启用 Chromium 沙箱。默认为 false。#

  • devtools? <boolean> 仅限 Chromium 是否为每个选项卡自动打开开发者工具面板。如果此选项为 true，则 headless 选项将设置为 false。#

  • downloadsPath? <string> 如果指定，接受的下载将被下载到此目录中。否则，将创建临时目录并在浏览器关闭时删除。在任何一种情况下，当创建下载的浏览器上下文关闭时，下载都将被删除。#

  • env? <Object<string, string|number|boolean>> 指定对浏览器可见的环境变量。默认为 process.env。#

  • executablePath? <string> 运行浏览器可执行文件的路径，而不是捆绑的那个。如果 executablePath 是相对路径，则相对于当前工作目录解析。请注意，Playwright 仅适用于捆绑的 Chromium、Firefox 或 WebKit，使用风险自负。#

  • firefoxUserPrefs? <Object<string, string|number|boolean>> Firefox 用户首选项。在 about:config 中了解更多关于 Firefox 用户首选项的信息。#

  • handleSIGHUP? <boolean> 在 SIGHUP 上关闭浏览器进程。默认为 true。#

  • handleSIGINT? <boolean> 在 Ctrl-C 上关闭浏览器进程。默认为 true。#

  • handleSIGTERM? <boolean> 在 SIGTERM 上关闭浏览器进程。默认为 true。#

  • headless? <boolean> 是否以无头模式运行浏览器。有关 Chromium 和 Firefox 的更多详细信息。除非 devtools 选项为 true，否则默认为 true。#

  • 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> 提供浏览器服务器的路径。为了安全起见，这默认为一个不可猜测的字符串。Added in: v1.15#

    danger

    任何知道 wsPath 的进程或网页（包括在 Playwright 中运行的进程或网页）都可以控制 OS 用户。因此，在使用此选项时，你应该使用一个不可猜测的令牌。

• returns: <Promise<BrowserServer>>#

返回浏览器应用实例。你可以通过 browserType.connect(wsEndpoint[, options]) 连接到它，这需要主/次客户端/服务器版本匹配（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();
})();

browserType.name()

Added in: v1.8

• returns: <string>#

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