メインコンテンツへスキップ

ElectronApplication

Electronアプリケーションの表現。 electron.launch() を使用してアプリケーションインスタンスを取得できます。このインスタンスを使用して、Electronのメインプロセスを制御したり、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();
})();

メソッド​

browserWindow​

バージョン v1.11で追加 electronApplication.browserWindow

指定されたPlaywrightページに対応するBrowserWindowオブジェクトを返します。

使用法

await electronApplication.browserWindow(page);

引数

  • page Page#

    ウィンドウを取得するページです。

戻り値

close​

バージョン v1.9で追加 electronApplication.close

Electronアプリケーションを閉じます。

使用法

await electronApplication.close();

戻り値

context​

バージョン v1.9で追加 electronApplication.context

このメソッドは、コンテキスト全体のルーティングなどを設定するために使用できるブラウザコンテキストを返します。

使用法

electronApplication.context();

戻り値

evaluate​

バージョン v1.9で追加 electronApplication.evaluate

pageFunction の戻り値を返します。

electronApplication.evaluate() に渡された関数が Promise を返す場合、electronApplication.evaluate() はそのPromiseが解決されるのを待ち、その値を返します。

electronApplication.evaluate() に渡された関数が Serializable でない値を返す場合、electronApplication.evaluate() は undefined を返します。Playwrightはまた、JSONによってシリアライズできない追加の値 (-0, NaN, Infinity, -Infinity) の転送もサポートしています。

使用法

await electronApplication.evaluate(pageFunction);
await electronApplication.evaluate(pageFunction, arg);

引数

戻り値

evaluateHandle​

バージョン v1.9で追加 electronApplication.evaluateHandle

pageFunction の戻り値を JSHandle として返します。

electronApplication.evaluate() と electronApplication.evaluateHandle() の唯一の違いは、electronApplication.evaluateHandle() が JSHandle を返すことです。

electronApplication.evaluateHandle() に渡された関数が Promise を返す場合、electronApplication.evaluateHandle() はそのPromiseが解決されるのを待ち、その値を返します。

使用法

await electronApplication.evaluateHandle(pageFunction);
await electronApplication.evaluateHandle(pageFunction, arg);

引数

戻り値

firstWindow​

バージョン v1.9で追加 electronApplication.firstWindow

最初のアプリケーションウィンドウが開かれるのを待つ便利なメソッドです。

使用法

const electronApp = await electron.launch({
  args: ['main.js']
});
const window = await electronApp.firstWindow();
// ...

引数

  • options Object (オプション)

    • timeout number (オプション)バージョン v1.33で追加#

      待機する最大時間（ミリ秒単位）。デフォルトは 30000 (30秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browserContext.setDefaultTimeout() を使用して変更できます。

戻り値

process​

バージョン v1.21で追加 electronApplication.process

このElectronアプリケーションのメインプロセスを返します。

使用法

electronApplication.process();

戻り値

waitForEvent​

バージョン v1.9で追加 electronApplication.waitForEvent

イベントが発生するのを待ち、その値を述語関数に渡します。述語が真の値を返したときに、戻ります。イベントが発生する前にアプリケーションが閉じられた場合、エラーをスローします。イベントデータ値を返します。

使用法

const windowPromise = electronApp.waitForEvent('window');
await mainWindow.click('button');
const window = await windowPromise;

引数

  • event string#

    イベント名。通常、*.on(event) に渡されるものと同じです。

  • optionsOrPredicate function | Object (オプション)#

    • predicate function

      イベントデータを受け取り、待機が解決されるべきときに真の値を返します。

    • timeout number (オプション)

      待機する最大時間（ミリ秒単位）。デフォルトは 30000 (30秒) です。タイムアウトを無効にするには 0 を渡します。デフォルト値は browserContext.setDefaultTimeout() を使用して変更できます。

    イベントを受け取る述語、またはオプションオブジェクトのいずれか。オプション。

戻り値

windows​

バージョン v1.9で追加 electronApplication.windows

開いているすべてのウィンドウを返す便利なメソッドです。

使用法

electronApplication.windows();

戻り値

イベント​

on('close')​

バージョン v1.9で追加 electronApplication.on('close')

このイベントは、アプリケーションプロセスが終了したときに発生します。

使用法

electronApplication.on('close', data => {});

on('console')​

バージョン v1.42で追加 electronApplication.on('console')

Electronメインプロセス内のJavaScriptが console.log や console.dir などのコンソールAPIメソッドを呼び出したときに発生します。

console.log に渡された引数は、ConsoleMessage イベントハンドラの引数として利用可能です。

使用法

electronApp.on('console', async msg => {
  const values = [];
  for (const arg of msg.args())
    values.push(await arg.jsonValue());
  console.log(...values);
});
await electronApp.evaluate(() => console.log('hello', 5, { foo: 'bar' }));

イベントデータ

on('window')​

バージョン v1.9で追加 electronApplication.on('window')

このイベントは、Electronで作成され、ロードされたすべてのウィンドウに対して発生します。Playwrightの自動化に使用できる Page を含みます。

使用法

electronApplication.on('window', data => {});

イベントデータ