Skip to content

electron builder.Interface.SquirrelWindowsOptions

Electron-Builder / electron-builder / SquirrelWindowsOptions

Extends

Properties

artifactName?

readonly optional artifactName: null | string

The artifact file name template.

Inherited from

TargetSpecificOptions.artifactName

customSquirrelVendorDir?

readonly optional customSquirrelVendorDir: string

The custom squirrel vender dir. If not specified will use the Squirrel.Windows that is shipped with electron-installer(https://github.com/electron/windows-installer/tree/main/vendor). After https://github.com/electron-userland/electron-builder-binaries/pull/56 merged, will add electron-builder-binaries to get the latest version of squirrel.

iconUrl?

readonly optional iconUrl: null | string

A URL to an ICO file to use as the application icon (displayed in Control Panel > Programs and Features). Defaults to the Electron icon.

Please note — local icon file url is not accepted, must be https/http.

If you don’t plan to build windows installer, you can omit it. 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.

loadingGif?

readonly optional loadingGif: null | string

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) (otherwise default).

msi?

readonly optional msi: boolean

Whether to create an MSI installer. Defaults to false (MSI is not created).

publish?

optional publish: Publish

Inherited from

TargetSpecificOptions.publish

remoteReleases?

readonly optional remoteReleases: null | string | boolean

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.

remoteToken?

readonly optional remoteToken: null | string

Authentication token for remote updates

useAppIdAsId?

readonly optional useAppIdAsId: boolean

Use appId to identify package instead of name.