Logo for jsDocs.io

electron-winstaller

  • Version 5.4.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

Interfaces

Functions

function convertVersion

convertVersion: (version: string) => string;

function createWindowsInstaller

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

  • This package's main function, which creates a Squirrel.Windows executable installer and optionally code-signs the output.

    Parameter options

    Options for installer generation and signing

    See Also

Interfaces

interface Options

interface SquirrelWindowsOptions {}

    property appDirectory

    appDirectory: string;

    • The folder path of your Electron app

    property authors

    authors?: string;

    property certificateFile

    certificateFile?: string;

    • The path to an Authenticode Code Signing Certificate.

      This is a legacy parameter provided for backwards compatibility. For more comprehensive support of various codesigning scenarios like EV certificates, see the windowsSign parameter.

    property certificatePassword

    certificatePassword?: string;

    • The password to decrypt the certificate given in certificateFile

      This is a legacy parameter provided for backwards compatibility. For more comprehensive support of various codesigning scenarios like EV certificates, see the windowsSign parameter.

    property copyright

    copyright?: string;

    property description

    description?: string;

    property exe

    exe?: string;

    • The name of your app's main .exe file.

    property fixUpPaths

    fixUpPaths?: boolean;

    • Attempt to create more descriptive installer names using metadata parameters.

    property frameworkVersion

    frameworkVersion?: string;

    • Set the required .NET framework version (e.g. net461).

    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.

    property loadingGif

    loadingGif?: string;

    • The local path to a .gif file to display during install.

    property name

    name?: string;

    property noDelta

    noDelta?: boolean;

    • Enable this flag to prevent Squirrel.Windows from creating delta packages (disable only if necessary, they are a Good Thing).

    property noMsi

    noMsi?: boolean;

    • Enable this flag to prevent Squirrel.Windows from creating an MSI installer.

    property nuspecTemplate

    nuspecTemplate?: string;

    • The path to the .nuspectemplate file used by Squirrel.exe.

    property outputDirectory

    outputDirectory?: string;

    • The folder path to create the .exe installer in.

    property owners

    owners?: string;

    property remoteReleases

    remoteReleases?: string;

    • A URL to your existing updates. If given, these will be downloaded to create delta updates.

    property remoteToken

    remoteToken?: string;

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

      This is a legacy parameter provided for backwards compatibility. For more comprehensive support of various codesigning scenarios like EV certificates, see the windowsSign parameter.

    property skipUpdateIcon

    skipUpdateIcon?: boolean;

    • Enable this flag to skip setting a custom icon for Update.exe

    property title

    title?: string;

    property usePackageJson

    usePackageJson?: boolean;

    • Whether or not to infer metadata options from your app's package.json file.

    property vendorDirectory

    vendorDirectory?: string;

    • The folder path of Squirrel windows

    property version

    version?: string;

    property windowsSign

    windowsSign?: SignToolOptions;

    • Requires Node.js 18 or newer.

      Sign your app with @electron/windows-sign, allowing for full customization of the code-signing process - and supports more complicated scenarios like cloud-hosted EV certificates, custom sign pipelines, and per-file overrides. It also supports all existing "simple" codesigning scenarios, including just passing a certificate file and password.

      See Also

    interface SquirrelWindowsOptions

    interface SquirrelWindowsOptions {}

      property appDirectory

      appDirectory: string;

      • The folder path of your Electron app

      property authors

      authors?: string;

      property certificateFile

      certificateFile?: string;

      • The path to an Authenticode Code Signing Certificate.

        This is a legacy parameter provided for backwards compatibility. For more comprehensive support of various codesigning scenarios like EV certificates, see the windowsSign parameter.

      property certificatePassword

      certificatePassword?: string;

      • The password to decrypt the certificate given in certificateFile

        This is a legacy parameter provided for backwards compatibility. For more comprehensive support of various codesigning scenarios like EV certificates, see the windowsSign parameter.

      property copyright

      copyright?: string;

      property description

      description?: string;

      property exe

      exe?: string;

      • The name of your app's main .exe file.

      property fixUpPaths

      fixUpPaths?: boolean;

      • Attempt to create more descriptive installer names using metadata parameters.

      property frameworkVersion

      frameworkVersion?: string;

      • Set the required .NET framework version (e.g. net461).

      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.

      property loadingGif

      loadingGif?: string;

      • The local path to a .gif file to display during install.

      property name

      name?: string;

      property noDelta

      noDelta?: boolean;

      • Enable this flag to prevent Squirrel.Windows from creating delta packages (disable only if necessary, they are a Good Thing).

      property noMsi

      noMsi?: boolean;

      • Enable this flag to prevent Squirrel.Windows from creating an MSI installer.

      property nuspecTemplate

      nuspecTemplate?: string;

      • The path to the .nuspectemplate file used by Squirrel.exe.

      property outputDirectory

      outputDirectory?: string;

      • The folder path to create the .exe installer in.

      property owners

      owners?: string;

      property remoteReleases

      remoteReleases?: string;

      • A URL to your existing updates. If given, these will be downloaded to create delta updates.

      property remoteToken

      remoteToken?: string;

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

        This is a legacy parameter provided for backwards compatibility. For more comprehensive support of various codesigning scenarios like EV certificates, see the windowsSign parameter.

      property skipUpdateIcon

      skipUpdateIcon?: boolean;

      • Enable this flag to skip setting a custom icon for Update.exe

      property title

      title?: string;

      property usePackageJson

      usePackageJson?: boolean;

      • Whether or not to infer metadata options from your app's package.json file.

      property vendorDirectory

      vendorDirectory?: string;

      • The folder path of Squirrel windows

      property version

      version?: string;

      property windowsSign

      windowsSign?: SignToolOptions;

      • Requires Node.js 18 or newer.

        Sign your app with @electron/windows-sign, allowing for full customization of the code-signing process - and supports more complicated scenarios like cloud-hosted EV certificates, custom sign pipelines, and per-file overrides. It also supports all existing "simple" codesigning scenarios, including just passing a certificate file and password.

        See Also

      Package Files (2)

      Dependencies (5)

      Dev Dependencies (12)

      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>