@lynx-js/lynxtron / Settings

#Settings

#Properties

#args?

Windows

optional args: string[];

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

Defined in

apis/api/app.d.ts:273

#enabled?

Windows

optional enabled: boolean;

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

Defined in

apis/api/app.d.ts:280

#name?

Windows

optional name: string;

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

Defined in

apis/api/app.d.ts:286

#openAsHidden?

macOS

optional 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.

#Deprecated

Defined in

apis/api/app.d.ts:242

#openAtLogin?

optional openAtLogin: boolean;

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

Defined in

apis/api/app.d.ts:231

#path?

Windows

optional path: string;

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

Defined in

apis/api/app.d.ts:266

#serviceName?

macOS

optional serviceName: string;

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

Defined in

apis/api/app.d.ts:260

#type?

macOS

optional type: "mainAppService" | "agentService" | "daemonService" | "loginItemService";

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

Defined in

apis/api/app.d.ts:249