Interface ElectronApplication

Electron application representation. You can use electron.launch([options]) to obtain the application instance. This instance you can control main electron process as well as work with Electron windows:

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

Hierarchy

ElectronApplication

Index

Methods

addListener browserWindow close context evaluate evaluateHandle firstWindow off on once prependListener process removeListener waitForEvent windows

Methods

addListener

addListener(event: "close", listener: (() => void)): ElectronApplication
This event is issued when the application closes.
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns ElectronApplication
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:12503
addListener(event: "window", listener: ((page: Page) => void)): ElectronApplication
This event is issued for every window that is created and loaded in Electron. It contains a [Page] that can be used for Playwright automation.
Parameters
- event: "window"
- listener: ((page: Page) => void)
  - - (page: Page): void
    - Parameters
      
      page: Page
      
      Returns void
Returns ElectronApplication
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:12509

browserWindow

browserWindow(page: Page): Promise<JSHandle<any>>
Returns the BrowserWindow object that corresponds to the given Playwright page.
Parameters
- page: Page
  
  Page to retrieve the window for.
Returns Promise<JSHandle<any>>
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:12546

close

close(): Promise<void>
Closes Electron application.

Returns Promise<void>
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:12551

context

context(): BrowserContext
This method returns browser context that can be used for setting up context-wide routing, etc.

Returns BrowserContext
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:12556

evaluate

evaluate<R, Arg>(pageFunction: PageFunctionOn<any, Arg, R>, arg: Arg): Promise<R>
Returns the return value of pageFunction.

If the function passed to the electronApplication.evaluate(pageFunction[, arg]) returns a [Promise], then electronApplication.evaluate(pageFunction[, arg]) would wait for the promise to resolve and return its value.

If the function passed to the electronApplication.evaluate(pageFunction[, arg]) returns a non-[Serializable] value, then electronApplication.evaluate(pageFunction[, arg]) returns undefined. Playwright also supports transferring some additional values that are not serializable by JSON: -0, NaN, Infinity, -Infinity.
Type Parameters
- R
- Arg
Parameters
- pageFunction: PageFunctionOn<any, Arg, R>
  
  Function to be evaluated in the worker context.
- arg: Arg
  
  Optional argument to pass to pageFunction.
Returns Promise<R>
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:12418
evaluate<R>(pageFunction: PageFunctionOn<any, void, R>, arg?: any): Promise<R>
Returns the return value of pageFunction.

If the function passed to the electronApplication.evaluate(pageFunction[, arg]) returns a [Promise], then electronApplication.evaluate(pageFunction[, arg]) would wait for the promise to resolve and return its value.

If the function passed to the electronApplication.evaluate(pageFunction[, arg]) returns a non-[Serializable] value, then electronApplication.evaluate(pageFunction[, arg]) returns undefined. Playwright also supports transferring some additional values that are not serializable by JSON: -0, NaN, Infinity, -Infinity.
Type Parameters
- R
Parameters
- pageFunction: PageFunctionOn<any, void, R>
  
  Function to be evaluated in the worker context.
- Optional arg: any
  
  Optional argument to pass to pageFunction.
Returns Promise<R>
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:12437

evaluateHandle

evaluateHandle<R, Arg>(pageFunction: PageFunctionOn<any, Arg, R>, arg: Arg): Promise<SmartHandle<R>>
Returns the return value of pageFunction as a [JSHandle].

The only difference between electronApplication.evaluate(pageFunction[, arg]) and electronApplication.evaluateHandle(pageFunction[, arg]) is that electronApplication.evaluateHandle(pageFunction[, arg]) returns [JSHandle].

If the function passed to the electronApplication.evaluateHandle(pageFunction[, arg]) returns a [Promise], then electronApplication.evaluateHandle(pageFunction[, arg]) would wait for the promise to resolve and return its value.
Type Parameters
- R
- Arg
Parameters
- pageFunction: PageFunctionOn<any, Arg, R>
  
  Function to be evaluated in the worker context.
- arg: Arg
  
  Optional argument to pass to pageFunction.
Returns Promise<SmartHandle<R>>
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:12458
evaluateHandle<R>(pageFunction: PageFunctionOn<any, void, R>, arg?: any): Promise<SmartHandle<R>>
Returns the return value of pageFunction as a [JSHandle].

The only difference between electronApplication.evaluate(pageFunction[, arg]) and electronApplication.evaluateHandle(pageFunction[, arg]) is that electronApplication.evaluateHandle(pageFunction[, arg]) returns [JSHandle].

If the function passed to the electronApplication.evaluateHandle(pageFunction[, arg]) returns a [Promise], then electronApplication.evaluateHandle(pageFunction[, arg]) would wait for the promise to resolve and return its value.
Type Parameters
- R
Parameters
- pageFunction: PageFunctionOn<any, void, R>
  
  Function to be evaluated in the worker context.
- Optional arg: any
  
  Optional argument to pass to pageFunction.
Returns Promise<SmartHandle<R>>
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:12478

firstWindow

firstWindow(): Promise<Page>
Convenience method that waits for the first application window to be opened.

Usage
```
  const electronApp = await electron.launch({
    args: ['main.js']
  });
  const window = await electronApp.firstWindow();
  // ...
```
Returns Promise<Page>
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:12572

off

