Skip to main content

Interface: PortableOptions

Portable options.

Extends​

Properties​

artifactName?​

readonly optional artifactName?: string | null

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?: CustomNsisBinary | null

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?: CustomNsisResources | null

Allows you to provide your own nsis-resources

Inherited from​

CommonNsisOptions.customNsisResources

guid?​

readonly optional guid?: string | null

The GUID for the installer. Used to identify the application for upgrade and uninstall operations. If not specified, a deterministic GUID is generated from the app ID (appId) — but this means changing your appId will break silent upgrades of existing installs.

See​

GUID vs Application Name

Inherited from​

CommonNsisOptions.guid

include?​

readonly optional include?: string | string[] | null

The path to NSIS include script to customize the portable launcher, or an array of such paths to include multiple scripts. See Custom NSIS script.

Each path is resolved relative to the build resources directory first and then relative to the project directory. When an array is provided, all scripts are included in the specified order.

Unlike the installer targets, the portable target does not fall back to build/installer.nsh — a custom script is only included when this option is explicitly set.

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?: string | null

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).

useZip?​

readonly optional useZip?: boolean

Forces zip compression format instead of LZMA. Used internally for differential update packages.

Default​

false

Inherited from​

CommonNsisOptions.useZip

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