Skip to content

Instantly share code, notes, and snippets.

@develar

develar/foo.md

Created June 8, 2017 11:09
Show Gist options
  • Save develar/12c567f3d2a25666fc6dd943710fedde to your computer and use it in GitHub Desktop.
Save develar/12c567f3d2a25666fc6dd943710fedde to your computer and use it in GitHub Desktop.
Download ZIP
Raw
foo.md

Developer API only. See [[Options]] for user documentation.

Modules

electron-builder
electron-builder/out/appInfo
electron-builder/out/builder
electron-builder/out/codeSign
electron-builder/out/forge/forge-maker
electron-builder/out/linuxPackager
electron-builder/out/macPackager
electron-builder/out/metadata
electron-builder/out/packager/mac
electron-builder/out/packager
electron-builder/out/platformPackager
electron-builder/out/publish/PublishManager
electron-builder/out/targets/appImage
electron-builder/out/targets/appx
electron-builder/out/targets/ArchiveTarget
electron-builder/out/targets/dmg
electron-builder/out/targets/fpm
electron-builder/out/targets/LinuxTargetHelper
electron-builder/out/targets/nsis
electron-builder/out/targets/pkg
electron-builder/out/targets/snap
electron-builder/out/targets/targetFactory
electron-builder/out/targets/WebInstallerTarget
electron-builder/out/util/readPackageJson
electron-builder/out/windowsCodeSign
electron-builder/out/winPackager

electron-builder

AfterPackContext Kind: interface of electron-builder
Properties

Name Type
appOutDir String
packager PlatformPackager<any>
electronPlatformName String
arch Arch
targets Array<Target>

ArtifactCreated Kind: interface of electron-builder
Properties

Name Type
packager PlatformPackager<any>
target Target | null
arch Arch | null
file String
data Buffer
safeArtifactName String
publishConfig PublishConfiguration

BuildInfo Kind: interface of electron-builder
Properties

Name Type
options PackagerOptions
metadata Metadata
devMetadata Metadata
config Config
projectDir String
appDir String
electronVersion String
muonVersion String | null
isTwoPackageJsonProjectLayoutUsed Boolean
appInfo AppInfo
tempDirManager TmpDir
repositoryInfo Promise< | SourceRepositoryInfo>
isPrepackedAppAsar Boolean
prepackaged String | null
cancellationToken CancellationToken

buildInfo.afterPack(context) ⇒ Promise<void> Kind: instance method of BuildInfo

Param Type
context AfterPackContext

buildInfo.dispatchArtifactCreated(event) Kind: instance method of BuildInfo

Param Type
event ArtifactCreated

BuildResult Kind: interface of electron-builder
Properties

Name Type
outDir String
platformToTargets Map<Platform | Map<String | Target>>

CommonLinuxOptions Kind: interface of electron-builder
Properties

Name Type
synopsis String | null
description String | null
category String | null
packageCategory String | null
desktop Object<String, any> | null
vendor String | null
maintainer String | null
afterInstall String | null
afterRemove String | null

CommonNsisOptions Kind: interface of electron-builder
Properties

Name Type
unicode Boolean
guid String | null
warningsAsErrors Boolean

LinuxTargetSpecificOptions ⇐ CommonLinuxOptions Kind: interface of electron-builder
Extends: CommonLinuxOptions
Properties

Name Type Description
depends Array<String> | null Package dependencies.
icon String

PlatformSpecificBuildOptions ⇐ TargetSpecificOptions Kind: interface of electron-builder
Extends: TargetSpecificOptions
Properties

Name Type
files Array<String> | String | null
extraFiles Array<String | FilePattern> | FilePattern | String | null
extraResources Array<String | FilePattern> | FilePattern | String | null
asarUnpack Array<String> | String | null
asar AsarOptions | Boolean | null
target Array<String | TargetConfig> | String | TargetConfig | null
icon String | null
fileAssociations Array<FileAssociation> | FileAssociation
forceCodeSigning Boolean

Packager ⇐ BuildInfo Kind: class of electron-builder
Extends: BuildInfo
Properties

