Browser

通过 browserType.launch() 创建一个 Browser。以下是使用 Browser 创建 Page 的示例：

const { firefox } = require('playwright');  // 或者 'chromium' 或 'webkit'。

(async () => {
  const browser = await firefox.launch();
  const page = await browser.newPage();
  await page.goto('https://example.com');
  await browser.close();
})();

方法

browserType

新增于: v1.23

browser.browserType

获取该浏览器所属的浏览器类型（chromium、firefox 或 webkit）。

用法

browser.browserType();

返回值

BrowserType #

close

v1.9 之前新增

browser.close

如果该浏览器是通过 browserType.launch() 获取的，则关闭浏览器及其所有页面（如果有打开的页面）。

如果该浏览器是连接获得的，则会清除属于该浏览器的所有已创建上下文，并断开与浏览器服务器的连接。

备注

这类似于强制退出浏览器。为了优雅地关闭页面并确保你能收到页面关闭事件，请在调用 browser.close() 之前，对你之前通过 browser.newContext() 显式创建的所有 BrowserContext 实例调用 browserContext.close()。

Browser 对象本身会被视为已销毁，不能再被使用。

用法

await browser.close();
await browser.close(options);

参数

options Object (可选)
- reason string (可选) 新增于: v1.40#
  
  关闭浏览器时中断操作所报告的原因。

返回值

Promise<void>#

contexts

v1.9 之前新增

browser.contexts

返回所有已打开的浏览器上下文的数组。在新创建的浏览器中，这将返回 0 个浏览器上下文。

用法

const browser = await pw.webkit.launch();
console.log(browser.contexts().length); // 输出 `0`

const context = await browser.newContext();
console.log(browser.contexts().length); // 输出 `1`

返回值

Array<BrowserContext>#

isConnected

v1.9 之前新增

browser.isConnected

指示浏览器是否已连接。

用法

browser.isConnected();

返回值

boolean #

newBrowserCDPSession

新增于: v1.11

browser.newBrowserCDPSession

备注

CDP 会话仅支持基于 Chromium 的浏览器。

返回新创建的浏览器会话。

用法

await browser.newBrowserCDPSession();

返回值

Promise<CDPSession>#

newContext

v1.9 之前新增

browser.newContext

创建一个新的浏览器上下文。它不会与其他浏览器上下文共享 cookies/缓存。

备注

如果直接使用此方法创建 BrowserContext，最佳实践是在代码用完该 BrowserContext 后，并且在调用 browser.close() 之前，显式调用 browserContext.close() 关闭返回的上下文。这将确保 context 被优雅地关闭，所有的产物（如 HAR 和视频）都被完整刷新和保存。

用法

(async () => {
  const browser = await playwright.firefox.launch();  // 或者 'chromium' 或 'webkit'。
  // 创建一个新的无痕浏览器上下文。
  const context = await browser.newContext();
  // 在全新的上下文中创建一个新页面。
  const page = await context.newPage();
  await page.goto('https://example.com');

  // 优雅地关闭所有内容
  await context.close();
  await browser.close();
})();

参数

options Object (可选)
- acceptDownloads boolean (可选)#
  
  是否自动下载所有附件。默认为 true，即所有下载都会被接受。
- baseURL string (可选)#
  
  在使用 page.goto()、page.route()、page.waitForURL()、page.waitForRequest() 或 page.waitForResponse() 时，会通过 URL() 构造函数来拼接对应的 URL，考虑 base 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 (可选)#
  
  是否绕过页面的 Content-Security-Policy。默认为 false。
- clientCertificates Array<Object> (可选) 新增于: 1.46#
  - origin string
    
    证书有效的精确 origin。origin 包含 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。了解更多关于设备像素比模拟。
- extraHTTPHeaders Object<string, string> (可选)#
  
  包含每个请求要发送的额外 HTTP 头的对象。默认无。
- 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。
- hasTouch boolean (可选)#
  
  指定视口是否支持触摸事件。默认为 false。了解更多移动端模拟。
