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.newContext() 显式创建的 BrowserContext 实例上调用 browserContext.close()，**在**调用 browser.close() 之前。

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

用法

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

参数

options 对象 (可选)
- reason 字符串 (可选)添加于: 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 会话仅在基于 Chromium 的浏览器上受支持。

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

用法

await browser.newBrowserCDPSession();

返回值

Promise<CDPSession>#

newContext

早于 v1.9 添加

browser.newContext

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

注意

如果直接使用此方法创建 BrowserContext，最佳实践是通过 browserContext.close() 显式关闭返回的上下文，在您的代码完成 BrowserContext 时，并在调用 browser.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 对象 (可选)
- acceptDownloads boolean (可选)#
  
  是否自动下载所有附件。默认为 true，即接受所有下载。
- baseURL 字符串 (可选)#
  
  当使用 page.goto(), page.route(), page.waitForURL(), page.waitForRequest(), 或 page.waitForResponse() 时，它会考虑基本 URL，方法是使用 URL() 构造函数来构建相应的 URL。默认未设置。示例
  - baseURL: https://127.0.0.1:3000 并导航到 /bar.html 会得到 https://127.0.0.1:3000/bar.html
  - baseURL: https://127.0.0.1:3000/foo/ 并导航到 ./bar.html 会得到 https://127.0.0.1:3000/foo/bar.html
  - baseURL: https://127.0.0.1:3000/foo (没有尾部斜杠) 并导航到 ./bar.html 会得到 https://127.0.0.1:3000/bar.html
- bypassCSP boolean (可选)#
  
  切换绕过页面的内容安全策略 (Content-Security-Policy)。默认为 false。
- clientCertificates Array<对象> (可选)添加于: 1.46#
  - origin 字符串
    
    证书有效的确切来源。来源包括 https 协议、主机名和可选的端口。
  - certPath 字符串 (可选)
    
    PEM 格式证书文件的路径。
  - cert Buffer (可选)
    
    PEM 格式证书的直接值。
  - keyPath 字符串 (可选)
    
    PEM 格式私钥文件的路径。
  - key Buffer (可选)
    
    PEM 格式私钥的直接值。
  - pfxPath 字符串 (可选)
    
    PFX 或 PKCS12 编码的私钥和证书链文件的路径。
  - pfx Buffer (可选)
    
    PFX 或 PKCS12 编码的私钥和证书链的直接值。
  - passphrase 字符串 (可选)
    
    私钥（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'。
- deviceScaleFactor 数字 (可选)#
  
  指定设备缩放因子 (可以认为是 dpr)。默认为 1。了解更多关于使用设备缩放因子模拟设备的信息。
- extraHTTPHeaders 对象<字符串, 字符串> (可选)#
  
  一个包含要随每个请求一起发送的附加 HTTP 标头的对象。默认为无。
- forcedColors null | "active" | "none" (可选)#
  
  模拟 'forced-colors' 媒体功能，支持的值为 'active', 'none'。参见 page.emulateMedia() 了解更多详情。传递 null 会将模拟重置为系统默认值。默认为 'none'。
- geolocation 对象 (可选)#
  - latitude 数字
    
    纬度，介于 -90 和 90 之间。
  - longitude 数字
    
    经度，介于 -180 和 180 之间。
  - accuracy 数字 (可选)
    
    非负精度值。默认为 0。
- hasTouch boolean (可选)#
  
  指定视口是否支持触摸事件。默认为 false。了解更多关于移动设备模拟的信息。