Name Type
projectDir String
appDir String
metadata Metadata
devMetadata Metadata
isTwoPackageJsonProjectLayoutUsed = true Boolean
electronVersion String
muonVersion String | null
eventEmitter = new EventEmitter() internal:EventEmitter
appInfo AppInfo
tempDirManager = new TmpDir() TmpDir
prepackaged String | null

packager.addAfterPackHandler(handler) Kind: instance method of Packager

Param Type
handler callback

packager.afterPack(context) ⇒ Promise<void> Kind: instance method of Packager
Overrides: afterPack

Param Type
context AfterPackContext

packager.artifactCreated(handler) ⇒ Packager Kind: instance method of Packager

Param Type
handler callback

packager.build() ⇒ Promise<BuildResult> Kind: instance method of Packager

packager.dispatchArtifactCreated(event) Kind: instance method of Packager
Overrides: dispatchArtifactCreated

Param Type
event ArtifactCreated

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

electron-builder/out/appInfo

AppInfo Kind: class of electron-builder/out/appInfo
Properties

Name Type
description = "smarten(this.metadata.description
version String
buildNumber String
buildVersion String
productName String
productFilename String

appInfo.computePackageUrl() ⇒ Promise< | String> Kind: instance method of AppInfo

electron-builder/out/builder

electron-builder/out/codeSign

CodeSigningInfo Kind: interface of electron-builder/out/codeSign
Properties

Name Type
keychainName String | null

CreateKeychainOptions Kind: interface of electron-builder/out/codeSign
Properties

Name Type
tmpDir TmpDir
cscLink String
cscKeyPassword String
cscILink String | null
cscIKeyPassword String | null
currentDir String

electron-builder/out/codeSign.findIdentityRawResult : Promise<Array<String>> | null Kind: property of electron-builder/out/codeSign

electron-builder/out/codeSign.createKeychain(undefined) ⇒ Promise<CodeSigningInfo> Kind: method of electron-builder/out/codeSign

Param Type
undefined CreateKeychainOptions

electron-builder/out/codeSign.downloadCertificate(urlOrBase64, tmpDir, currentDir) ⇒ Promise<String> Kind: method of electron-builder/out/codeSign

Param Type
urlOrBase64 String
tmpDir TmpDir
currentDir String

electron-builder/out/codeSign.findIdentity(certType, qualifier, keychain) ⇒ Promise< | String> Kind: method of electron-builder/out/codeSign

Param Type
certType "Developer ID Application" | "Developer ID Installer" | "3rd Party Mac Developer Application" | "3rd Party Mac Developer Installer" | "Mac Developer"
qualifier String | null
keychain String | null

electron-builder/out/codeSign.sign(path, name, keychain) ⇒ Promise<any> Kind: method of electron-builder/out/codeSign

Param Type
path String
name String
keychain String

electron-builder/out/forge/forge-maker

ForgeOptions Kind: interface of electron-builder/out/forge/forge-maker
Properties

Name Type
dir String

electron-builder/out/linuxPackager

LinuxPackager ⇐ PlatformPackager Kind: class of electron-builder/out/linuxPackager
Extends: PlatformPackager
Properties

Name Type
executableName String

linuxPackager.createTargets(targets, mapper, cleanupTasks) Kind: instance method of LinuxPackager
Overrides: createTargets

Param Type
targets Array<String>
mapper callback
cleanupTasks Array<module:electron-builder/out/linuxPackager.__type>

linuxPackager.getDefaultIcon(ext) ⇒ Promise< | String> Kind: instance method of LinuxPackager

Param Type
ext String

linuxPackager.dispatchArtifactCreated(file, target, arch, safeArtifactName) Kind: instance method of LinuxPackager

Param Type
file String
target Target | null
arch Arch | null
safeArtifactName String

linuxPackager.getElectronDestDir(appOutDir) ⇒ String Kind: instance method of LinuxPackager

Param Type
appOutDir String

linuxPackager.getElectronSrcDir(dist) ⇒ String Kind: instance method of LinuxPackager

Param Type
dist String

