Skip to main content

Interface: MsixOptions

Extends​

Properties​

addAutoLaunchExtension?​

readonly optional addAutoLaunchExtension?: boolean

Whether to add auto launch extension. Defaults to true if electron-winstore-auto-launch is in the dependencies.

applicationId?​

readonly optional applicationId?: string

The application id. Defaults to identityName. This string contains alpha-numeric fields separated by periods. Each field must begin with an ASCII alphabetic character.

artifactName?​

readonly optional artifactName?: string | null

The artifact file name template.

Inherited from​

TargetSpecificOptions.artifactName

backgroundColor?​

readonly optional backgroundColor?: string | null

The background color of the app tile.

Default​

#464646

capabilities?​

readonly optional capabilities?: string[] | null

The list of capabilities to be added to the AppxManifest.xml. The runFullTrust capability is obligatory for Electron apps and will be auto-added if not specified.

Default​

["runFullTrust"]

createMsixbundle?​

readonly optional createMsixbundle?: boolean

Whether to produce a .msixbundle when more than one architecture is built.

Default​

true

createMsixupload?​

readonly optional createMsixupload?: boolean

Whether to produce a .msixupload archive suitable for submission to the Microsoft Store Partner Center.

Default​

false

customExtensionsPath?​

readonly optional customExtensionsPath?: string

Relative path to custom extensions xml to be included in the AppxManifest.xml.

customManifestPath?​

readonly optional customManifestPath?: string

Relative path to a custom AppxManifest.xml template located in the build resources directory. Supports the same ${} template macros as the default template, including the MSIX-specific ${packageIntegrity} macro. Windows services are injected via the ${extensions} macro alongside protocol/file-association extensions.

displayName?​

readonly optional displayName?: string | null

A friendly name displayed to users. Corresponds to Properties.DisplayName. Defaults to the application product name.

enforcePackageIntegrity?​

readonly optional enforcePackageIntegrity?: boolean

Enforce package integrity (uap10:PackageIntegrity). Requires Windows 10 version 2004 (build 19041) or later. When enabled, Windows verifies that no files have been tampered with after the package was signed.

Default​

false

identityName?​

readonly optional identityName?: string | null

The package identity name. Corresponds to Identity.Name. Defaults to the application name.

languages?​

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

The list of supported languages listed in the Windows Store. The first entry (index 0) will be the default language.

Default​

["en-US"]

maxVersionTested?​

readonly optional maxVersionTested?: string | null

Set the MaxVersionTested field in the AppxManifest.xml.

Default​

same as minVersion

minVersion?​

readonly optional minVersion?: string | null

Set the MinVersion field in the AppxManifest.xml.

Default​

"10.0.17763.0" (Windows 10 version 1809 — minimum for Store submissions)

publish?​

optional publish?: Publish

Inherited from​

TargetSpecificOptions.publish

publisher?​

readonly optional publisher?: string | null

The Windows Store publisher. Not used if MSIX is built for testing.

publisherDisplayName?​

readonly optional publisherDisplayName?: string | null

A friendly name for the publisher displayed to users. Corresponds to Properties.PublisherDisplayName. Defaults to company name from the application metadata.

setBuildNumber?​

readonly optional setBuildNumber?: boolean

Whether to set the build number in the version field.

Default​

false

showNameOnTiles?​

readonly optional showNameOnTiles?: boolean

Whether to overlay the app's name on top of tile images on the Start screen.

Default​

false

windowsServices?​

readonly optional windowsServices?: MsixWindowsService[]

Windows Services to register with the MSIX package (desktop6 namespace). Requires Windows 10 version 1903 or later, and the packagedServices (or localSystemServices) restricted capability declared via capabilities.