Settings

external interface Settings(source)

Properties

abstract external var args: ReadonlyArray<String>?

The command-line arguments to pass to the executable. Defaults to an empty array. Take care to wrap paths in quotes.

abstract external var enabled: Boolean?

true will change the startup approved registry key and enable / disable the App in Task Manager and Windows Settings. Defaults to true.

name

abstract external var name: String?

value name to write into registry. Defaults to the app's AppUserModelId().

openAsHidden

abstract external var openAsHidden: Boolean?

true to open the app as hidden. Defaults to false. The user can edit this setting from the System Preferences so app.getLoginItemSettings().wasOpenedAsHidden should be checked when the app is opened to know the current value. This setting is not available on MAS builds or on macOS 13 and up.

openAtLogin

abstract external var openAtLogin: Boolean?

true to open the app at login, false to remove the app as a login item. Defaults to false.

path

abstract external var path: String?

The executable to launch at login. Defaults to process.execPath.

serviceName

abstract external var serviceName: String?

The name of the service. Required if type is non-default. Only available on macOS 13 and up.

type

abstract external var type: SettingsType?

The type of service to add as a login item. Defaults to mainAppService. Only available on macOS 13 and up.