linuxPackager.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern) ⇒ String Kind: instance method of LinuxPackager

Param Type
targetSpecificOptions TargetSpecificOptions | undefined | null
ext String
arch Arch | null
defaultPattern String

linuxPackager.expandMacro(pattern, arch, extra) ⇒ String Kind: instance method of LinuxPackager

Param Type
pattern String
arch String | undefined | null
extra any

linuxPackager.generateName(ext, arch, deployment, classifier) ⇒ String Kind: instance method of LinuxPackager

Param Type
ext String | null
arch Arch
deployment Boolean
classifier String | null

linuxPackager.generateName2(ext, classifier, deployment) ⇒ String Kind: instance method of LinuxPackager

Param Type
ext String | null
classifier String | undefined | null
deployment Boolean

linuxPackager.getIconPath() ⇒ Promise< | String> Kind: instance method of LinuxPackager

linuxPackager.getMacOsResourcesDir(appOutDir) ⇒ String Kind: instance method of LinuxPackager

Param Type
appOutDir String

linuxPackager.pack(outDir, arch, targets, postAsyncTasks) ⇒ Promise<any> Kind: instance method of LinuxPackager

Param Type
outDir String
arch Arch
targets Array<Target>
postAsyncTasks Array<Promise<any>>

linuxPackager.getResource(custom, names) ⇒ Promise< | String> Kind: instance method of LinuxPackager

Param Type
custom String | undefined | null
names Array<String>

linuxPackager.getResourcesDir(appOutDir) ⇒ String Kind: instance method of LinuxPackager

Param Type
appOutDir String

linuxPackager.getTempFile(suffix) ⇒ Promise<String> Kind: instance method of LinuxPackager

Param Type
suffix String

electron-builder/out/macPackager

MacPackager ⇐ PlatformPackager Kind: class of electron-builder/out/macPackager
Extends: PlatformPackager
Properties

Name Type
codeSigningInfo Promise<CodeSigningInfo>

macPackager.createTargets(targets, mapper, cleanupTasks) Kind: instance method of MacPackager
Overrides: createTargets

Param Type
targets Array<String>
mapper callback
cleanupTasks Array<module:electron-builder/out/macPackager.__type>

macPackager.getElectronDestDir(appOutDir) ⇒ String Kind: instance method of MacPackager
Overrides: getElectronDestDir

Param Type
appOutDir String

macPackager.getElectronSrcDir(dist) ⇒ String Kind: instance method of MacPackager
Overrides: getElectronSrcDir

Param Type
dist String

macPackager.getIconPath() ⇒ Promise< | String> Kind: instance method of MacPackager
Overrides: getIconPath

macPackager.pack(outDir, arch, targets, postAsyncTasks) ⇒ Promise<any> Kind: instance method of MacPackager
Overrides: pack

Param Type
outDir String
arch Arch
targets Array<Target>
postAsyncTasks Array<Promise<any>>

macPackager.getDefaultIcon(ext) ⇒ Promise< | String> Kind: instance method of MacPackager

Param Type
ext String

macPackager.dispatchArtifactCreated(file, target, arch, safeArtifactName) Kind: instance method of MacPackager

Param Type
file String
target Target | null
arch Arch | null
safeArtifactName String

macPackager.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern) ⇒ String Kind: instance method of MacPackager

Param Type
targetSpecificOptions TargetSpecificOptions | undefined | null
ext String
arch Arch | null
defaultPattern String

macPackager.expandMacro(pattern, arch, extra) ⇒ String Kind: instance method of MacPackager

Param Type
pattern String
arch String | undefined | null
extra any

macPackager.generateName(ext, arch, deployment, classifier) ⇒ String Kind: instance method of MacPackager

Param Type
ext String | null
arch Arch
deployment Boolean
classifier String | null

macPackager.generateName2(ext, classifier, deployment) ⇒ String Kind: instance method of MacPackager

Param Type
ext String | null
classifier String | undefined | null
deployment Boolean

macPackager.getMacOsResourcesDir(appOutDir) ⇒ String Kind: instance method of MacPackager