- httpCredentials 对象 (可选)#
  - username 字符串
  - password 字符串
  - origin 字符串 (可选)
    
    限制在特定来源上发送 http 凭据 (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 字符串 (可选)#
  
  指定用户区域设置，例如 en-GB, de-DE 等。区域设置将影响 navigator.language 值、Accept-Language 请求标头值以及数字和日期格式规则。默认为系统默认区域设置。了解更多关于我们模拟指南中的模拟信息。
- logger Logger (可选)#
  
  用于 Playwright 日志记录的 Logger sink。
- offline boolean (可选)#
  
  是否模拟网络离线。默认为 false。了解更多关于网络模拟的信息。
- permissions Array<字符串> (可选)#
  
  要授予此上下文中所有页面的权限列表。参见 browserContext.grantPermissions() 了解更多详情。默认为无。
- proxy 对象 (可选)#
  - server 字符串
    
    用于所有请求的代理。支持 HTTP 和 SOCKS 代理，例如 http://myproxy.com:3128 或 socks5://myproxy.com:3128。简写形式 myproxy.com:3128 被视为 HTTP 代理。
  - bypass 字符串 (可选)
    
    可选的逗号分隔的域名，用于绕过代理，例如 ".com, chromium.org, .domain.com"。
  - username 字符串 (可选)
    
    如果 HTTP 代理需要身份验证，则使用的可选用户名。
  - password 字符串 (可选)
    
    如果 HTTP 代理需要身份验证，则使用的可选密码。
  要在此上下文中使用的网络代理设置。默认为无。
- recordHar 对象 (可选)#
  - omitContent boolean (可选)
    
    用于控制是否从 HAR 中省略请求内容的可选设置。默认为 false。已弃用，请使用 content 策略代替。
  - content "omit" | "embed" | "attach" (可选)
    
    用于控制资源内容管理的可选设置。如果指定 omit，则不会持久保存内容。如果指定 attach，则资源将持久保存为 ZIP 存档中的单独文件或条目。如果指定 embed，则内容将按照 HAR 规范以内联方式存储在 HAR 文件中。默认为 attach，对于 .zip 输出文件，默认为 embed 对于所有其他文件扩展名。
  - path 字符串
    
    在文件系统上写入 HAR 文件的路径。如果文件名以 .zip 结尾，则默认使用 content: 'attach'。
  - mode "full" | "minimal" (可选)
    
    当设置为 minimal 时，仅记录从 HAR 路由所需的信息。这将省略在从 HAR 重放时未使用的尺寸、计时、页面、Cookie、安全性和其他类型的 HAR 信息。默认为 full。
  - urlFilter 字符串 | RegExp (可选)
    
    用于过滤存储在 HAR 中的请求的 glob 或正则表达式模式。当通过上下文选项提供了 baseURL 并且传递的 URL 是路径时，它会通过 new URL() 构造函数合并。默认为无。
  启用 HAR 录制，将所有页面的录制内容记录到 recordHar.path 文件中。如果未指定，则不记录 HAR。确保等待 browserContext.close() 以保存 HAR。
- recordVideo 对象 (可选)#
  - dir 字符串
    
    将视频放入的目录路径。
  - size 对象 (可选)
    - width 数字
      
      视频帧宽度。
    - height 数字
      
      视频帧高度。
    录制视频的可选尺寸。如果未指定，则尺寸将等于 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 对象 (可选)#
  - width 数字
    
    页面宽度，以像素为单位。
  - height 数字
    
    页面高度，以像素为单位。
  模拟通过 window.screen 在网页中可用的统一窗口屏幕尺寸。仅当设置了 viewport 时才使用。
- serviceWorkers "allow" | "block" (可选)#
  
  是否允许站点注册 Service Worker。默认为 'allow'。
  - 'allow': Service Workers 可以注册。
  - 'block': Playwright 将阻止所有 Service Worker 的注册。
- storageState 字符串 | 对象 (可选)#
  - cookies Array<对象>
    - name 字符串
    - value 字符串
    - domain 字符串
      
      域名和路径是必需的。为了使 Cookie 也适用于所有子域名，请在域名前加上一个点，例如：".example.com"
    - path 字符串
      
      域名和路径是必需的
    - expires 数字
      
      Unix 时间戳，以秒为单位。
    - httpOnly boolean
    - secure boolean
    - sameSite "Strict" | "Lax" | "None"
      
      sameSite 标志
    为上下文设置的 Cookie
  - origins Array<对象>
    - origin 字符串
    - localStorage Array<对象>
      - name 字符串
      - value 字符串
    为上下文设置的 localStorage
  了解更多关于存储状态和身份验证的信息。
  
  使用给定的存储状态填充上下文。此选项可用于使用通过 browserContext.storageState() 获取的登录信息初始化上下文。
- strictSelectors boolean (可选)#
  
  如果设置为 true，则为此上下文启用严格选择器模式。在严格选择器模式下，当多个元素与选择器匹配时，对暗示单个目标 DOM 元素的选择器的所有操作都将抛出异常。此选项不影响任何 Locator API（Locator 始终是严格的）。默认为 false。参见 Locator，了解更多关于严格模式的信息。
- timezoneId 字符串 (可选)#
  
  更改上下文的时区。参见 ICU's metaZones.txt 以获取支持的时区 ID 列表。默认为系统时区。
- userAgent 字符串 (可选)#
  
  在此上下文中使用的特定用户代理。
- videoSize 对象 (可选)#
  
  已弃用
  请使用 recordVideo 代替。
  - width 数字
    
    视频帧宽度。
  - height 数字
    
    视频帧高度。
- videosPath 字符串 (可选)#
  
  已弃用
  请使用 recordVideo 代替。
- viewport null | 对象 (可选)#
  - width 数字
    
    页面宽度，以像素为单位。
  - height 数字
    
    页面高度，以像素为单位。
  为每个页面模拟一致的视口。默认为 1280x720 视口。使用 null 禁用一致的视口模拟。了解更多关于视口模拟的信息。
  
  注意
  该 null 值选择退出默认预设，使视口依赖于操作系统定义的主机窗口大小。这使得测试的执行具有不确定性。

返回值

Promise<BrowserContext>#

newPage

早于 v1.9 添加

browser.newPage

在新浏览器上下文中创建一个新页面。关闭此页面也会关闭上下文。

这是一个方便的 API，仅应用于单页场景和短代码片段。生产代码和测试框架应显式创建 browser.newContext()，然后是 browserContext.newPage()，以控制它们的精确生命周期。

用法

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

参数

options 对象 (可选)
- acceptDownloads boolean (可选)#
  
  是否自动下载所有附件。默认为 true，即接受所有下载。
- baseURL string (可选)#
  
  当使用 page.goto(), page.route(), page.waitForURL(), page.waitForRequest(), 或 page.waitForResponse() 时，它会考虑基本 URL，方法是使用 URL() 构造函数来构建相应的 URL。默认未设置。示例
  - baseURL: https://127.0.0.1:3000 并导航到 /bar.html 会得到 https://127.0.0.1:3000/bar.html
  - baseURL: https://127.0.0.1:3000/foo/ 并导航到 ./bar.html 会得到 https://127.0.0.1:3000/foo/bar.html
  - baseURL: https://127.0.0.1:3000/foo (没有尾部斜杠) 并导航到 ./bar.html 会得到 https://127.0.0.1:3000/bar.html
- bypassCSP boolean (可选)#
  
  切换绕过页面的内容安全策略 (Content-Security-Policy)。默认为 false。
- clientCertificates Array<对象> (可选)添加于: 1.46#
  - origin 字符串
    
    证书有效的确切来源。来源包括 https 协议、主机名和可选的端口。
  - certPath 字符串 (可选)
    
    PEM 格式证书文件的路径。
  - cert Buffer (可选)
    
    PEM 格式证书的直接值。
  - keyPath 字符串 (可选)
    
    PEM 格式私钥文件的路径。
  - key Buffer (可选)
    
    PEM 格式私钥的直接值。
  - pfxPath 字符串 (可选)
    
    PFX 或 PKCS12 编码的私钥和证书链文件的路径。
  - pfx Buffer (可选)
    
    PFX 或 PKCS12 编码的私钥和证书链的直接值。
  - passphrase 字符串 (可选)
    
    私钥（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'。
- deviceScaleFactor number (可选)#
  
  指定设备缩放因子 (可以认为是 dpr)。默认为 1。了解更多关于使用设备缩放因子模拟设备的信息。
- extraHTTPHeaders Object<string, string> (可选)#
  
  一个包含要随每个请求一起发送的附加 HTTP 标头的对象。默认为无。
- forcedColors null | "active" | "none" (可选)#
  
  模拟 'forced-colors' 媒体功能，支持的值为 'active', 'none'。参见 page.emulateMedia() 了解更多详情。传递 null 会将模拟重置为系统默认值。默认为 'none'。
- geolocation Object (可选)#
  - latitude 数字
    
    纬度，介于 -90 和 90 之间。
  - longitude 数字
    
    经度，介于 -180 和 180 之间。
  - accuracy 数字 (可选)
    
    非负精度值。默认为 0。
- hasTouch boolean (可选)#
  
  指定视口是否支持触摸事件。默认为 false。了解更多关于移动设备模拟的信息。
- httpCredentials Object (可选)#
  - username 字符串
  - password 字符串
  - origin 字符串 (可选)
    
    限制在特定来源上发送 http 凭据 (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 日志记录的 Logger sink。
- offline boolean (可选)#
  
  是否模拟网络离线。默认为 false。了解更多关于网络模拟的信息。
- permissions Array<string> (可选)#
  
  要授予此上下文中所有页面的权限列表。参见 browserContext.grantPermissions() 了解更多详情。默认为无。
- proxy Object (可选)#
  - server 字符串
    
    用于所有请求的代理。支持 HTTP 和 SOCKS 代理，例如 http://myproxy.com:3128 或 socks5://myproxy.com:3128。简写形式 myproxy.com:3128 被视为 HTTP 代理。
  - bypass 字符串 (可选)
    
    可选的逗号分隔的域名，用于绕过代理，例如 ".com, chromium.org, .domain.com"。
  - username 字符串 (可选)
    
    如果 HTTP 代理需要身份验证，则使用的可选用户名。
  - password 字符串 (可选)
    
    如果 HTTP 代理需要身份验证，则使用的可选密码。
  要在此上下文中使用的网络代理设置。默认为无。
- recordHar Object (可选)#
  - omitContent boolean (可选)
    
    用于控制是否从 HAR 中省略请求内容的可选设置。默认为 false。已弃用，请使用 content 策略代替。
  - content "omit" | "embed" | "attach" (可选)
    
    用于控制资源内容管理的可选设置。如果指定 omit，则不会持久保存内容。如果指定 attach，则资源将持久保存为 ZIP 存档中的单独文件或条目。如果指定 embed，则内容将按照 HAR 规范以内联方式存储在 HAR 文件中。默认为 attach，对于 .zip 输出文件，默认为 embed 对于所有其他文件扩展名。
  - path 字符串
    
    在文件系统上写入 HAR 文件的路径。如果文件名以 .zip 结尾，则默认使用 content: 'attach'。
  - mode "full" | "minimal" (可选)
    
    当设置为 minimal 时，仅记录从 HAR 路由所需的信息。这将省略在从 HAR 重放时未使用的尺寸、计时、页面、Cookie、安全性和其他类型的 HAR 信息。默认为 full。
  - urlFilter 字符串 | RegExp (可选)
    
    用于过滤存储在 HAR 中的请求的 glob 或正则表达式模式。当通过上下文选项提供了 baseURL 并且传递的 URL 是路径时，它会通过 new URL() 构造函数合并。默认为无。
  启用 HAR 录制，将所有页面的录制内容记录到 recordHar.path 文件中。如果未指定，则不记录 HAR。确保等待 browserContext.close() 以保存 HAR。
- recordVideo Object (可选)#
  - dir 字符串
    
    将视频放入的目录路径。
  - size 对象 (可选)
    - width 数字
      
      视频帧宽度。
    - height 数字
      
      视频帧高度。
    录制视频的可选尺寸。如果未指定，则尺寸将等于 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 数字
    
    页面宽度，以像素为单位。
  - height 数字
    
    页面高度，以像素为单位。
  模拟网页内通过 window.screen 可用的统一窗口屏幕尺寸。仅当设置了 viewport 时使用。
- serviceWorkers "allow" | "block" (可选)#
  
  是否允许站点注册 Service Worker。默认为 'allow'。
  - 'allow': Service Workers 可以注册。
  - 'block': Playwright 将阻止所有 Service Worker 的注册。
- storageState string | Object (可选)#
  - cookies Array<对象>
    - name 字符串
    - value 字符串
    - domain 字符串
      
      域名和路径是必需的。为了使 Cookie 也适用于所有子域名，请在域名前加上一个点，例如：".example.com"
    - path 字符串
      
      域名和路径是必需的
    - expires 数字
      
      Unix 时间戳，以秒为单位。
    - httpOnly boolean
    - secure boolean
    - sameSite "Strict" | "Lax" | "None"
      
      sameSite 标志
    为上下文设置的 Cookie
  - origins Array<对象>
    - origin 字符串
    - localStorage Array<对象>
      - name 字符串
      - value 字符串
    为上下文设置的 localStorage
  了解更多关于存储状态和身份验证的信息。
  
  使用给定的存储状态填充上下文。此选项可用于使用通过 browserContext.storageState() 获取的登录信息初始化上下文。
- strictSelectors boolean (可选)#
  
  如果设置为 true，则为此上下文启用严格选择器模式。在严格选择器模式下，当多个元素与选择器匹配时，对暗示单个目标 DOM 元素的选择器的所有操作都将抛出异常。此选项不影响任何 Locator API（Locator 始终是严格的）。默认为 false。参见 Locator，了解更多关于严格模式的信息。
- timezoneId string (可选)#
  
  更改上下文的时区。参见 ICU's metaZones.txt 以获取支持的时区 ID 列表。默认为系统时区。
- userAgent string (可选)#
  
  在此上下文中使用的特定用户代理。
- videoSize Object (可选)#
  
  已弃用
  请改用 recordVideo。
  - width 数字
    
    视频帧宽度。
  - height 数字
    
    视频帧高度。
- videosPath string (可选)#
  
  已弃用
  请改用 recordVideo。
- viewport null | Object (可选)#
  - width 数字
    
    页面宽度，以像素为单位。
  - height 数字
    
    页面高度，以像素为单位。
  为每个页面模拟一致的视口。默认为 1280x720 视口。使用 null 禁用一致的视口模拟。了解更多关于视口模拟的信息。
  
  注意
  该 null 值选择退出默认预设，使视口依赖于操作系统定义的主机窗口大小。这使得测试的执行具有不确定性。

返回值

Promise<Page>#

removeAllListeners

添加于: v1.47

browser.removeAllListeners

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

用法

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

参数

type string (可选)#
options 对象 (可选)
- behavior "wait" | "ignoreErrors" | "default" (可选)#
  
  指定是否等待已运行的监听器以及如果它们抛出错误时该怎么做
  - 'default' - 不等待当前监听器调用（如果有）完成，如果监听器抛出错误，可能会导致未处理的错误
  - 'wait' - 等待当前监听器调用（如果有）完成
  - 'ignoreErrors' - 不等待当前监听器调用（如果有）完成，移除后监听器抛出的所有错误将被静默捕获

返回值

Promise<void>#

startTracing

添加于: v1.11

browser.startTracing

注意

此API控制 Chromium 追踪，这是一个底层的 Chromium 专用调试工具。用于控制 Playwright 追踪的 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 对象 (可选)
- categories Array<string> (可选)#
  
  指定要使用的自定义类别，而不是默认类别。
- path string (可选)#
  
  写入追踪文件的路径。
- screenshots boolean (可选)#
  
  在追踪中捕获屏幕截图。

返回值

Promise<void>#

stopTracing

添加于: v1.11

browser.stopTracing

注意

此API控制 Chromium 追踪，这是一个底层的 Chromium 专用调试工具。用于控制 Playwright 追踪的 API 可以在这里找到。

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

用法

await browser.stopTracing();

返回值

Promise<Buffer>#

version

早于 v1.9 添加

browser.version

返回浏览器版本。

用法

browser.version();

返回值

string #

Events

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​

Events​

on('disconnected')​

方法

browserType

close

contexts

isConnected

newBrowserCDPSession

newContext

newPage

removeAllListeners

startTracing

stopTracing

version

Events

on('disconnected')