Documentation
    Preparing search index...

    Interface MakerMSIXConfig

    The configuration object for the MSIX maker. The outputDir and appDir parameters are preconfigured by Forge so that the Maker uses the package output and can be then used to publish the app.

    Certain manifest variables are given good defaults by Forge. You can override these if required.

    https://github.com/bitdisaster/electron-windows-msix/blob/master/src/types.ts

    interface MakerMSIXConfig {
        appManifest?: string;
        createPri?: boolean;
        logLevel?: "debug" | "warn";
        manifestVariables?: MakerMSIXConfigManifestVariables;
        outputFileName?: string | (() => string | Promise<string>);
        packageAssets?: string;
        packageName?: string;
        sign?: boolean;
        windowsKitPath?: string;
        windowsKitVersion?: string;
        windowsSignOptions?: WindowsSignOptions;
    }

    Hierarchy

    • Omit<MSIXPackagingOptions, "outputDir" | "appDir" | "manifestVariables">
      • MakerMSIXConfig
    Index

    Properties

    appManifest? createPri? logLevel? manifestVariables? outputFileName? packageAssets? packageName? sign? windowsKitPath? windowsKitVersion? windowsSignOptions?

    Properties

    appManifest?: string

    The AppManifest.xml containing necessary declarations to build the MSIX

    createPri?: boolean

    Indicates whether to create Pri resource files. It will be enabled by default.

    logLevel?: "debug" | "warn"

    Controls the level of logging

    manifestVariables?: MakerMSIXConfigManifestVariables
    outputFileName?: string | (() => string | Promise<string>)

    The base name of the generated .msix file, without the .msix extension (the maker always appends .msix). This only overrides the file name; the file is still written to the same msix/<arch> output directory.

    This can be a string, or a (possibly async) function returning the base filename. The function form is useful when you want to compute the value dynamically, e.g. to include a version number.

    ${path.basename(dir)}-${packageJSON.version}, e.g. my-app-win32-x64-1.2.3

    packageAssets?: string

    Optional assets used in AppManifest.xml. E.g. icons and tile images. If not provided then the default assets will be used.

    packageName?: string

    Optional name for the finished MSIX package file. If not provided a name will be derived from AppManifest.xml.

    sign?: boolean

    Indicates whether to sign the MSIX package. It will be enabled by default. If cert or signParams are not provided then the package will be signed with a dev cert. If sign is false then the package will not be signed.

    windowsKitPath?: string

    An optional full path to the WindowsKit. This path will trump both WindowsKitVersion and AppxManifest.

    windowsKitVersion?: string

    Optional version of the WindowsKit to use. If WindowsKitPath is provide then it will trump this. If neither WindowsKitVersion nor WindowsKitPath is provided then the Windows Kit path will be derived from the OS Version specified in AppManifest.xml.

    windowsSignOptions?: WindowsSignOptions

    Optional options for @electron/windows-sign. If present it will supersede signParams parameter.

    Settings

    Member Visibility

    On This Page

    Properties