Param Type
appOutDir String

macPackager.getResource(custom, names) ⇒ Promise< | String> Kind: instance method of MacPackager

Param Type
custom String | undefined | null
names Array<String>

macPackager.getResourcesDir(appOutDir) ⇒ String Kind: instance method of MacPackager

Param Type
appOutDir String

macPackager.getTempFile(suffix) ⇒ Promise<String> Kind: instance method of MacPackager

Param Type
suffix String

electron-builder/out/metadata

AsarOptions ⇐ module:asar-integrity.AsarIntegrityOptions Kind: interface of electron-builder/out/metadata
Extends: module:asar-integrity.AsarIntegrityOptions
Properties

Name Type
smartUnpack Boolean
ordering String | null

electron-builder/out/packager/mac

electron-builder/out/packager/mac.createApp(packager, appOutDir, asarIntegrity) ⇒ Promise<void> Kind: method of electron-builder/out/packager/mac

Param Type
packager PlatformPackager<any>
appOutDir String
asarIntegrity module:asar-integrity.AsarIntegrity

electron-builder/out/packager/mac.filterCFBundleIdentifier(identifier) ⇒ String Kind: method of electron-builder/out/packager/mac

Param Type
identifier String

electron-builder/out/packager

electron-builder/out/packager.normalizePlatforms(rawPlatforms) ⇒ Array<Platform> Kind: method of electron-builder/out/packager

Param Type
rawPlatforms Array<String | Platform> | String | Platform | undefined | null

electron-builder/out/platformPackager

PlatformPackager Kind: class of electron-builder/out/platformPackager
Properties

Name Type
packagerOptions PackagerOptions
projectDir String
buildResourcesDir String
config Config
platformSpecificBuildOptions module:electron-builder/out/platformPackager.DC
appInfo AppInfo

platformPackager.createTargets(targets, mapper, cleanupTasks) Kind: instance method of PlatformPackager

Param Type
targets Array<String>
mapper callback
cleanupTasks Array<module:electron-builder/out/platformPackager.__type>

platformPackager.getDefaultIcon(ext) ⇒ Promise< | String> Kind: instance method of PlatformPackager

Param Type
ext String

platformPackager.dispatchArtifactCreated(file, target, arch, safeArtifactName) Kind: instance method of PlatformPackager

Param Type
file String
target Target | null
arch Arch | null
safeArtifactName String

platformPackager.getElectronDestDir(appOutDir) ⇒ String Kind: instance method of PlatformPackager

Param Type
appOutDir String

platformPackager.getElectronSrcDir(dist) ⇒ String Kind: instance method of PlatformPackager

Param Type
dist String

platformPackager.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern) ⇒ String Kind: instance method of PlatformPackager

Param Type
targetSpecificOptions TargetSpecificOptions | undefined | null
ext String
arch Arch | null
defaultPattern String

platformPackager.expandMacro(pattern, arch, extra) ⇒ String Kind: instance method of PlatformPackager

Param Type
pattern String
arch String | undefined | null
extra any

platformPackager.generateName(ext, arch, deployment, classifier) ⇒ String Kind: instance method of PlatformPackager

Param Type
ext String | null
arch Arch
deployment Boolean
classifier String | null

platformPackager.generateName2(ext, classifier, deployment) ⇒ String Kind: instance method of PlatformPackager

Param Type
ext String | null
classifier String | undefined | null
deployment Boolean

platformPackager.getIconPath() ⇒ Promise< | String> Kind: instance method of PlatformPackager

platformPackager.getMacOsResourcesDir(appOutDir) ⇒ String Kind: instance method of PlatformPackager

Param Type
appOutDir String

platformPackager.pack(outDir, arch, targets, postAsyncTasks) ⇒ Promise<any> Kind: instance method of PlatformPackager

Param Type
outDir String
arch Arch
targets Array<Target>
postAsyncTasks Array<Promise<any>>

platformPackager.getResource(custom, names) ⇒ Promise< | String> Kind: instance method of PlatformPackager

Param Type
custom String | undefined | null
names Array<String>