- httpCredentials Object (可选)#
  - username string
  - password string
  - origin string (可选)
    
    限定仅在特定 origin（scheme://host:port）发送 http 凭据。
  - send "unauthorized" | "always" (可选)
    
    此选项仅适用于对应 APIRequestContext 发送的请求，不影响浏览器发出的请求。'always' - 每个 API 请求都会携带带有基本认证凭据的 Authorization 头。'unauthorized' - 仅在收到带有 WWW-Authenticate 头的 401（未授权）响应时发送凭据。默认为 'unauthorized'。
  HTTP 认证凭据。如果未指定 origin，则用户名和密码会在收到未授权响应时发送给任意服务器。
- 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 路由所需的信息。不会记录大小、时序、页面、cookie、安全等信息。默认为 full。
  - urlFilter string | RegExp (可选)
    
    用于过滤存储到 HAR 的请求的 glob 或正则表达式。当通过上下文选项提供了 baseURL 且传递的 URL 是路径时，会通过 new URL() 合并。默认无。
  为所有页面启用 HAR 录制，保存到 recordHar.path 文件。如果未指定，则不录制 HAR。请确保在 browserContext.close() 后再读取 HAR 文件。
- recordVideo Object (可选)#
  - dir string
    
    视频保存的目录路径。
  - size Object (可选)
    - width number
      
      视频帧宽度。
    - height number
      
      视频帧高度。
    录制视频的可选尺寸。如果未指定，则等于 viewport，并缩放到最大 800x800。如果未显式配置 viewport，则视频尺寸默认为 800x450。每个页面的实际画面会根据需要缩放以适应指定尺寸。
  为所有页面启用视频录制，保存到 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 Worker。默认为 'allow'。
  - 'allow'：Service Worker 可以被注册。
  - 'block'：Playwright 会阻止所有 Service Worker 注册。
- storageState string | Object (可选)#
  - cookies Array<Object>
    - name string
    - value string
    - domain string
      
      必须指定 domain 和 path。若要让 cookie 适用于所有子域，domain 前加点，如 ".example.com"
    - path string
      
      必须指定 domain 和 path
    - expires number
      
      Unix 时间戳（秒）。
    - httpOnly boolean
    - secure boolean
    - sameSite "Strict" | "Lax" | "None"
      
      sameSite 标志
    要为上下文设置的 cookie
  - origins Array<Object>
    - origin string
    - localStorage Array<Object>
      - name string
      - value string
      要为上下文设置的 localStorage
  了解更多关于存储状态与认证。
  
  用给定的存储状态初始化上下文。可用于用 browserContext.storageState() 获取的登录信息初始化上下文。
- strictSelectors boolean (可选)#
  
  若设置为 true，则为该上下文启用严格选择器模式。在严格模式下，所有要求唯一 DOM 元素的选择器操作，如果匹配到多个元素会抛出异常。此选项不影响 Locator API（Locator 始终严格）。默认为 false。详见 Locator 了解严格模式。
- timezoneId string (可选)#
  
  更改上下文的时区。详见 ICU 的 metaZones.txt 获取支持的时区 ID。默认为系统时区。
- userAgent string (可选)#
  
  要在该上下文中使用的特定 User-Agent。
- videoSize Object (可选)#
  
  已废弃
  请使用 recordVideo 代替。
  - width number
    
    视频帧宽度。
  - height number
    
    视频帧高度。
- videosPath string (可选)#
  
  已废弃
  请使用 recordVideo 代替。
- viewport null | Object (可选)#
  - width number
    
    页面宽度（像素）。
  - height number
    
    页面高度（像素）。
  为每个页面模拟一致的视口。默认为 1280x720 视口。使用 null 可禁用一致视口模拟。了解更多视口模拟。
  
  备注
  null 值会跳过默认预设，使视口取决于操作系统定义的主机窗口大小。这样会导致测试执行结果不确定。

返回值

Promise<BrowserContext>#

newPage

v1.9 之前新增

browser.newPage

在新的浏览器上下文中创建一个新页面。关闭该页面时也会关闭对应的上下文。

