跳至主要内容

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

返回值


close

新增于 v1.9 之前 browser.close

如果此浏览器是使用 browserType.launch() 获取的,则关闭浏览器及其所有页面(如果有)。

如果此浏览器已连接,则清除属于此浏览器的所有已创建上下文,并断开与浏览器服务器的连接。

注意

这类似于强制退出浏览器。因此,您应该在调用 browser.close() **之前** 对您之前使用 browser.newContext() 显式创建的任何 BrowserContext 调用 browserContext.close()

Browser 对象本身被视为已释放,无法再使用。

用法

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

参数

  • options 对象 (可选)
    • reason 字符串 (可选)新增于:v1.40#

      要报告给浏览器关闭中断的操作的原因。

返回值


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`

返回值


isConnected

新增于 v1.9 之前 browser.isConnected

指示浏览器是否已连接。

用法

browser.isConnected();

返回值


newBrowserCDPSession

新增于:v1.11 browser.newBrowserCDPSession
注意

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

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

用法

await browser.newBrowserCDPSession();

返回值


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 对象 (可选)
    • acceptDownloads 布尔值 (可选)#

      是否自动下载所有附件。默认为 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 布尔值 (可选)#

      切换是否绕过页面的内容安全策略。默认为 false

    • clientCertificates 数组<对象> (可选)新增于: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 客户端身份验证允许服务器请求客户端证书并进行验证。

      详情

      要使用的客户端证书数组。每个证书对象必须同时具有 certPathkeyPath,或者单个 pfxPath,或者其对应的直接值等效项(certkey,或 pfx)。如果证书已加密,则可以选择提供 passphrase 属性。应使用与证书有效的请求来源完全匹配的 origin 属性。

      注意

      在 macOS 上使用 WebKit 时,访问 localhost 将不会获取客户端证书。您可以通过将 localhost 替换为 local.playwright 来使其正常工作。

    • colorScheme null | "light" | "dark" | "no-preference" (可选)#

      模拟 'prefers-colors-scheme' 媒体功能,支持的值为 'light''dark''no-preference'。有关更多详细信息,请参阅 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 布尔值 (可选)#

      指定视口是否支持触摸事件。默认为 false。了解更多关于 移动设备模拟

    • httpCredentials 对象 (可选)#

      • username 字符串

      • password 字符串

      • origin 字符串 (可选)

        限制在特定来源(方案://主机:端口)上发送 HTTP 凭据).

      • send "unauthorized" | "always" (可选)

        此选项仅适用于从相应的 APIRequestContext 发送的请求,不影响从浏览器发送的请求。'always' - 每个 API 请求都将发送带有基本身份验证凭据的 Authorization 标头。'unauthorized - 仅在收到带有 WWW-Authenticate 标头的 401(未授权)响应时才发送凭据。默认为 'unauthorized'

      用于 HTTP 身份验证 的凭据。如果未指定来源,则在收到未授权响应时,用户名和密码将发送到任何服务器。

    • ignoreHTTPSErrors 布尔值 (可选)#

      发送网络请求时是否忽略 HTTPS 错误。默认为 false

    • isMobile 布尔值 (可选)#

      是否考虑 meta viewport 标签并启用触摸事件。isMobile 是设备的一部分,因此您实际上不需要手动设置它。默认为 false 并且在 Firefox 中不受支持。了解更多关于 移动设备模拟

    • javaScriptEnabled 布尔值 (可选)#

      是否在上下文中启用 JavaScript。默认为 true。了解更多关于 禁用 JavaScript

    • locale 字符串 (可选)#

      指定用户区域设置,例如 en-GBde-DE 等。区域设置将影响 navigator.language 值、Accept-Language 请求头值以及数字和日期格式规则。默认为系统默认区域设置。了解更多关于我们 模拟指南 中的模拟。

    • logger 日志记录器 (可选)#

      Playwright 日志记录的日志接收器。

    • offline 布尔值 (可选)#

      是否模拟网络脱机。默认为 false。了解更多关于 网络模拟

    • permissions 数组<字符串> (可选)#

      要授予此上下文中的所有页面的权限列表。有关更多详细信息,请参阅 browserContext.grantPermissions()。默认为无。

    • proxy 对象 (可选)#

      • server 字符串

        将用于所有请求的代理。支持 HTTP 和 SOCKS 代理,例如 http://myproxy.com:3128socks5://myproxy.com:3128。简写形式 myproxy.com:3128 被视为 HTTP 代理。

      • bypass 字符串 (可选)

        可选的逗号分隔的域名列表,用于绕过代理,例如 ".com, chromium.org, .domain.com"

      • username 字符串 (可选)

        如果 HTTP 代理需要身份验证,则使用可选的用户名。

      • password 字符串 (可选)

        如果 HTTP 代理需要身份验证,则使用可选的密码。

      要与此上下文一起使用的网络代理设置。默认为无。

    • recordHar 对象 (可选)#

      • omitContent 布尔值 (可选)

        可选设置,用于控制是否从 HAR 中省略请求内容。默认为 false。已弃用,请改用 content 策略。

      • content "omit" | "embed" | "attach" (可选)

        可选设置,用于控制资源内容管理。如果指定了 omit,则不会持久化内容。如果指定了 attach,则资源将作为单独的文件或 ZIP 档案中的条目持久化。如果指定了 embed,则内容将根据 HAR 规范内联存储在 HAR 文件中。对于 .zip 输出文件,默认为 attach;对于所有其他文件扩展名,默认为 embed

      • path 字符串

        要在文件系统上写入 HAR 文件的路径。如果文件名以 .zip 结尾,则默认使用 content: 'attach'

      • mode "full" | "minimal" (可选)

        设置为 minimal 时,仅记录 HAR 路由所需的信息。这省略了大小、时间、页面、cookie、安全性和 HAR 中未使用(例如从 HAR 重新播放时)的其他类型的信息。默认为 full

      • urlFilter 字符串 | 正则表达式 (可选)

        一个 glob 或正则表达式模式,用于过滤存储在 HAR 中的请求。当通过上下文选项提供了 baseURL 并且传递的 URL 是路径时,它将通过 new URL() 构造函数合并。默认为无。

      启用 HAR 记录,将所有页面记录到 recordHar.path 文件中。如果未指定,则不会记录 HAR。确保等待 browserContext.close() 以保存 HAR。

    • recordVideo 对象 (可选)#

      • dir 字符串

        要将视频放入的目录的路径。

      • size 对象 (可选)

        • width 数字

          视频帧宽度。

        • height 数字

          视频帧高度。

        录制视频的可选尺寸。如果未指定,则大小将等于缩放到 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 对象 (可选)#

      • width 数字

        页面宽度(以像素为单位)。

      • height 数字

        页面高度(以像素为单位)。

      模拟通过window.screen在网页内部可用的固定窗口屏幕尺寸。仅当设置了viewport时才使用。

    • serviceWorkers "allow" | "block" (可选)#

      是否允许站点注册服务工作者。默认为'allow'

      • 'allow':可以注册服务工作者
      • 'block':Playwright 将阻止所有服务工作者的注册。
    • storageState 字符串 | 对象 (可选)#

      了解有关存储状态和身份验证的更多信息。

      使用给定的存储状态填充上下文。此选项可用于使用通过browserContext.storageState()获取的登录信息初始化上下文。

    • strictSelectors 布尔值 (可选)#

      如果设置为 true,则为该上下文启用严格选择器模式。在严格选择器模式下,对暗示单个目标 DOM 元素的选择器执行的所有操作,当多个元素匹配选择器时都会抛出异常。此选项不影响任何 Locator API(Locator 始终是严格的)。默认为false。有关严格模式的更多信息,请参阅Locator

    • timezoneId 字符串 (可选)#

      更改上下文的时区。有关支持的时区 ID 列表,请参阅ICU 的 metaZones.txt。默认为系统时区。

    • userAgent 字符串 (可选)#

      在此上下文中使用的特定用户代理。

    • videoSize 对象 (可选)#

      已弃用

      请改用recordVideo

      • width 数字

        视频帧宽度。

      • height 数字

        视频帧高度。

    • videosPath 字符串 (可选)#

      已弃用

      请改用recordVideo

    • viewport null | 对象 (可选)#

      • width 数字

        页面宽度(以像素为单位)。

      • height 数字

        页面高度(以像素为单位)。

      为每个页面模拟一致的视口。默认为 1280x720 视口。使用null禁用一致的视口模拟。了解有关视口模拟的更多信息。

      注意

      null值会退出默认预设,使视口依赖于操作系统定义的主机窗口大小。这使得测试的执行不确定。

返回值


newPage

新增于 v1.9 之前 browser.newPage

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

这是一个便利的 API,仅应用于单页面场景和简短代码段。生产代码和测试框架应明确创建browser.newContext(),然后创建browserContext.newPage()以控制其确切的生命周期。

用法

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

参数

  • options 对象 (可选)
    • acceptDownloads 布尔值 (可选)#

      是否自动下载所有附件。默认为 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 布尔值 (可选)#

      切换是否绕过页面的内容安全策略。默认为 false

    • clientCertificates 数组<对象> (可选)新增于: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 客户端身份验证允许服务器请求客户端证书并进行验证。

      详情

      要使用的客户端证书数组。每个证书对象必须同时具有 certPathkeyPath,或者单个 pfxPath,或者其对应的直接值等效项(certkey,或 pfx)。如果证书已加密,则可以选择提供 passphrase 属性。应使用与证书有效的请求来源完全匹配的 origin 属性。

      注意

      在 macOS 上使用 WebKit 时,访问 localhost 将不会获取客户端证书。您可以通过将 localhost 替换为 local.playwright 来使其正常工作。

    • colorScheme null | "light" | "dark" | "no-preference" (可选)#

      模拟 'prefers-colors-scheme' 媒体功能,支持的值为 'light''dark''no-preference'。有关更多详细信息,请参阅 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 布尔值 (可选)#

      指定视口是否支持触摸事件。默认为 false。了解更多关于 移动设备模拟

    • httpCredentials 对象 (可选)#

      • username 字符串

      • password 字符串

      • origin 字符串 (可选)

        限制在特定来源(方案://主机:端口)上发送 HTTP 凭据).

      • send "unauthorized" | "always" (可选)

        此选项仅适用于从相应的 APIRequestContext 发送的请求,不影响从浏览器发送的请求。'always' - 每个 API 请求都将发送带有基本身份验证凭据的 Authorization 标头。'unauthorized - 仅在收到带有 WWW-Authenticate 标头的 401(未授权)响应时才发送凭据。默认为 'unauthorized'

      用于 HTTP 身份验证 的凭据。如果未指定来源,则在收到未授权响应时,用户名和密码将发送到任何服务器。

    • ignoreHTTPSErrors 布尔值 (可选)#

      发送网络请求时是否忽略 HTTPS 错误。默认为 false

    • isMobile 布尔值 (可选)#

      是否考虑 meta viewport 标签并启用触摸事件。isMobile 是设备的一部分,因此您实际上不需要手动设置它。默认为 false 并且在 Firefox 中不受支持。了解更多关于 移动设备模拟

    • javaScriptEnabled 布尔值 (可选)#

      是否在上下文中启用 JavaScript。默认为 true。了解更多关于 禁用 JavaScript

    • locale 字符串 (可选)#

      指定用户区域设置,例如 en-GBde-DE 等。区域设置将影响 navigator.language 值、Accept-Language 请求头值以及数字和日期格式规则。默认为系统默认区域设置。了解更多关于我们 模拟指南 中的模拟。

    • logger Logger (可选)#

      Playwright 日志记录的日志接收器。

    • offline 布尔值 (可选)#

      是否模拟网络脱机。默认为 false。了解更多关于 网络模拟

    • permissions 数组<字符串> (可选)#

      要授予此上下文中的所有页面的权限列表。有关更多详细信息,请参阅 browserContext.grantPermissions()。默认为无。

    • proxy 对象 (可选)#

      • server 字符串

        将用于所有请求的代理。支持 HTTP 和 SOCKS 代理,例如 http://myproxy.com:3128socks5://myproxy.com:3128。简写形式 myproxy.com:3128 被视为 HTTP 代理。

      • bypass 字符串 (可选)

        可选的逗号分隔的域名列表,用于绕过代理,例如 ".com, chromium.org, .domain.com"

      • username 字符串 (可选)

        如果 HTTP 代理需要身份验证,则使用可选的用户名。

      • password 字符串 (可选)

        如果 HTTP 代理需要身份验证,则使用可选的密码。

      要与此上下文一起使用的网络代理设置。默认为无。

    • recordHar 对象 (可选)#

      • omitContent 布尔值 (可选)

        可选设置,用于控制是否从 HAR 中省略请求内容。默认为 false。已弃用,请改用 content 策略。

      • content "omit" | "embed" | "attach" (可选)

        可选设置,用于控制资源内容管理。如果指定了 omit,则不会持久化内容。如果指定了 attach,则资源将作为单独的文件或 ZIP 档案中的条目持久化。如果指定了 embed,则内容将根据 HAR 规范内联存储在 HAR 文件中。对于 .zip 输出文件,默认为 attach;对于所有其他文件扩展名,默认为 embed

      • path 字符串

        要在文件系统上写入 HAR 文件的路径。如果文件名以 .zip 结尾,则默认使用 content: 'attach'

      • mode "full" | "minimal" (可选)

        设置为 minimal 时,仅记录 HAR 路由所需的信息。这省略了大小、时间、页面、cookie、安全性和 HAR 中未使用(例如从 HAR 重新播放时)的其他类型的信息。默认为 full

      • urlFilter 字符串 | 正则表达式 (可选)

        一个 glob 或正则表达式模式,用于过滤存储在 HAR 中的请求。当通过上下文选项提供了 baseURL 并且传递的 URL 是路径时,它将通过 new URL() 构造函数合并。默认为无。

      启用 HAR 记录,将所有页面记录到 recordHar.path 文件中。如果未指定,则不会记录 HAR。确保等待 browserContext.close() 以保存 HAR。

    • recordVideo 对象 (可选)#

      • dir 字符串

        要将视频放入的目录的路径。

      • size 对象 (可选)

        • width 数字

          视频帧宽度。

        • height 数字

          视频帧高度。

        录制视频的可选尺寸。如果未指定,则大小将等于缩放到 800x800 以内的viewport。如果未显式配置viewport,则视频大小默认为 800x450。如有必要,每个页面的实际图片将缩小以适合指定的尺寸。

      启用所有页面到recordVideo.dir目录的视频录制。如果未指定,则不录制视频。请确保等待browserContext.close()以保存视频。

    • reducedMotion | "reduce" | "no-preference" (可选)#

      模拟'prefers-reduced-motion'媒体功能,支持的值为'reduce''no-preference'。有关更多详细信息,请参阅page.emulateMedia()。传递null会将模拟重置为系统默认值。默认为'no-preference'

    • screen 对象 (可选)#

      • width 数字

        页面宽度(以像素为单位)。

      • height 数字

        页面高度(以像素为单位)。

      通过window.screen模拟网页内部始终可用的窗口屏幕尺寸。仅在设置了viewport时使用。

    • serviceWorkers "allow" | "block" (可选)#

      是否允许站点注册服务工作者。默认为'allow'

      • 'allow':可以注册服务工作者
      • 'block':Playwright 将阻止所有服务工作者的注册。
    • storageState 字符串 | 对象 (可选)#

      了解有关存储状态和身份验证的更多信息。

      使用给定的存储状态填充上下文。此选项可用于使用通过browserContext.storageState()获取的登录信息初始化上下文。

    • strictSelectors 布尔值 (可选)#

      如果设置为 true,则为该上下文启用严格选择器模式。在严格选择器模式下,对暗示单个目标 DOM 元素的选择器执行的所有操作,当多个元素匹配选择器时都会抛出异常。此选项不影响任何 Locator API(Locator 始终是严格的)。默认为false。有关严格模式的更多信息,请参阅Locator

    • timezoneId 字符串 (可选)#

      更改上下文的时区。有关支持的时区 ID 列表,请参阅ICU 的 metaZones.txt。默认为系统时区。

    • userAgent 字符串 (可选)#

      在此上下文中使用的特定用户代理。

    • videoSize 对象 (可选)#

      已弃用

      请使用 recordVideo 代替。

      • width 数字

        视频帧宽度。

      • height 数字

        视频帧高度。

    • videosPath 字符串 (可选)#

      已弃用

      请使用 recordVideo 代替。

    • viewport | 对象 (可选)#

      • width 数字

        页面宽度(以像素为单位)。

      • height 数字

        页面高度(以像素为单位)。

      为每个页面模拟一致的视口。默认为 1280x720 视口。使用null禁用一致的视口模拟。了解有关视口模拟的更多信息。

      注意

      null值会退出默认预设,使视口依赖于操作系统定义的主机窗口大小。这使得测试的执行不确定。

返回值


removeAllListeners

新增于:v1.47 browser.removeAllListeners

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

用法

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

参数

  • type 字符串 (可选)#
  • options 对象 (可选)
    • behavior "wait" | "ignoreErrors" | "default" (可选)#

      指定是否等待已运行的监听器以及如果它们抛出错误该怎么办

      • 'default' - 不等待当前监听器调用(如果有)完成,如果监听器抛出错误,可能会导致未处理的错误
      • 'wait' - 等待当前监听器调用(如果有)完成
      • 'ignoreErrors' - 不等待当前监听器调用(如果有)完成,移除后监听器抛出的所有错误都会被静默捕获

返回值


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 数组<字符串> (可选)#

      指定要使用的自定义类别以代替默认类别。

    • path 字符串 (可选)#

      写入跟踪文件的路径。

    • screenshots 布尔值 (可选)#

      在跟踪中捕获屏幕截图。

返回值


stopTracing

新增于:v1.11 browser.stopTracing
注意

此 API 控制 Chromium 追踪,这是一种低级 Chromium 特定的调试工具。控制 Playwright 追踪 的 API 可以在 此处 找到。

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

用法

await browser.stopTracing();

返回值


version

新增于 v1.9 之前 browser.version

返回浏览器版本。

用法

browser.version();

返回值


事件

on('disconnected')

新增于 v1.9 之前 browser.on('disconnected')

当浏览器与浏览器应用程序断开连接时发出。这可能是由于以下原因之一导致的

  • 浏览器应用程序关闭或崩溃。
  • 已调用 browser.close() 方法。

用法

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

事件数据