platformPackager.getResourcesDir(appOutDir) ⇒ String Kind: instance method of PlatformPackager

Param Type
appOutDir String

platformPackager.getTempFile(suffix) ⇒ Promise<String> Kind: instance method of PlatformPackager

Param Type
suffix String

electron-builder/out/platformPackager.normalizeExt(ext) ⇒ String Kind: method of electron-builder/out/platformPackager

Param Type
ext String

electron-builder/out/publish/PublishManager

PublishManager ⇐ PublishContext Kind: class of electron-builder/out/publish/PublishManager
Extends: PublishContext
Properties

Name Type
publishTasks= Array<Promise<any>>
progress = (<TtyWriteStream>process.stdout).isTTY ? new MultiProgress() : null null | MultiProgress

publishManager.awaitTasks() ⇒ Promise<void> Kind: instance method of PublishManager

publishManager.cancelTasks() Kind: instance method of PublishManager

electron-builder/out/publish/PublishManager.computeDownloadUrl(publishConfig, fileName, packager) ⇒ String Kind: method of electron-builder/out/publish/PublishManager

Param Type
publishConfig PublishConfiguration
fileName String | null
packager PlatformPackager<any>

electron-builder/out/publish/PublishManager.createPublisher(context, version, publishConfig, options) ⇒ null | Publisher Kind: method of electron-builder/out/publish/PublishManager

Param Type
context PublishContext
version String
publishConfig PublishConfiguration
options PublishOptions

electron-builder/out/publish/PublishManager.getPublishConfigs(packager, targetSpecificOptions, arch) ⇒ Promise< | Array> Kind: method of electron-builder/out/publish/PublishManager

Param Type
packager PlatformPackager<any>
targetSpecificOptions PlatformSpecificBuildOptions | null | undefined
arch Arch | null

electron-builder/out/publish/PublishManager.getPublishConfigsForUpdateInfo(packager, publishConfigs, arch) ⇒ Promise< | Array> Kind: method of electron-builder/out/publish/PublishManager

Param Type
packager PlatformPackager<any>
publishConfigs Array<PublishConfiguration> | null
arch Arch | null

electron-builder/out/targets/appImage

AppImageTarget ⇐ Target Kind: class of electron-builder/out/targets/appImage
Extends: Target
Properties

Name Type
options = Object.assign({}, this.packager.platformSpecificBuildOptions, (<any>this.packager.config)[this.name]) LinuxBuildOptions

appImageTarget.build(appOutDir, arch) ⇒ Promise<any> Kind: instance method of AppImageTarget

Param Type
appOutDir String
arch Arch

electron-builder/out/targets/appx

AppXTarget ⇐ Target Kind: class of electron-builder/out/targets/appx
Extends: Target
Properties

Name Type
options = Object.assign({}, this.packager.platformSpecificBuildOptions, this.packager.config.appx) AppXOptions

appXTarget.build(appOutDir, arch) ⇒ Promise<any> Kind: instance method of AppXTarget

Param Type
appOutDir String
arch Arch

electron-builder/out/targets/ArchiveTarget

ArchiveTarget ⇐ Target Kind: class of electron-builder/out/targets/ArchiveTarget
Extends: Target
Properties

Name Type
options = (<any>this.packager.config)[this.name] any

archiveTarget.build(appOutDir, arch) ⇒ Promise<any> Kind: instance method of ArchiveTarget

Param Type
appOutDir String
arch Arch

electron-builder/out/targets/dmg

DmgTarget ⇐ Target Kind: class of electron-builder/out/targets/dmg
Extends: Target
Properties

Name Type
options = this.packager.config.dmg undefined | null | DmgOptions

dmgTarget.build(appPath, arch) ⇒ Promise<void> Kind: instance method of DmgTarget

Param Type
appPath String
arch Arch

dmgTarget.computeDmgOptions() ⇒ Promise<DmgOptions> Kind: instance method of DmgTarget

dmgTarget.computeVolumeName(custom) ⇒ String Kind: instance method of DmgTarget

Param Type
custom String | null

