跳转到主要内容

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 Object (可选)

    • reason string (可选)添加于：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/缓存。

注意

如果直接使用此方法创建 BrowserContexts，最佳实践是在代码完成 BrowserContext 的使用后，并在调用 browser.close() 之前，通过 browserContext.close() 显式关闭返回的上下文。这将确保上下文正常关闭，并且所有工件（如 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，从而将 baseURL 考虑在内。默认情况下未设置。示例：

      • baseURL: https://:3000，导航到 /bar.html 会得到 https://:3000/bar.html
      • baseURL: https://:3000/foo/，导航到 ./bar.html 会得到 https://:3000/foo/bar.html
      • baseURL: https://:3000/foo (不带尾部斜杠)，导航到 ./bar.html，结果为 https://: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 属性，并与证书有效的请求来源完全匹配。

      仅当至少提供一个客户端证书时，客户端证书认证才有效。如果您想拒绝服务器发送的所有客户端证书，您需要提供一个 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）上发送 http 凭据).

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

        此选项仅适用于从相应的 APIRequestContext 发送的请求，不影响从浏览器发送的请求。 'always' - 每个 API 请求都会发送带有基本身份验证凭据的 Authorization 标头。 'unauthorized - 凭据仅在收到带有 WWW-Authenticate 标头的 401（未授权）响应时发送。默认为 '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 路由所需的信息。这会省略 HAR 的大小、时间、页面、Cookie、安全性和其他类型的 HAR 信息，这些信息在从 HAR 重放时不使用。默认为 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 Workers。默认为 'allow'。

      • 'allow': Service Workers 可以注册。
      • 'block': Playwright 将阻止所有 Service Workers 的注册。

    • 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>

      了解更多关于 存储状态和身份验证。

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

    • strictSelectors boolean (可选)#

      如果设置为 true，则为此上下文启用严格选择器模式。在严格选择器模式下，当有多个元素匹配选择器时，所有暗示单个目标 DOM 元素的选择器操作都会抛出错误。此选项不影响任何 Locator API（Locators 始终严格）。默认为 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 值会取消默认预设，使视口取决于操作系统定义的主机窗口大小。这会使测试的执行不确定。

返回

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，从而将 baseURL 考虑在内。默认情况下未设置。示例：

      • baseURL: https://:3000，导航到 /bar.html 会得到 https://:3000/bar.html
      • baseURL: https://:3000/foo/，导航到 ./bar.html 会得到 https://:3000/foo/bar.html
      • baseURL: https://:3000/foo (不带尾部斜杠)，导航到 ./bar.html，结果为 https://: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 属性，并与证书有效的请求来源完全匹配。

      仅当至少提供一个客户端证书时，客户端证书认证才有效。如果您想拒绝服务器发送的所有客户端证书，您需要提供一个 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）上发送 http 凭据).

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

        此选项仅适用于从相应的 APIRequestContext 发送的请求，不影响从浏览器发送的请求。 'always' - 每个 API 请求都会发送带有基本身份验证凭据的 Authorization 标头。 'unauthorized - 凭据仅在收到带有 WWW-Authenticate 标头的 401（未授权）响应时发送。默认为 '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 路由所需的信息。这会省略 HAR 的大小、时间、页面、Cookie、安全性和其他类型的 HAR 信息，这些信息在从 HAR 重放时不使用。默认为 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 Workers。默认为 'allow'。

      • 'allow': Service Workers 可以注册。
      • 'block': Playwright 将阻止所有 Service Workers 的注册。

    • 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>

      了解更多关于 存储状态和身份验证。

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

    • strictSelectors boolean (可选)#

      如果设置为 true，则为此上下文启用严格选择器模式。在严格选择器模式下，当有多个元素匹配选择器时，所有暗示单个目标 DOM 元素的选择器操作都会抛出错误。此选项不影响任何 Locator API（Locators 始终严格）。默认为 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 值会取消默认预设，使视口取决于操作系统定义的主机窗口大小。这会使测试的执行不确定。

返回

removeAllListeners​

添加于：v1.47 browser.removeAllListeners

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

用法

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

参数

  • type string (可选)#
  • options Object (可选)

    • 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 Object (可选)

    • categories Array<string> (可选)#

      指定要使用的自定义类别而不是默认类别。

    • path string (可选)#

      写入跟踪文件的路径。

    • screenshots boolean (可选)#

      在跟踪中捕获屏幕截图。

返回

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 => {});

事件数据