UNPKG

1.7 kBTypeScriptView Raw
1import { WinPackager } from "../winPackager";
2export interface CommonWindowsInstallerConfiguration {
3 readonly oneClick?: boolean;
4 /**
5 * Whether to install per all users (per-machine).
6 * @default false
7 */
8 readonly perMachine?: boolean;
9 /**
10 * Whether to run the installed application after finish. For assisted installer corresponding checkbox will be removed.
11 * @default true
12 */
13 readonly runAfterFinish?: boolean;
14 /**
15 * Whether to create desktop shortcut. Set to `always` if to recreate also on reinstall (even if removed by user).
16 * @default true
17 */
18 readonly createDesktopShortcut?: boolean | "always";
19 /**
20 * Whether to create start menu shortcut.
21 * @default true
22 */
23 readonly createStartMenuShortcut?: boolean;
24 /**
25 * Whether to create submenu for start menu shortcut and program files directory. If `true`, company name will be used. Or string value.
26 * @default false
27 */
28 readonly menuCategory?: boolean | string;
29 /**
30 * The name that will be used for all shortcuts. Defaults to the application name.
31 */
32 readonly shortcutName?: string | null;
33}
34export interface FinalCommonWindowsInstallerOptions {
35 isAssisted: boolean;
36 isPerMachine: boolean;
37 shortcutName: string;
38 menuCategory: string | null;
39 isCreateDesktopShortcut: DesktopShortcutCreationPolicy;
40 isCreateStartMenuShortcut: boolean;
41}
42export declare function getEffectiveOptions(options: CommonWindowsInstallerConfiguration, packager: WinPackager): FinalCommonWindowsInstallerOptions;
43export declare enum DesktopShortcutCreationPolicy {
44 FRESH_INSTALL = 0,
45 ALWAYS = 1,
46 NEVER = 2
47}