electron-builder/out/targets/dmg.attachAndExecute(dmgPath, readWrite, task) ⇒ Promise<any> Kind: method of electron-builder/out/targets/dmg

Param Type
dmgPath String
readWrite Boolean
task callback

electron-builder/out/targets/fpm

FpmTarget ⇐ Target Kind: class of electron-builder/out/targets/fpm
Extends: Target
Properties

Name Type
options = Object.assign({}, this.packager.platformSpecificBuildOptions, (<any>this.packager.config)[this.name]) LinuxTargetSpecificOptions

fpmTarget.build(appOutDir, arch) ⇒ Promise<any> Kind: instance method of FpmTarget

Param Type
appOutDir String
arch Arch

electron-builder/out/targets/LinuxTargetHelper

LinuxTargetHelper Kind: class of electron-builder/out/targets/LinuxTargetHelper
Properties

Name Type
icons Promise<Array<Array<String>>>
maxIconPath String | null

linuxTargetHelper.computeDesktopEntry(targetSpecificOptions, exec, destination, extra) ⇒ Promise<String> Kind: instance method of LinuxTargetHelper

Param Type
targetSpecificOptions LinuxTargetSpecificOptions
exec String
destination String | null
extra Object<String, any>

linuxTargetHelper.getDescription(options) ⇒ String Kind: instance method of LinuxTargetHelper

Param Type
options LinuxBuildOptions

electron-builder/out/targets/nsis

AppPackageHelper Kind: class of electron-builder/out/targets/nsis

appPackageHelper.finishBuild() ⇒ Promise<any> Kind: instance method of AppPackageHelper

appPackageHelper.packArch(arch, target) ⇒ Promise<String> Kind: instance method of AppPackageHelper

Param Type
arch Arch
target NsisTarget

NsisTarget ⇐ Target Kind: class of electron-builder/out/targets/nsis
Extends: Target
Properties

Name Type
options NsisOptions

nsisTarget.build(appOutDir, arch) ⇒ Promise<void> Kind: instance method of NsisTarget

Param Type
appOutDir String
arch Arch

nsisTarget.finishBuild() ⇒ Promise<any> Kind: instance method of NsisTarget

electron-builder/out/targets/pkg

PkgTarget ⇐ Target Kind: class of electron-builder/out/targets/pkg
Extends: Target
Properties

Name Type
options = this.packager.config.pkg

pkgTarget.build(appPath, arch) ⇒ Promise<any> Kind: instance method of PkgTarget

Param Type
appPath String
arch Arch

electron-builder/out/targets/pkg.prepareProductBuildArgs(identity, keychain) ⇒ Array<String> Kind: method of electron-builder/out/targets/pkg

Param Type
identity String | undefined | null
keychain String | undefined | null

electron-builder/out/targets/snap

SnapTarget ⇐ Target Kind: class of electron-builder/out/targets/snap
Extends: Target
Properties

Name Type
options = Object.assign({}, this.packager.platformSpecificBuildOptions, (<any>this.packager.config)[this.name]) SnapOptions

snapTarget.build(appOutDir, arch) ⇒ Promise<any> Kind: instance method of SnapTarget

Param Type
appOutDir String
arch Arch

electron-builder/out/targets/targetFactory

NoOpTarget ⇐ Target Kind: class of electron-builder/out/targets/targetFactory
Extends: Target
Properties

Name Type
options null

noOpTarget.build(appOutDir, arch) ⇒ Promise<any> Kind: instance method of NoOpTarget

Param Type
appOutDir String
arch Arch

electron-builder/out/targets/targetFactory.computeArchToTargetNamesMap(raw, options, platform) ⇒ Map<Arch | Array<String>> Kind: method of electron-builder/out/targets/targetFactory

Param Type
raw Map<Arch | Array<String>>
options PlatformSpecificBuildOptions
platform Platform

electron-builder/out/targets/targetFactory.createCommonTarget(target, outDir, packager) ⇒ Target Kind: method of electron-builder/out/targets/targetFactory

Param Type
target String
outDir String
packager PlatformPackager<any>

