• Version 24.13.3
  • Published
  • 61.6 kB
  • 11 dependencies
  • MIT license


npm i electron-builder
yarn add electron-builder
pnpm add electron-builder


A complete solution to package and build a ready for distribution Electron app for MacOS, Windows and Linux with “auto update” support out of the box



function build

build: (rawOptions?: CliOptions) => Promise<Array<string>>;

    function createTargets

    createTargets: (
    platforms: Array<Platform>,
    type?: string | null,
    arch?: string | null
    ) => Map<Platform, Map<Arch, Array<string>>>;


      interface CliOptions

      interface CliOptions extends PackagerOptions, PublishOptions {}

        property arm64

        arm64?: boolean;

          property armv7l

          armv7l?: boolean;

            property dir

            dir?: boolean;

              property ia32

              ia32?: boolean;

                property universal

                universal?: boolean;

                  property x64

                  x64?: boolean;

                    Package Files (2)

                    Dependencies (11)

                    Dev Dependencies (3)

                    Peer Dependencies (0)

                    No peer dependencies.


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

                    • Markdown
                    • HTML
                      <a href="https://www.jsdocs.io/package/electron-builder"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>