electron-winstaller

  • Version 5.0.0
  • Published
  • 30 MB
  • 5 dependencies
  • MIT license

Install

npm i electron-winstaller
yarn add electron-winstaller
pnpm add electron-winstaller

Overview

Module to generate Windows installers for Electron apps

Index

Functions

function convertVersion

convertVersion: (version: string) => string;

    function createWindowsInstaller

    createWindowsInstaller: (options: Options) => Promise<void>;

      Interfaces

      interface Options

      interface Options {}

        property appDirectory

        appDirectory: string;
        • The folder path of your Electron app

        property authors

        authors?: string;
        • The authors value for the nuget package metadata.

          Defaults to the author field from your app's package.json file when unspecified.

        property certificateFile

        certificateFile?: string;
        • The path to an Authenticode Code Signing Certificate

        property certificatePassword

        certificatePassword?: string;
        • The password to decrypt the certificate given in certificateFile

        property copyright

        copyright?: string;
        • The copyright value for the nuget package metadata.

          Defaults to a generated copyright with authors or owners.

        property description

        description?: string;
        • The description value for the nuget package metadata.

          Defaults to the description field from your app's package.json file when unspecified.

        property exe

        exe?: string;
        • The name of your app's main .exe file.

          This uses the name field in your app's package.json file with an added .exe extension when unspecified.

        property fixUpPaths

        fixUpPaths?: boolean;

          property frameworkVersion

          frameworkVersion?: string;

            property iconUrl

            iconUrl?: string;
            • A publicly accessible, fully qualified HTTP(S) URL to an ICO file, used as the application icon displayed in Control Panel ➡ Programs and Features. The icon is retrieved at install time. Example: http://example.com/favicon.ico

              Does not accept file: URLs.

              Defaults to the Electron icon.

            property loadingGif

            loadingGif?: string;
            • The local path to a .gif file to display during install.

            property name

            name?: string;
            • Windows Application Model ID (appId).

              Defaults to the name field in your app's package.json file.

            property noDelta

            noDelta?: boolean;
            • Should Squirrel.Windows delta packages? (disable only if necessary, they are a Good Thing)

            property noMsi

            noMsi?: boolean;
            • Should Squirrel.Windows create an MSI installer?

            property outputDirectory

            outputDirectory?: string;
            • The folder path to create the .exe installer in.

              Defaults to the installer folder at the project root.

            property owners

            owners?: string;
            • The owners value for the nuget package metadata.

              Defaults to the authors field when unspecified.

            property remoteReleases

            remoteReleases?: string;
            • A URL to your existing updates. If given, these will be downloaded to create delta updates

            property remoteToken

            remoteToken?: string;
            • Authentication token for remote updates

            property setupExe

            setupExe?: string;
            • The name to use for the generated Setup.exe file

            property setupIcon

            setupIcon?: string;
            • The ICO file to use as the icon for the generated Setup.exe

            property setupMsi

            setupMsi?: string;
            • The name to use for the generated Setup.msi file

            property signWithParams

            signWithParams?: string;
            • Params to pass to signtool.

              Overrides certificateFile and certificatePassword.

            property skipUpdateIcon

            skipUpdateIcon?: boolean;

              property title

              title?: string;
              • The title value for the nuget package metadata.

                Defaults to the productName field and then the name field from your app's package.json file when unspecified.

              property usePackageJson

              usePackageJson?: boolean;

                property version

                version?: string;
                • The version value for the nuget package metadata.

                  Defaults to the version field from your app's package.json file when unspecified.

                Namespaces

                namespace asar

                module 'asar' {}

                  Package Files (3)

                  Dependencies (5)

                  Dev Dependencies (13)

                  Peer Dependencies (0)

                  No peer dependencies.

                  Badge

                  To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                  You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/electron-winstaller.

                  • Markdown
                    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/electron-winstaller)
                  • HTML
                    <a href="https://www.jsdocs.io/package/electron-winstaller"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>