electron-builder/out/targets/targetFactory.createTargets(nameToTarget, rawList, outDir, packager, cleanupTasks) ⇒ Array<Target> Kind: method of electron-builder/out/targets/targetFactory

Param Type
nameToTarget Map<String | Target>
rawList Array<String>
outDir String
packager PlatformPackager<any>
cleanupTasks Array<module:electron-builder/out/targets/targetFactory.__type>

electron-builder/out/targets/WebInstallerTarget

WebInstallerTarget ⇐ NsisTarget Kind: class of electron-builder/out/targets/WebInstallerTarget
Extends: NsisTarget

webInstallerTarget.build(appOutDir, arch) ⇒ Promise<void> Kind: instance method of WebInstallerTarget

Param Type
appOutDir String
arch Arch

webInstallerTarget.finishBuild() ⇒ Promise<any> Kind: instance method of WebInstallerTarget

electron-builder/out/util/readPackageJson

electron-builder/out/util/readPackageJson.doLoadConfig(configFile, projectDir) ⇒ Promise<any> Kind: method of electron-builder/out/util/readPackageJson

Param Type
configFile String
projectDir String

electron-builder/out/util/readPackageJson.getElectronVersion(config, projectDir, projectMetadata) ⇒ Promise<String> Kind: method of electron-builder/out/util/readPackageJson

Param Type
config Config | null | undefined
projectDir String
projectMetadata any | null

electron-builder/out/util/readPackageJson.loadConfig(projectDir) ⇒ Promise< | Config> Kind: method of electron-builder/out/util/readPackageJson

Param Type
projectDir String

electron-builder/out/util/readPackageJson.readPackageJson(file) ⇒ Promise<any> Kind: method of electron-builder/out/util/readPackageJson

Param Type
file String

electron-builder/out/util/readPackageJson.validateConfig(config) ⇒ Promise<void> Kind: method of electron-builder/out/util/readPackageJson

Param Type
config Config

electron-builder/out/windowsCodeSign

FileCodeSigningInfo Kind: interface of electron-builder/out/windowsCodeSign
Properties

Name Type
file String | null
password String | null
subjectName String | null
certificateSha1 String | null

SignOptions Kind: interface of electron-builder/out/windowsCodeSign
Properties

Name Type
path String
cert String | null
name String | null
password String | null
site String | null
options WinBuildOptions

electron-builder/out/windowsCodeSign.getSignVendorPath() ⇒ Promise<String> Kind: method of electron-builder/out/windowsCodeSign

electron-builder/out/windowsCodeSign.getToolPath() ⇒ Promise<String> Kind: method of electron-builder/out/windowsCodeSign

electron-builder/out/windowsCodeSign.sign(options) ⇒ Promise<void> Kind: method of electron-builder/out/windowsCodeSign

Param Type
options SignOptions

electron-builder/out/winPackager

WinPackager ⇐ PlatformPackager Kind: class of electron-builder/out/winPackager
Extends: PlatformPackager
Properties

