electron-builder

  • Version 25.1.8
  • Published
  • 76 kB
  • 10 dependencies
  • MIT license

Install

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

Overview

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

Index

Functions

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>>>;

      function publish

      publish: (args: {
      files: string[];
      version: string | undefined;
      config: string | undefined;
      }) => Promise<UploadTask[] | null>;

        function publishArtifactsWithOptions

        publishArtifactsWithOptions: (
        uploadOptions: { file: string; arch: string | null }[],
        buildVersion?: string,
        configurationFilePath?: string,
        publishConfiguration?: Publish
        ) => Promise<UploadTask[] | null>;

          Interfaces

          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 (3)

                        Dependencies (10)

                        Dev Dependencies (3)

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

                        • Markdown
                          [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/electron-builder)
                        • 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>