Developer API only. See Configuration for user documentation.

electron-builder

AfterPackContext

Kind: interface of electron-builder
Properties

  • outDir String
  • appOutDir String
  • packager PlatformPackager<any>
  • electronPlatformName String
  • arch Arch
  • targets Array<Target>

ArtifactCreatedmodule:packages/electron-publish/out/publisher.UploadTask

Kind: interface of electron-builder
Extends: module:packages/electron-publish/out/publisher.UploadTask
Properties

  • packager PlatformPackager<any>
  • target Target
  • updateInfo any
  • safeArtifactName String
  • publishConfig PublishConfiguration
  • isWriteUpdateInfo Boolean

BeforeBuildContext

Kind: interface of electron-builder
Properties

  • appDir String
  • electronVersion String
  • platform Platform
  • arch String

BuildResult

Kind: interface of electron-builder
Properties

  • outDir String
  • platformToTargets Map<Platform | Map<String | Target>>

CertificateFromStoreInfo

Kind: interface of electron-builder
Properties

  • thumbprint String
  • subject String
  • store String
  • isLocalMachineStore Boolean

FileCodeSigningInfo

Kind: interface of electron-builder
Properties

  • file String
  • password String

SourceRepositoryInfo

Kind: interface of electron-builder
Properties

  • type String
  • domain String
  • user String
  • project String

AppInfo

Kind: class of electron-builder
Properties

  • description = smarten(this.info.metadata.description || "") String
  • version String
  • buildNumber String | undefined
  • buildVersion String
  • productName String
  • productFilename String
  • channel String
  • versionInWeirdWindowsForm String
  • companyName String
  • id String
  • name String
  • sanitizedName String
  • copyright String

Methods

appInfo.computePackageUrl()Promise< | String>

Packager

Kind: class of electron-builder
Properties

  • projectDir String
  • appDir String
  • metadata Metadata
  • isPrepackedAppAsar Boolean
  • devMetadata Metadata
  • config Configuration
  • isTwoPackageJsonProjectLayoutUsed = true Boolean
  • eventEmitter = new EventEmitter() EventEmitter
  • appInfo AppInfo
  • tempDirManager = new TmpDir() TmpDir
  • options PackagerOptions
  • debugLogger = new DebugLogger(debug.enabled) DebugLogger
  • repositoryInfo Promise< | SourceRepositoryInfo>
  • productionDeps Lazy<Array<Dependency>>

Methods

packager.addAfterPackHandler(handler)

Param Type
handler callback

packager.afterPack(context)Promise<any>

Param Type
context AfterPackContext

packager.artifactCreated(handler)Packager

Param Type
handler callback

packager.build()Promise<BuildResult>

packager.dispatchArtifactCreated(event)

Param Type
event ArtifactCreated

Platform

Kind: class of electron-builder
Properties

  • MAC = new Platform("mac", "mac", "darwin") Platform
  • LINUX = new Platform("linux", "linux", "linux") Platform
  • WINDOWS = new Platform("windows", "win", "win32") Platform
  • OSX = Platform.MAC Platform

Methods

platform.createTarget(type, archs)Map<Platform | Map<Arch | Array<String>>>

Param Type
type String \ Array<String> \ null
archs Array<Arch>

platform.current()Platform

platform.fromString(name)Platform

Param Type
name String

platform.toString()String

Target

Kind: class of electron-builder
Properties

Methods

target.build(appOutDir, arch)Promise<any>

Param Type
appOutDir String
arch Arch

target.finishBuild()Promise<any>

electron-builder.Arch : enum

Kind: enum of electron-builder
Properties

  • ia32
  • x64
  • armv7l

electron-builder.build(rawOptions)Promise<Array<String>>

Kind: method of electron-builder

Param Type
rawOptions CliOptions

electron-builder.buildForge(forgeOptions, options)Promise<Array<String>>

Kind: method of electron-builder

Param Type
forgeOptions ForgeOptions
options CliOptions

electron-builder.createTargets(platforms, type, arch)Map<Platform | Map<Arch | Array<String>>>

Kind: method of electron-builder

Param Type
platforms Array<Platform>
type String \ null
arch String \ null

results matching ""

    No results matching ""