浏览器

浏览器是通过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​

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

用法

browser.browserType();

返回

• BrowserType#

关闭​

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

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

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

用法

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

参数

• options Object (optional)

  • reason string (可选) 添加于: v1.40#

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

返回

• Promise<void>#

上下文​

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

用法

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​

表示浏览器已连接。

用法

browser.isConnected();

返回

• boolean#

newBrowserCDPSession​

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

用法

await browser.newBrowserCDPSession();

返回

• Promise<CDPSession>#

newContext​

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

用法

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

  • acceptDownloads boolean (可选)#

    是否自动下载所有附件。默认为true，表示接受所有下载。

  • baseURL string (可选)#

    在使用page.goto()、page.route()、page.waitForURL()、page.waitForRequest()或page.waitForResponse()时，会通过URL()构造函数考虑基础URL来构建相应的URL。默认情况下未设置。示例：

    • baseURL: http://localhost:3000 and navigating to /bar.html results in http://localhost:3000/bar.html
    • baseURL: http://localhost:3000/foo/ and navigating to ./bar.html results in http://localhost:3000/foo/bar.html
    • baseURL: http://localhost:3000/foo (without trailing slash) and navigating to ./bar.html results in http://localhost:3000/bar.html

  • bypassCSP boolean (可选)#

    切换绕过页面的内容安全策略。默认为 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属性应提供与证书适用的请求来源完全匹配的值。

    note

    在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。了解更多关于mobile emulation的信息。

  • 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中不受支持。了解更多关于mobile emulation的信息。

  • 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路由所必需的信息。这会省略大小、时间、页面、cookies、安全和其他类型的HAR信息，这些信息在从HAR回放时不会被使用。默认为full。

    • urlFilter string | RegExp (可选)

      用于过滤存储在HAR中的请求的全局模式或正则表达式模式。当通过上下文选项提供了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 数组<Object>

      • name string

      • value string

      • domain string

        域名和路径是必需的。要使cookie适用于所有子域名，请在域名前加上点号，例如：".example.com"

      • path string

        域名和路径是必需的

      • expires number

        Unix时间，单位为秒。

      • httpOnly boolean

      • secure boolean

      • sameSite "Strict" | "Lax" | "None"

        sameSite标志

      Cookies to set for context
    • origins 数组<Object>

      • origin string

      • localStorage Array<Object>

        • name string

        • value string

        为上下文设置的localStorage

    了解更多关于storage state and auth的信息。

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

  • strictSelectors boolean (可选)#

    如果设置为true，将为此上下文启用严格选择器模式。在严格选择器模式下，所有针对选择器的操作如果匹配到多个DOM元素时都会抛出异常。此选项不会影响任何Locator API（Locator始终是严格的）。默认为false。有关严格模式的更多信息，请参阅Locator。

  • timezoneId string (可选)#

    更改上下文的时区。支持的时区ID列表请参见ICU's metaZones.txt。默认为系统时区。

  • userAgent string (可选)#

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

  • videoSize Object (可选)#

    Deprecated

    请改用recordVideo。

    • width number

      视频帧宽度。

    • height number

      视频帧高度。

  • videosPath string (可选)#

    已弃用

    请改用 recordVideo。

  • viewport null | Object (可选)#

    • width number

      页面宽度，单位为像素。

    • height number

      页面高度，单位为像素。

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

    note

    null值表示不使用默认预设，使视口大小取决于操作系统定义的主机窗口尺寸。这会导致测试执行变得非确定性。

返回

• Promise<BrowserContext>#

newPage​

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

这是一个便捷API，仅适用于单页场景和简短代码片段。生产代码和测试框架应显式创建browser.newContext()，然后使用browserContext.newPage()来控制其确切生命周期。

用法

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

参数

• options Object (optional)

  • acceptDownloads boolean (可选)#

    是否自动下载所有附件。默认为true，表示接受所有下载。

  • baseURL string (可选)#

    在使用page.goto()、page.route()、page.waitForURL()、page.waitForRequest()或page.waitForResponse()时，会通过URL()构造函数考虑基础URL来构建相应的URL。默认情况下未设置。示例：

    • baseURL: http://localhost:3000 and navigating to /bar.html results in http://localhost:3000/bar.html
    • baseURL: http://localhost:3000/foo/ and navigating to ./bar.html results in http://localhost:3000/foo/bar.html
    • baseURL: http://localhost:3000/foo (without trailing slash) and navigating to ./bar.html results in http://localhost:3000/bar.html

  • bypassCSP boolean (可选)#

    切换绕过页面的内容安全策略。默认为 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属性应提供与证书适用的请求来源完全匹配的值。

    note

    在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。了解更多关于mobile emulation的信息。

  • 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中不受支持。了解更多关于mobile emulation的信息。

  • 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路由所必需的信息。这会省略大小、时间、页面、cookies、安全和其他类型的HAR信息，这些信息在从HAR回放时不会被使用。默认为full。

    • urlFilter string | RegExp (可选)

      用于过滤存储在HAR中的请求的全局模式或正则表达式模式。当通过上下文选项提供了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 数组<Object>

      • name string

      • value string

      • domain string

        域名和路径是必需的。要使cookie适用于所有子域名，请在域名前加上点号，例如：".example.com"

      • path string

        域名和路径是必需的

      • expires number

        Unix时间，单位为秒。

      • httpOnly boolean

      • secure boolean

      • sameSite "Strict" | "Lax" | "None"

        sameSite标志

      Cookies to set for context
    • origins 数组<Object>

      • origin string

      • localStorage Array<Object>

        • name string

        • value string

        为上下文设置的localStorage

    了解更多关于storage state and auth的信息。

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

  • strictSelectors boolean (可选)#

    如果设置为true，将为此上下文启用严格选择器模式。在严格选择器模式下，所有针对选择器的操作如果匹配到多个DOM元素时都会抛出异常。此选项不会影响任何Locator API（Locator始终是严格的）。默认为false。有关严格模式的更多信息，请参阅Locator。

  • timezoneId string (可选)#

    更改上下文的时区。支持的时区ID列表请参见ICU's metaZones.txt。默认为系统时区。

  • userAgent string (可选)#

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

  • videoSize Object (可选)#

    Deprecated

    请改用recordVideo。

    • width number

      视频帧宽度。

    • height number

      视频帧高度。

  • videosPath string (可选)#

    已弃用

    请改用 recordVideo。

  • viewport null | Object (可选)#

    • width number

      页面宽度，单位为像素。

    • height number

      页面高度，单位为像素。

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

    note

    null值表示不使用默认预设，使视口大小取决于操作系统定义的主机窗口尺寸。这会导致测试执行变得非确定性。

返回

• Promise<Page>#

removeAllListeners​

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

用法

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

参数

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

  • behavior "wait" | "ignoreErrors" | "default" (可选)#

    指定是否等待已运行的监听器以及当它们抛出错误时的处理方式：

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

返回

• Promise<void>#

开始追踪​

你可以使用browser.startTracing()和browser.stopTracing()来创建一个跟踪文件，该文件可以在Chrome开发者工具的性能面板中打开。

用法

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​

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

用法

await browser.stopTracing();

返回

• Promise<Buffer>#

版本​

返回浏览器版本。

用法

browser.version();

返回

• string#

事件​

on('disconnected')​

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

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

用法

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

事件数据

• Browser