UNPKG

4.02 kBTypeScriptView Raw
1export interface Options {
2 /**
3 * The folder path of your Electron app
4 */
5 appDirectory: string;
6 /**
7 * The folder path to create the .exe installer in.
8 *
9 * Defaults to the installer folder at the project root.
10 */
11 outputDirectory?: string;
12 /**
13 * The local path to a `.gif` file to display during install.
14 */
15 loadingGif?: string;
16 /**
17 * The authors value for the nuget package metadata.
18 *
19 * Defaults to the `author` field from your app's package.json file when unspecified.
20 */
21 authors?: string;
22 /**
23 * The owners value for the nuget package metadata.
24 *
25 * Defaults to the `authors` field when unspecified.
26 */
27 owners?: string;
28 /**
29 * The copyright value for the nuget package metadata.
30 *
31 * Defaults to a generated copyright with `authors` or `owners`.
32 */
33 copyright?: string;
34 /**
35 * The name of your app's main `.exe` file.
36 *
37 * This uses the `name` field in your app's package.json file with an added `.exe` extension when unspecified.
38 */
39 exe?: string;
40 /**
41 * The description value for the nuget package metadata.
42 *
43 * Defaults to the `description` field from your app's package.json file when unspecified.
44 */
45 description?: string;
46 /**
47 * The version value for the nuget package metadata.
48 *
49 * Defaults to the `version` field from your app's package.json file when unspecified.
50 */
51 version?: string;
52 /**
53 * The title value for the nuget package metadata.
54 *
55 * Defaults to the `productName` field and then the `name` field from your app's package.json file when unspecified.
56 */
57 title?: string;
58 /**
59 * Windows Application Model ID (appId).
60 *
61 * Defaults to the name field in your app's package.json file.
62 */
63 name?: string;
64 /**
65 * The path to an Authenticode Code Signing Certificate
66 */
67 certificateFile?: string;
68 /**
69 * The password to decrypt the certificate given in `certificateFile`
70 */
71 certificatePassword?: string;
72 /**
73 * Params to pass to signtool.
74 *
75 * Overrides `certificateFile` and `certificatePassword`.
76 */
77 signWithParams?: string;
78 /**
79 * A publicly accessible, fully qualified HTTP(S) URL to an ICO file, used as the application icon
80 * displayed in Control Panel ➡ Programs and Features. The icon is retrieved at install time.
81 * Example: http://example.com/favicon.ico
82 *
83 * Does not accept `file:` URLs.
84 *
85 * Defaults to the Electron icon.
86 */
87 iconUrl?: string;
88 /**
89 * The ICO file to use as the icon for the generated Setup.exe
90 */
91 setupIcon?: string;
92 /**
93 * The name to use for the generated Setup.exe file
94 */
95 setupExe?: string;
96 /**
97 * The name to use for the generated Setup.msi file
98 */
99 setupMsi?: string;
100 /**
101 * Should Squirrel.Windows create an MSI installer?
102 */
103 noMsi?: boolean;
104 /**
105 * Should Squirrel.Windows delta packages? (disable only if necessary, they are a Good Thing)
106 */
107 noDelta?: boolean;
108 /**
109 * A URL to your existing updates. If given, these will be downloaded to create delta updates
110 */
111 remoteReleases?: string;
112 /**
113 * Authentication token for remote updates
114 */
115 remoteToken?: string;
116 usePackageJson?: boolean;
117 frameworkVersion?: string;
118 fixUpPaths?: boolean;
119 skipUpdateIcon?: boolean;
120}
121export interface PersonMetadata {
122 name: string;
123 email?: string;
124 url?: string;
125}
126export interface AdditionalFile {
127 src: string;
128 target: string;
129}
130export interface Metadata {
131 name?: string;
132 productName?: string;
133 version?: string;
134 copyright?: string;
135 author?: string | PersonMetadata;
136 authors?: string | PersonMetadata[];
137 owners?: string | PersonMetadata[];
138 description?: string;
139 iconUrl?: string;
140 additionalFiles?: AdditionalFile[];
141}