Skip to content

electron builder.Interface.PortableOptions

Electron-Builder / electron-builder / PortableOptions

Portable options.

Extends

Properties

artifactName?

readonly optional artifactName: null | string

The artifact file name template.

Inherited from

TargetSpecificOptions.artifactName

buildUniversalInstaller?

readonly optional buildUniversalInstaller: boolean

Disable building an universal installer of the archs specified in the target configuration

Default

true

customNsisBinary?

readonly optional customNsisBinary: null | CustomNsisBinary

Allows you to provide your own makensis, such as one with support for debug logging via LogSet and LogText. (Logging also requires option debugLogging = true)

Inherited from

CommonNsisOptions.customNsisBinary

customNsisResources?

readonly optional customNsisResources: null | CustomNsisResources

Allows you to provide your own nsis-resources

Inherited from

CommonNsisOptions.customNsisResources

guid?

readonly optional guid: null | string

See GUID vs Application Name.

Inherited from

CommonNsisOptions.guid

publish?

optional publish: Publish

Inherited from

TargetSpecificOptions.publish

requestExecutionLevel?

readonly optional requestExecutionLevel: "user" | "highest" | "admin"

The requested execution level for Windows.

Default

user

splashImage?

readonly optional splashImage: null | string

The image to show while the portable executable is extracting. This image must be a bitmap (.bmp) image.

unicode?

readonly optional unicode: boolean

Whether to create Unicode installer.

Default

true

Inherited from

CommonNsisOptions.unicode

unpackDirName?

readonly optional unpackDirName: string | boolean

The unpack directory for the portable app resources.

If set to a string, it will be the name in TEMP directory If set explicitly to false, it will use the Windows temp directory ($PLUGINSDIR) that is unique to each launch of the portable application.

Defaults to uuid of build (changed on each build of portable executable).

warningsAsErrors?

readonly optional warningsAsErrors: boolean

If warningsAsErrors is true (default): NSIS will treat warnings as errors. If warningsAsErrors is false: NSIS will allow warnings.

Default

true

Inherited from

CommonNsisOptions.warningsAsErrors