off(event: "close", listener: (() => void)): ElectronApplication
Removes an event listener added by on or addListener.
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns ElectronApplication
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:12524
off(event: "window", listener: ((page: Page) => void)): ElectronApplication
Removes an event listener added by on or addListener.
Parameters
- event: "window"
- listener: ((page: Page) => void)
  - - (page: Page): void
    - Parameters
      
      page: Page
      
      Returns void
Returns ElectronApplication
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:12529

on

on(event: "close", listener: (() => void)): ElectronApplication
This event is issued when the application closes.
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns ElectronApplication
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:12482
on(event: "window", listener: ((page: Page) => void)): ElectronApplication
This event is issued for every window that is created and loaded in Electron. It contains a [Page] that can be used for Playwright automation.
Parameters
- event: "window"
- listener: ((page: Page) => void)
  - - (page: Page): void
    - Parameters
      
      page: Page
      
      Returns void
Returns ElectronApplication
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:12488

once

once(event: "close", listener: (() => void)): ElectronApplication
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns ElectronApplication
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:12493
once(event: "window", listener: ((page: Page) => void)): ElectronApplication
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Parameters
- event: "window"
- listener: ((page: Page) => void)
  - - (page: Page): void
    - Parameters
      
      page: Page
      
      Returns void
Returns ElectronApplication
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:12498

prependListener

prependListener(event: "close", listener: (() => void)): ElectronApplication
This event is issued when the application closes.
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns ElectronApplication
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:12534
prependListener(event: "window", listener: ((page: Page) => void)): ElectronApplication
This event is issued for every window that is created and loaded in Electron. It contains a [Page] that can be used for Playwright automation.
Parameters
- event: "window"
- listener: ((page: Page) => void)
  - - (page: Page): void
    - Parameters
      
      page: Page
      
      Returns void
Returns ElectronApplication
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:12540

process

process(): ChildProcess
Returns the main process for this Electron Application.

Returns ChildProcess
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:12577

removeListener

removeListener(event: "close", listener: (() => void)): ElectronApplication
Removes an event listener added by on or addListener.
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns ElectronApplication
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:12514
removeListener(event: "window", listener: ((page: Page) => void)): ElectronApplication
Removes an event listener added by on or addListener.
Parameters
- event: "window"
- listener: ((page: Page) => void)
  - - (page: Page): void
    - Parameters
      
      page: Page
      
      Returns void
Returns ElectronApplication
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:12519

waitForEvent

waitForEvent(event: "close", optionsOrPredicate?: {
predicate?: (() => boolean | Promise<boolean>);
timeout?: number;
} | (() => boolean | Promise<boolean>)): Promise<void>
This event is issued when the application closes.
Parameters
- event: "close"
- Optional optionsOrPredicate: {
  predicate?: (() => boolean | Promise<boolean>);
  timeout?: number;
  } | (() => boolean | Promise<boolean>)
Returns Promise<void>
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:12582
waitForEvent(event: "window", optionsOrPredicate?: {
predicate?: ((page: Page) => boolean | Promise<boolean>);
timeout?: number;
} | ((page: Page) => boolean | Promise<boolean>)): Promise<Page>
This event is issued for every window that is created and loaded in Electron. It contains a [Page] that can be used for Playwright automation.
Parameters
- event: "window"
- Optional optionsOrPredicate: {
  predicate?: ((page: Page) => boolean | Promise<boolean>);
  timeout?: number;
  } | ((page: Page) => boolean | Promise<boolean>)
Returns Promise<Page>
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:12588

windows

windows(): Page[]
Convenience method that returns all the opened windows.

Returns Page[]
- Defined in node_modules/.pnpm/playwright-core@1.29.2/node_modules/playwright-core/types/types.d.ts:12594

Interface ElectronApplication

Hierarchy

Index

Methods

Methods

addListener

Parameters

event: "close"

listener: (() => void)

Returns void

Returns ElectronApplication

Parameters

event: "window"

listener: ((page: Page) => void)

Parameters

page: Page

Returns void

Returns ElectronApplication

browserWindow

Parameters

page: Page

Returns Promise<JSHandle<any>>

close

Returns Promise<void>

context

Returns BrowserContext

evaluate

Type Parameters

R

Arg

Parameters

pageFunction: PageFunctionOn<any, Arg, R>

arg: Arg

Returns Promise<R>

Type Parameters

R

Parameters

pageFunction: PageFunctionOn<any, void, R>

Optional arg: any

Returns Promise<R>

evaluateHandle

Type Parameters

R

Arg

Parameters

pageFunction: PageFunctionOn<any, Arg, R>

arg: Arg

Returns Promise<SmartHandle<R>>

Type Parameters

R

Parameters

pageFunction: PageFunctionOn<any, void, R>

Optional arg: any

Returns Promise<SmartHandle<R>>

firstWindow

Returns Promise<Page>

off

Parameters

event: "close"

listener: (() => void)

Returns void

Returns ElectronApplication

Parameters

event: "window"

listener: ((page: Page) => void)

Parameters

page: Page

Returns void

Returns ElectronApplication

on

Parameters

event: "close"

listener: (() => void)

Returns void

Returns ElectronApplication

Parameters

event: "window"

listener: ((page: Page) => void)

Parameters

page: Page

`Optional` arg: any

`Optional` arg: any

`Optional` optionsOrPredicate: {
predicate?: (() => boolean | Promise<boolean>);
timeout?: number;
} | (() => boolean | Promise<boolean>)

`Optional` optionsOrPredicate: {
predicate?: ((page: Page) => boolean | Promise<boolean>);
timeout?: number;
} | ((page: Page) => boolean | Promise<boolean>)