Documentation
    Preparing search index...

    Interface MakerWixConfig

    interface MakerWixConfig {
        appUserModelId?: string;
        arch?: "x64" | "ia64" | "x86";
        associateExtensions?: string;
        autoRun?: boolean;
        beforeCreate?: (creator: MSICreator) => void | Promise<void>;
        bundled?: boolean;
        certificateFile?: string;
        certificatePassword?: string;
        cultures?: string;
        defaultInstallMode?: "perUser" | "perMachine";
        description?: string;
        exe?: string;
        extensions?: string[];
        features?: false | Features;
        icon?: string;
        installLevel?: number;
        language?: number;
        lightSwitches?: string[];
        manufacturer?: string;
        name?: string;
        nestedFolderName?: string;
        programFilesFolderName?: string;
        rebootMode?: string;
        shortcutFolderName?: string;
        shortcutName?: string;
        shortName?: string;
        signWithParams?: string;
        toastActivatorClsid?: string;
        ui?: boolean | UIOptions;
        upgradeCode?: string;
        version?: string;
        windowsSign?: WindowsSignOptions;
    }

    Hierarchy

    • Omit<
          MSICreatorOptions,
          | "appDirectory"
          | "outputDirectory"
          | "description"
          | "name"
          | "version"
          | "manufacturer"
          | "exe",
      >
      • MakerWixConfig
    Index

    Properties

    appUserModelId? arch? associateExtensions? autoRun? beforeCreate? bundled? certificateFile? certificatePassword? cultures? defaultInstallMode? description? exe? extensions? features? icon? installLevel? language? lightSwitches? manufacturer? name? nestedFolderName? programFilesFolderName? rebootMode? shortcutFolderName? shortcutName? shortName? signWithParams? toastActivatorClsid? ui? upgradeCode? version? windowsSign?

    Properties

    appUserModelId?: string
    arch?: "x64" | "ia64" | "x86"
    associateExtensions?: string
    autoRun?: boolean
    beforeCreate?: (creator: MSICreator) => void | Promise<void>

    Allows for the modification of the MSICreator before create is called.

    bundled?: boolean
    certificateFile?: string
    certificatePassword?: string
    cultures?: string
    defaultInstallMode?: "perUser" | "perMachine"
    description?: string

    The app's description

    The description field in package.json

    exe?: string

    The name of the exe file

    the default MakerWixConfig.name + .exe

    extensions?: string[]
    features?: false | Features
    icon?: string
    installLevel?: number
    language?: number
    lightSwitches?: string[]
    manufacturer?: string

    The app's manufacturer

    The author field in package.json

    name?: string

    The app's name.

    The value of packagerConfig.name in the Forge config, or the productName or name in package.json (in that order)

    nestedFolderName?: string
    programFilesFolderName?: string
    rebootMode?: string
    shortcutFolderName?: string
    shortcutName?: string
    shortName?: string
    signWithParams?: string
    toastActivatorClsid?: string
    ui?: boolean | UIOptions
    upgradeCode?: string
    version?: string

    The app's version. It must be a valid semantic version.

    The version field in package.json

    windowsSign?: WindowsSignOptions

    Settings

    Member Visibility

    On This Page

    Properties