Skip to content

Monitor Config ​

Configuration for managing process monitoring, window management, and logging settings.

Options ​

apps ​

  • Type: Array<AppConfig>
  • Default: []

A list of apps to launch and monitor. Each app can be configured with PM2 settings, window management options, and logging preferences.

For detailed app configuration options, see App Config.

deleteExistingBeforeConnect ​

  • Type: boolean
  • Default: false

When enabled, deletes existing PM2 processes before connecting. Useful for volatile apps or when node processes might quit unexpectedly, ensuring a clean slate on startup.

windowsApi ​

  • Type: WindowsApiConfig
  • Default: {}

Advanced configuration for the Windows API, used for managing foreground/minimized/hidden windows.

plugins ​

  • Type: Array<MonitorPlugin>
  • Default: []

A list of monitor plugins for extending functionality.

shutdownOnExit ​

  • Type: boolean
  • Default: true

When enabled, listens for exit events to handle graceful shutdown.

App Config ​

Each app in the apps array can have the following configuration:

pm2 ​

  • Type: pm2.StartOptions

PM2 configuration for the app. See PM2 documentation for available options.

windows ​

  • Type: WindowConfig
  • Default: {}

Settings for window management:

  • foreground: Move to foreground after launch
  • minimize: Minimize windows after launch
  • hide: Hide windows after launch

logging ​

  • Type: AppLogConfig
  • Default: {}

Settings for log management:

  • logToLaunchpadDir: Route logs to launchpad's directory
  • mode: Log capture method ('bus' or 'file')
  • showStdout: Include stdout output
  • showStderr: Include stderr output

Released under the MIT License.