Electron

Playwright 对 Electron 自动化提供实验性支持。您可以通过以下方式访问 electron 命名空间

const { _electron } = require('playwright');

Electron 自动化脚本示例如下：

const { _electron: electron } = require('playwright');

(async () => {
  // Launch Electron app.
  const electronApp = await electron.launch({ args: ['main.js'] });

  // Evaluation expression in the Electron context.
  const appPath = await electronApp.evaluate(async ({ app }) => {
    // This runs in the main Electron process, parameter here is always
    // the result of the require('electron') in the main app script.
    return app.getAppPath();
  });
  console.log(appPath);

  // Get the first window that the app opens, wait if necessary.
  const window = await electronApp.firstWindow();
  // Print the title.
  console.log(await window.title());
  // Capture a screenshot.
  await window.screenshot({ path: 'intro.png' });
  // Direct Electron console to Node terminal.
  window.on('console', console.log);
  // Click button.
  await window.click('text=Click me');
  // Exit app.
  await electronApp.close();
})();

支持的 Electron 版本为

v12.2.0+
v13.4.0+
v14+

已知问题

如果您无法启动 Electron 并且在启动期间最终超时，请尝试以下操作

确保 nodeCliInspect (FuseV1Options.EnableNodeCliInspectArguments) fuse 未设置为 false。

方法

launch

添加于版本: v1.9

electron.launch

启动使用 executablePath 指定的 electron 应用程序。

用法

await electron.launch();
await electron.launch(options);

参数

options Object (可选)
- acceptDownloads boolean (可选)添加于版本: v1.12#
  
  是否自动下载所有附件。默认为 true，即接受所有下载。
- args Array<string> (可选)#
  
  启动时传递给应用程序的其他参数。您通常在此处传递主脚本名称。
- bypassCSP boolean (可选)添加于版本: v1.12#
  
  切换绕过页面的内容安全策略 (Content-Security-Policy)。默认为 false。
- colorScheme null | "light" | "dark" | "no-preference" (可选)添加于版本: v1.12#
  
  模拟 prefers-colors-scheme 媒体功能，支持的值为 'light' 和 'dark'。有关更多详细信息，请参阅 page.emulateMedia()。传递 null 会将模拟重置为系统默认值。默认为 'light'。
- cwd string (可选)#
  
  从中启动应用程序的当前工作目录。
- env Object<string, string> (可选)#
  
  指定 Electron 可见的环境变量。默认为 process.env。
- executablePath string (可选)#
  
  启动给定的 Electron 应用程序。如果未指定，则启动此软件包中安装的默认 Electron 可执行文件，位于 node_modules/.bin/electron。
- extraHTTPHeaders Object<string, string> (可选)添加于版本: v1.12#
  
  一个对象，其中包含要随每个请求发送的其他 HTTP 标头。默认为无。
- geolocation Object (可选)添加于版本: v1.12#
  - latitude number
    
    纬度，介于 -90 和 90 之间。
  - longitude number
    
    经度，介于 -180 和 180 之间。
  - accuracy number (可选)
    
    非负精度值。默认为 0。
- httpCredentials Object (可选)添加于版本: v1.12#
  - username string
  - password string
  - origin string (可选)
    
    限制在特定来源（scheme://host:port).
  - send "unauthorized" | "always" (可选)
    
    此选项仅适用于从相应的 APIRequestContext 发送的请求，并且不影响从浏览器发送的请求。'always' - 带有基本身份验证凭据的 Authorization 标头将随每个 API 请求一起发送。'unauthorized - 仅当收到带有 WWW-Authenticate 标头的 401（未授权）响应时才发送凭据。默认为 'unauthorized'。
  HTTP 身份验证的凭据。如果未指定来源，则用户名和密码将在收到未授权响应后发送到任何服务器。
- ignoreHTTPSErrors boolean (可选)添加于版本: v1.12#
  
  是否在发送网络请求时忽略 HTTPS 错误。默认为 false。
- locale string (可选)添加于版本: v1.12#
  
  指定用户区域设置，例如 en-GB、de-DE 等。区域设置将影响 navigator.language 值、Accept-Language 请求标头值以及数字和日期格式规则。默认为系统默认区域设置。请参阅我们的模拟指南，了解有关模拟的更多信息。
- offline boolean (可选)添加于版本: v1.12#
  
  是否模拟网络离线。默认为 false。请参阅网络模拟，了解更多信息。
- recordHar Object (可选)添加于版本: v1.12#
  - 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 信息。默认为 full。
  - urlFilter string | RegExp (可选)
    
    用于过滤存储在 HAR 中的请求的 glob 或正则表达式模式。当通过上下文选项提供了 baseURL 并且传递的 URL 是路径时，它将通过 new URL() 构造函数合并。默认为无。
  启用将所有页面的 HAR 记录到 recordHar.path 文件中。如果未指定，则不记录 HAR。请确保等待 browserContext.close() 以保存 HAR。
- recordVideo Object (可选)添加于版本: v1.12#
  - dir string
    
    用于存放视频的目录路径。
  - size Object (可选)
    - width number
      
      视频帧宽度。
    - height number
      
      视频帧高度。
    录制视频的可选尺寸。如果未指定，则尺寸将等于缩小以适应 800x800 的 viewport。如果未显式配置 viewport，则视频尺寸默认为 800x450。如有必要，将缩小每个页面的实际图片以适应指定的尺寸。
  启用将所有页面的视频录制到 recordVideo.dir 目录中。如果未指定，则不录制视频。请确保等待 browserContext.close() 以保存视频。
- timeout number (可选)添加于版本: v1.15#
  
  等待应用程序启动的最长时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 以禁用超时。
- timezoneId string (可选)添加于版本: v1.12#
  
  更改上下文的时区。请参阅 ICU 的 metaZones.txt，获取支持的时区 ID 列表。默认为系统时区。
- tracesDir string (可选)添加于版本: v1.36#
  
  如果指定，跟踪将保存到此目录中。

返回值

Promise<ElectronApplication>#

方法​

launch​

方法

launch