Skip to main content

class: Electron

Added in: v1.9

Languages: JavaScript

copilotbrowser has experimental support for Electron automation. You can access electron namespace via:

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

An example of the Electron automation script would be:

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

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

Supported Electron versions are:

  • v12.2.0+
  • v13.4.0+
  • v14+

Known issues:

If you are not able to launch Electron and it will end up in timeouts during launch, try the following:

async method: Electron.launch​

Added in: v1.9 Returns: ElectronApplication

Launches electron application specified with the executablePath.

option: Electron.launch.executablePath​

Added in: v1.9

  • executablePath <string>

Launches given Electron application. If not specified, launches the default Electron executable installed in this package, located at node_modules/.bin/electron.

option: Electron.launch.args​

Added in: v1.9

  • args <Array<string>>

Additional arguments to pass to the application when launching. You typically pass the main script name here.

option: Electron.launch.cwd​

Added in: v1.9

  • cwd <string>

Current working directory to launch application from.

option: Electron.launch.env​

Added in: v1.9

  • env <Object<string, string>>

Specifies environment variables that will be visible to Electron. Defaults to process.env.

option: Electron.launch.timeout​

Added in: v1.15

  • timeout <float>

Maximum time in milliseconds to wait for the application to start. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.

option: Electron.launch.acceptdownloads = %%-context-option-acceptdownloads-%%​

Added in: v1.12

option: Electron.launch.bypassCSP = %%-context-option-bypasscsp-%%​

Added in: v1.12

option: Electron.launch.colorScheme = %%-context-option-colorscheme-%%​

Added in: v1.12

option: Electron.launch.extraHTTPHeaders = %%-context-option-extrahttpheaders-%%​

Added in: v1.12

option: Electron.launch.geolocation = %%-context-option-geolocation-%%​

Added in: v1.12

option: Electron.launch.httpcredentials = %%-context-option-httpcredentials-%%​

Added in: v1.12

option: Electron.launch.ignoreHTTPSErrors = %%-context-option-ignorehttpserrors-%%​

Added in: v1.12

option: Electron.launch.locale = %%-context-option-locale-%%​

Added in: v1.12

option: Electron.launch.offline = %%-context-option-offline-%%​

Added in: v1.12

option: Electron.launch.recordhar = %%-context-option-recordhar-%%​

Added in: v1.12

option: Electron.launch.recordharpath = %%-context-option-recordhar-path-%%​

Added in: v1.12

option: Electron.launch.recordHarOmitContent = %%-context-option-recordhar-omit-content-%%​

Added in: v1.12

option: Electron.launch.recordvideo = %%-context-option-recordvideo-%%​

Added in: v1.12

option: Electron.launch.recordvideodir = %%-context-option-recordvideo-dir-%%​

Added in: v1.12

option: Electron.launch.recordvideosize = %%-context-option-recordvideo-size-%%​

Added in: v1.12

option: Electron.launch.timezoneId = %%-context-option-timezoneid-%%​

Added in: v1.12

option: Electron.launch.tracesDir = %%-browser-option-tracesdir-%%​

Added in: v1.36

option: Electron.launch.chromiumSandbox = %%-browser-option-chromiumsandbox-%%​

Added in: v1.59