这是一个便捷 API，仅建议用于单页面场景和简短代码片段。生产环境代码和测试框架应显式调用 browser.newContext() 后再调用 browserContext.newPage() 以便精确控制生命周期。

用法

await browser.newPage();
await browser.newPage(options);

参数

options Object (可选)
- acceptDownloads boolean (可选)#
  
  是否自动下载所有附件。默认为 true，即所有下载都会被接受。
- baseURL string (可选)#
  
  在使用 page.goto()、page.route()、page.waitForURL()、page.waitForRequest() 或 page.waitForResponse() 时，会通过 URL() 构造函数来拼接对应的 URL，考虑 base 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 (可选)#
  
  是否绕过页面的 Content-Security-Policy。默认为 false。
- clientCertificates Array<Object> (可选) 新增于: 1.46#
  - origin string
    
    证书有效的精确 origin。origin 包含 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。了解更多关于设备像素比模拟。
- extraHTTPHeaders Object<string, string> (可选)#
  
  包含每个请求要发送的额外 HTTP 头的对象。默认无。
- 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。
- hasTouch boolean (可选)#
  
  指定视口是否支持触摸事件。默认为 false。了解更多移动端模拟。
- httpCredentials Object (可选)#
  - username string
  - password string
  - origin string (可选)
    
    限定仅在特定 origin（scheme://host:port）发送 http 凭据。
  - send "unauthorized" | "always" (可选)
    
    此选项仅适用于对应 APIRequestContext 发送的请求，不影响浏览器发出的请求。'always' - 每个 API 请求都会携带带有基本认证凭据的 Authorization 头。'unauthorized' - 仅在收到带有 WWW-Authenticate 头的 401（未授权）响应时发送凭据。默认为 'unauthorized'。
  HTTP 认证凭据。如果未指定 origin，则用户名和密码会在收到未授权响应时发送给任意服务器。
- 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 路由所需的信息。不会记录大小、时序、页面、cookie、安全等信息。默认为 full。
  - urlFilter string | RegExp (可选)
    
    用于过滤存储到 HAR 的请求的 glob 或正则表达式。当通过上下文选项提供了 baseURL 且传递的 URL 是路径时，会通过 new URL() 合并。默认无。
  为所有页面启用 HAR 录制，保存到 recordHar.path 文件。如果未指定，则不录制 HAR。请确保在 browserContext.close() 后再读取 HAR 文件。
- recordVideo Object (可选)#
  - dir string
    
    视频保存的目录路径。
  - size Object (可选)
    - width number
      
      视频帧宽度。
    - height number
      
      视频帧高度。
    录制视频的可选尺寸。如果未指定，则等于 viewport，并缩放到最大 800x800。如果未显式配置 viewport，则视频尺寸默认为 800x450。每个页面的实际画面会根据需要缩放以适应指定尺寸。
  为所有页面启用视频录制，保存到 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 Worker。默认为 'allow'。
  - 'allow'：Service Worker 可以被注册。
  - 'block'：Playwright 会阻止所有 Service Worker 注册。
- storageState string | Object (可选)#
  - cookies Array<Object>
    - name string
    - value string
    - domain string
      
      必须指定 domain 和 path。若要让 cookie 适用于所有子域，domain 前加点，如 ".example.com"
    - path string
      
      必须指定 domain 和 path
    - expires number
      
      Unix 时间戳（秒）。
    - httpOnly boolean
    - secure boolean
    - sameSite "Strict" | "Lax" | "None"
      
      sameSite 标志
    要为上下文设置的 cookie
  - origins Array<Object>
    - origin string
    - localStorage Array<Object>
      - name string
      - value string
      要为上下文设置的 localStorage
  了解更多关于存储状态与认证。
  
  用给定的存储状态初始化上下文。可用于用 browserContext.storageState() 获取的登录信息初始化上下文。
