Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

allowNonzeroExitCode?: boolean

Allow the opened app to exit with nonzero exit code when the wait option is true.

We do not recommend setting this option. The convention for success is exit code zero.

default

false

arguments?: readonly string[]

Arguments passed to the app.

These arguments are app dependent. Check the app's documentation for what arguments it accepts.

background?: boolean

macOS only

Do not bring the app to the foreground.

default

false

newInstance?: boolean

macOS only

Open a new instance of the app even it's already running.

A new instance is always opened on other platforms.

default

false

wait?: boolean

Wait for the opened app to exit before fulfilling the promise. If false it's fulfilled immediately when opening the app.

Note that it waits for the app to exit, not just for the window to close.

On Windows, you have to explicitly specify an app for it to be able to wait.

default

false