Name Type
**[cscInfo=new Lazy<FileCodeSigningInfo null>(() => { 
const platformSpecificBuildOptions = this.platformSpecificBuildOptions
const subjectName = platformSpecificBuildOptions.certificateSubjectName
if (subjectName != null) {
  return BluebirdPromise.resolve({subjectName})
}

const certificateSha1 = platformSpecificBuildOptions.certificateSha1
if (certificateSha1 != null) {
  return BluebirdPromise.resolve({certificateSha1})
}

const certificateFile = platformSpecificBuildOptions.certificateFile
if (certificateFile != null) {
  const certificatePassword = this.getCscPassword()
  return BluebirdPromise.resolve({
    file: certificateFile,
    password: certificatePassword == null ? null : certificatePassword.trim(),
  })
}
else {
  const cscLink = process.env.WIN_CSC_LINK || this.packagerOptions.cscLink
  if (cscLink != null) {
    return downloadCertificate(cscLink, this.info.tempDirManager, this.projectDir)
      .then(path =&gt; {
        return {
          file: path,
          password: this.getCscPassword(),
        }
      })
  }
  else {
    return BluebirdPromise.resolve(null)
  }
}

})]**| Lazy< | FileCodeSigningInfo> | | **[computedPublisherName=new Lazy<Array<string> | null>(async () => { let publisherName = (<WinBuildOptions>this.platformSpecificBuildOptions).publisherName if (publisherName === null) { return null }

const cscInfo = await this.cscInfo.value
if (cscInfo == null) {
  return null
}

if (publisherName == null &amp;&amp; cscInfo.file != null) {
  try {
    // https://github.com/digitalbazaar/forge/issues/338#issuecomment-164831585
    const p12Asn1 = forge.asn1.fromDer(await readFile(cscInfo.file, &quot;binary&quot;), false)
    const p12 = (&lt;any&gt;forge).pkcs12.pkcs12FromAsn1(p12Asn1, false, cscInfo.password)
    const bagType = (&lt;any&gt;forge.pki.oids).certBag
    publisherName = p12.getBags({bagType: bagType})[bagType][0].cert.subject.getField(&quot;CN&quot;).value
  }
  catch (e) {
    throw new Error(&#x60;Cannot extract publisher name from code signing certificate, please file issue. As workaround, set win.publisherName: ${e.stack || e}&#x60;)
  }
}

return publisherName == null ? null : asArray(publisherName)

})]**| Lazy< | Array> |

winPackager.createTargets(targets, mapper, cleanupTasks) Kind: instance method of WinPackager
Overrides: createTargets

Param Type
targets Array<String>
mapper callback
cleanupTasks Array<module:electron-builder/out/winPackager.__type>

winPackager.getIconPath() ⇒ Promise<String> Kind: instance method of WinPackager
Overrides: getIconPath

winPackager.sign(file, logMessagePrefix) ⇒ Promise<void> Kind: instance method of WinPackager

Param Type
file String
logMessagePrefix String

winPackager.signAndEditResources(file) ⇒ Promise<void> Kind: instance method of WinPackager

Param Type
file String

winPackager.getDefaultIcon(ext) ⇒ Promise< | String> Kind: instance method of WinPackager

Param Type
ext String

winPackager.dispatchArtifactCreated(file, target, arch, safeArtifactName) Kind: instance method of WinPackager

Param Type
file String
target Target | null
arch Arch | null
safeArtifactName String

winPackager.getElectronDestDir(appOutDir) ⇒ String Kind: instance method of WinPackager

Param Type
appOutDir String

winPackager.getElectronSrcDir(dist) ⇒ String Kind: instance method of WinPackager

Param Type
dist String

winPackager.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern) ⇒ String Kind: instance method of WinPackager

Param Type
targetSpecificOptions TargetSpecificOptions | undefined | null
ext String
arch Arch | null
defaultPattern String

winPackager.expandMacro(pattern, arch, extra) ⇒ String Kind: instance method of WinPackager

Param Type
pattern String
arch String | undefined | null
extra any

winPackager.generateName(ext, arch, deployment, classifier) ⇒ String Kind: instance method of WinPackager

Param Type
ext String | null
arch Arch
deployment Boolean
classifier String | null

winPackager.generateName2(ext, classifier, deployment) ⇒ String Kind: instance method of WinPackager

Param Type
ext String | null
classifier String | undefined | null
deployment Boolean

winPackager.getMacOsResourcesDir(appOutDir) ⇒ String Kind: instance method of WinPackager

Param Type
appOutDir String

winPackager.pack(outDir, arch, targets, postAsyncTasks) ⇒ Promise<any> Kind: instance method of WinPackager

Param Type
outDir String
arch Arch
targets Array<Target>
postAsyncTasks Array<Promise<any>>

winPackager.getResource(custom, names) ⇒ Promise< | String> Kind: instance method of WinPackager

Param Type
custom String | undefined | null
names Array<String>

winPackager.getResourcesDir(appOutDir) ⇒ String Kind: instance method of WinPackager

Param Type
appOutDir String

winPackager.getTempFile(suffix) ⇒ Promise<String> Kind: instance method of WinPackager

Param Type
suffix String
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment