Logo for jsDocs.io

electron-builder-core

  • Version 19.2.3
  • Published
  • No dependencies
  • MIT license

Install

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

Overview

Part of [electron-builder](https://github.com/electron-userland/electron-builder).

Index

Namespaces

Namespaces

namespace electron-builder-core

module 'electron-builder-core' {}

    variable DEFAULT_TARGET

    const DEFAULT_TARGET: string;

      variable DIR_TARGET

      const DIR_TARGET: string;

        function archFromString

        archFromString: (name: string) => Arch;

          function getArchSuffix

          getArchSuffix: (arch: Arch) => string;

            function toLinuxArchString

            toLinuxArchString: (arch: Arch) => 'armv7l' | 'i386' | 'amd64';

              class Platform

              class Platform {}

                constructor

                constructor(name: string, buildConfigurationKey: string, nodeName: string);

                  property buildConfigurationKey

                  buildConfigurationKey: string;

                    property LINUX

                    static LINUX: Platform;

                      property MAC

                      static MAC: Platform;

                        property name

                        name: string;

                          property nodeName

                          nodeName: string;

                            property OSX

                            static OSX: Platform;

                              property WINDOWS

                              static WINDOWS: Platform;

                                method createTarget

                                createTarget: (
                                    type?: string | Array<string> | null,
                                    ...archs: Array<Arch>
                                ) => Map<Platform, Map<Arch, Array<string>>>;

                                  method current

                                  static current: () => Platform;

                                    method fromString

                                    static fromString: (name: string) => Platform;

                                      method toString

                                      toString: () => string;

                                        class Target

                                        abstract class Target {}

                                          constructor

                                          constructor(name: string, isAsyncSupported?: boolean);

                                            property isAsyncSupported

                                            readonly isAsyncSupported: boolean;

                                              property name

                                              readonly name: string;

                                                property options

                                                abstract readonly options: TargetSpecificOptions;

                                                  property outDir

                                                  abstract readonly outDir: string;

                                                    method build

                                                    abstract build: (appOutDir: string, arch: Arch) => Promise<any>;

                                                      method finishBuild

                                                      finishBuild: () => Promise<any>;

                                                        interface BeforeBuildContext

                                                        interface BeforeBuildContext {}

                                                          property appDir

                                                          readonly appDir: string;

                                                            property arch

                                                            readonly arch: string;

                                                              property electronVersion

                                                              readonly electronVersion: string;

                                                                property platform

                                                                readonly platform: Platform;

                                                                  interface SourceRepositoryInfo

                                                                  interface SourceRepositoryInfo {}

                                                                    property domain

                                                                    domain?: string;

                                                                      property project

                                                                      project: string;

                                                                        property type

                                                                        type?: string;

                                                                          property user

                                                                          user: string;

                                                                            interface TargetConfig

                                                                            interface TargetConfig {}

                                                                              property arch

                                                                              readonly arch?: Array<'x64' | 'ia32' | 'armv7l'> | string;

                                                                              • The arch or list of archs.

                                                                              property target

                                                                              readonly target: string;

                                                                              • The target name. e.g. snap.

                                                                              interface TargetSpecificOptions

                                                                              interface TargetSpecificOptions {}

                                                                                property artifactName

                                                                                readonly artifactName?: string | null;

                                                                                • The [artifact file name pattern](https://github.com/electron-userland/electron-builder/wiki/Options#artifact-file-name-pattern).

                                                                                property publish

                                                                                readonly publish?: Publish;

                                                                                  enum Arch

                                                                                  enum Arch {
                                                                                      ia32 = 0,
                                                                                      x64 = 1,
                                                                                      armv7l = 2,
                                                                                  }

                                                                                    member armv7l

                                                                                    armv7l = 2

                                                                                      member ia32

                                                                                      ia32 = 0

                                                                                        member x64

                                                                                        x64 = 1

                                                                                          type ArchType

                                                                                          type ArchType = 'x64' | 'ia32' | 'armv7l';

                                                                                            type CompressionLevel

                                                                                            type CompressionLevel = 'store' | 'normal' | 'maximum';

                                                                                              type TargetConfigType

                                                                                              type TargetConfigType = Array<string | TargetConfig> | string | TargetConfig | null;

                                                                                                Package Files (1)

                                                                                                Dependencies (0)

                                                                                                No dependencies.

                                                                                                Dev Dependencies (0)

                                                                                                No dev dependencies.

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

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