- strictSelectors boolean (可选)#
  
  若设置为 true，则为该上下文启用严格选择器模式。在严格模式下，所有要求唯一 DOM 元素的选择器操作，如果匹配到多个元素会抛出异常。此选项不影响 Locator API（Locator 始终严格）。默认为 false。详见 Locator 了解严格模式。
- timezoneId string (可选)#
  
  更改上下文的时区。详见 ICU 的 metaZones.txt 获取支持的时区 ID。默认为系统时区。
- userAgent string (可选)#
  
  要在该上下文中使用的特定 User-Agent。
- videoSize Object (可选)#
  
  已废弃
  请使用 recordVideo 代替。
  - width number
    
    视频帧宽度。
  - height number
    
    视频帧高度。
- videosPath string (可选)#
  
  已废弃
  请使用 recordVideo 代替。
- viewport null | Object (可选)#
  - width number
    
    页面宽度（像素）。
  - height number
    
    页面高度（像素）。
  为每个页面模拟一致的视口。默认为 1280x720 视口。使用 null 可禁用一致视口模拟。了解更多视口模拟。
  
  备注
  null 值会跳过默认预设，使视口取决于操作系统定义的主机窗口大小。这样会导致测试执行结果不确定。

返回值

Promise<Page>#

removeAllListeners

新增于: v1.47

browser.removeAllListeners

移除指定类型的所有监听器（如果未指定类型，则移除所有已注册的监听器）。允许等待异步监听器完成，或忽略这些监听器后续抛出的错误。

用法

await browser.removeAllListeners();
await browser.removeAllListeners(type, options);

参数

type string (可选)#
options Object (可选)
- behavior "wait" | "ignoreErrors" | "default" (可选)#
  
  指定是否等待已在运行的监听器完成，以及当监听器抛出错误时的处理方式：
  - 'default' - 不等待当前监听器调用（如有）完成，如果监听器抛出异常，可能导致未处理的错误
  - 'wait' - 等待当前监听器调用（如有）完成
  - 'ignoreErrors' - 不等待当前监听器调用（如有）完成，移除后监听器抛出的所有错误都会被静默捕获

返回值

Promise<void>#

startTracing

新增于: v1.11

browser.startTracing

备注

该 API 控制 Chromium Tracing，这是一个 Chromium 专用的底层调试工具。用于控制 Playwright Tracing 的 API 请见此处。

你可以使用 browser.startTracing() 和 browser.stopTracing() 创建一个可在 Chrome DevTools 性能面板中打开的追踪文件。

用法

await browser.startTracing(page, { path: 'trace.json' });
await page.goto('https://www.google.com');
await browser.stopTracing();

参数

page Page (可选)#

可选，如果指定，则追踪会包含该页面的截图。
options Object (可选)
- categories Array<string> (可选)#
  
  指定自定义的追踪类别，替代默认值。
- path string (可选)#
  
  追踪文件写入的路径。
- screenshots boolean (可选)#
  
  是否在追踪中捕获截图。

返回值

Promise<void>#

stopTracing

新增于: v1.11

browser.stopTracing

备注

该 API 控制 Chromium Tracing，这是一个 Chromium 专用的底层调试工具。用于控制 Playwright Tracing 的 API 请见此处。

返回包含追踪数据的缓冲区。

用法

await browser.stopTracing();

返回值

Promise<Buffer>#

version

v1.9 之前新增

browser.version

返回浏览器的版本号。

用法

browser.version();

返回值

string #

事件

on('disconnected')

v1.9 之前新增

browser.on('disconnected')

当 Browser 与浏览器应用断开连接时触发。可能由于以下原因之一导致：

浏览器应用被关闭或崩溃。
调用了 browser.close() 方法。

用法

browser.on('disconnected', data => {});

事件数据

Browser

方法​

browserType​

close​

contexts​

isConnected​

newBrowserCDPSession​

newContext​

newPage​

removeAllListeners​

startTracing​

stopTracing​

version​

事件​

on('disconnected')​

方法

browserType

close

contexts

isConnected

newBrowserCDPSession

newContext

newPage

removeAllListeners

startTracing

stopTracing

version

事件

on('disconnected')