UNPKG

1.75 kBTypeScriptView Raw
1/**
2 * Squirrel.Windows options.
3 */
4import { TargetSpecificOptions } from "../core";
5export interface SquirrelWindowsOptions extends TargetSpecificOptions {
6 /**
7 * A URL to an ICO file to use as the application icon (displayed in Control Panel > Programs and Features). Defaults to the Electron icon.
8 *
9 * Please note — [local icon file url is not accepted](https://github.com/atom/grunt-electron-installer/issues/73), must be https/http.
10 *
11 * If you don't plan to build windows installer, you can omit it.
12 * If your project repository is public on GitHub, it will be `https://github.com/${u}/${p}/blob/master/build/icon.ico?raw=true` by default.
13 */
14 readonly iconUrl?: string | null;
15 /**
16 * The path to a .gif file to display during install. `build/install-spinner.gif` will be used if exists (it is a recommended way to set)
17 * (otherwise [default](https://github.com/electron/windows-installer/blob/master/resources/install-spinner.gif)).
18 */
19 readonly loadingGif?: string | null;
20 /**
21 * Whether to create an MSI installer. Defaults to `false` (MSI is not created).
22 */
23 readonly msi?: boolean;
24 /**
25 * A URL to your existing updates. Or `true` to automatically set to your GitHub repository. If given, these will be downloaded to create delta updates.
26 */
27 readonly remoteReleases?: string | boolean | null;
28 /**
29 * Authentication token for remote updates
30 */
31 readonly remoteToken?: string | null;
32 /**
33 * Use `appId` to identify package instead of `name`.
34 */
35 readonly useAppIdAsId?: boolean;
36 /**
37 * https://github.com/electron-userland/electron-builder/issues/1743
38 * @private
39 */
40 readonly name?: string;
41}