Browser

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

const { firefox } = require('playwright');  // Or 'chromium' or '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()。这将确保 context 优雅地关闭，并且任何人工制品（如 HAR 和视频）都会被完全刷新和保存。

Browser 对象本身被视为已释放，不能再使用。

用法

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

参数

options Object (可选)
- reason string (可选)添加于: v1.40#
  
  将报告给因浏览器关闭而中断的操作的原因。

返回值

Promise<void>#

contexts

添加于 v1.9 之前

browser.contexts

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

用法

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

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

返回值

Array<BrowserContext>#

isConnected

添加于 v1.9 之前

browser.isConnected

指示浏览器是否已连接。

用法

browser.isConnected();

返回值

boolean #

newBrowserCDPSession

添加于: v1.11

browser.newBrowserCDPSession

注意

CDP Session 仅在基于 Chromium 的浏览器上受支持。

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

用法

await browser.newBrowserCDPSession();

返回值

Promise<CDPSession>#

newContext

添加于 v1.9 之前

browser.newContext

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

注意

如果直接使用此方法创建 BrowserContext，最佳实践是在代码使用完 BrowserContext 后、调用 browser.close() **之前**，通过 browserContext.close() 显式关闭返回的上下文。这将确保 context 优雅地关闭，并且任何人工制品（如 HAR 和视频）都会被完全刷新和保存。

用法

(async () => {
  const browser = await playwright.firefox.launch();  // Or 'chromium' or 'webkit'.
  // Create a new incognito browser context.
  const context = await browser.newContext();
  // Create a new page in a pristine context.
  const page = await context.newPage();
  await page.goto('https://example.com');

  // Gracefully close up everything
  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() 构造函数构建相应的 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
    
    证书有效的确切源。源包括 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 属性应提供与证书有效的请求源精确匹配的值。
  
  注意
  在 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 (可选)
    
    限制在特定源 (scheme://host:port).
  - send "unauthorized" | "always" (可选)
    
    此选项仅适用于从相应的 APIRequestContext 发送的请求，不影响从浏览器发送的请求。'always' - 包含基本认证凭据的 Authorization 头将随每个 API 请求发送。'unauthorized' - 凭据仅在收到带有 WWW-Authenticate 头的 401 (Unauthorized) 响应时发送。默认为 'unauthorized'。
  用于 HTTP 认证的凭据。如果未指定源，则用户名和密码将随任何未经授权的响应发送到任何服务器。
- 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、安全以及从 HAR 重放时未使用的其他类型的 HAR 信息。默认为 full。
  - urlFilter string | RegExp (可选)
    
    用于过滤存储在 HAR 中的请求的 glob 或 regex 模式。当通过上下文选项提供了 baseURL 且传入的 URL 是路径时，它会通过 new URL() 构造函数进行合并。默认为无。
  为所有页面启用 HAR 记录到 recordHar.path 文件。如果未指定，则不记录 HAR。请确保等待 browserContext.close() 以保存 HAR。
- recordVideo Object (可选)#
  - dir string
    
    视频存放目录的路径。
  - size Object (可选)
    - width number
      
      视频帧宽度。
    - height number
      
      视频帧高度。
    录制视频的可选尺寸。如果未指定，尺寸将等于按比例缩小以适应 800x800 的 viewport。如果未明确配置 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 Workers 可以注册。
  - 'block'：Playwright 将阻止所有 Service Worker 的注册。
- storageState string | Object (可选)#
  - cookies Array<Object>
    - name string
    - value string
    - domain string
      
      域和路径是必需的。要使 cookie 也适用于所有子域，请在域前加上一个点，如下所示：“.example.com”
    - path string
      
      域和路径是必需的
    - 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 (可选)#
  
  更改上下文的时区。有关支持的时区 ID 列表，请参见 ICU 的 metaZones.txt。默认为系统时区。
- userAgent string (可选)#
  
  此上下文中使用的特定用户代理。
- 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() 构造函数构建相应的 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
    
    证书有效的确切源。源包括 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 属性应提供与证书有效的请求源精确匹配的值。
  
  注意
  在 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 (可选)
    
    限制在特定源 (scheme://host:port).
  - send "unauthorized" | "always" (可选)
    
    此选项仅适用于从相应的 APIRequestContext 发送的请求，不影响从浏览器发送的请求。'always' - 包含基本认证凭据的 Authorization 头将随每个 API 请求发送。'unauthorized' - 凭据仅在收到带有 WWW-Authenticate 头的 401 (Unauthorized) 响应时发送。默认为 'unauthorized'。
  用于 HTTP 认证的凭据。如果未指定源，则用户名和密码将随任何未经授权的响应发送到任何服务器。
- 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、安全以及从 HAR 重放时未使用的其他类型的 HAR 信息。默认为 full。
  - urlFilter string | RegExp (可选)
    
    用于过滤存储在 HAR 中的请求的 glob 或 regex 模式。当通过上下文选项提供了 baseURL 且传入的 URL 是路径时，它会通过 new URL() 构造函数进行合并。默认为无。
  为所有页面启用 HAR 记录到 recordHar.path 文件。如果未指定，则不记录 HAR。请确保等待 browserContext.close() 以保存 HAR。
- recordVideo Object (可选)#
  - dir string
    
    视频存放目录的路径。
  - size Object (可选)
    - width number
      
      视频帧宽度。
    - height number
      
      视频帧高度。
    录制视频的可选尺寸。如果未指定，尺寸将等于按比例缩小以适应 800x800 的 viewport。如果未明确配置 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 Workers 可以注册。
  - 'block'：Playwright 将阻止所有 Service Worker 的注册。
- storageState string | Object (可选)#
  - cookies Array<Object>
    - name string
    - value string
    - domain string
      
      域和路径是必需的。要使 cookie 也适用于所有子域，请在域前加上一个点，如下所示：“.example.com”
    - path string
      
      域和路径是必需的
    - 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 (可选)#
  
  更改上下文的时区。有关支持的时区 ID 列表，请参见 ICU 的 metaZones.txt。默认为系统时区。
- userAgent string (可选)#
  
  此上下文中使用的特定用户代理。
- 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.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')