From 5d1ea39ed3f75abd8aec068562169f0ee7c3ba4e Mon Sep 17 00:00:00 2001 From: Mike Maietta Date: Sun, 26 Nov 2023 22:56:21 -0800 Subject: [PATCH] adding notarize options to the mas config --- docs/api/electron-builder.md | 10936 ++-------------- docs/configuration/mac.md | 16 +- docs/configuration/publish.md | 19 + packages/app-builder-lib/src/index.ts | 4 +- .../app-builder-lib/src/options/macOptions.ts | 7 +- scripts/jsdoc2md2html.js | 27 +- 6 files changed, 1028 insertions(+), 9981 deletions(-) diff --git a/docs/api/electron-builder.md b/docs/api/electron-builder.md index 419315cb4b5..c4b58be092d 100644 --- a/docs/api/electron-builder.md +++ b/docs/api/electron-builder.md @@ -3,225 +3,16 @@ Developer API only. See [Configuration](../configuration/configuration.md) for u

Modules

-
electron-builder/out/builder
-
electron-builder
-
app-builder-lib/out/appInfo
-
-
app-builder-lib/out/asar/asar
-
-
app-builder-lib/out/asar/integrity
-
-
app-builder-lib/out/asar/unpackDetector
-
-
app-builder-lib/out/binDownload
-
-
app-builder-lib/out/codeSign/macCodeSign
-
-
app-builder-lib/out/codeSign/windowsCodeSign
-
-
app-builder-lib/out/electron/ElectronFramework
-
-
app-builder-lib/out/electron/electronVersion
-
-
app-builder-lib/out/electron/injectFFMPEG
-
-
app-builder-lib/out/fileMatcher
-
-
app-builder-lib/out/Framework
-
-
app-builder-lib/out/frameworks/LibUiFramework
-
-
app-builder-lib/out/linuxPackager
-
-
app-builder-lib/out/macPackager
-
-
app-builder-lib/out/options/CommonWindowsInstallerConfiguration
-
-
app-builder-lib/out/options/macOptions
-
-
app-builder-lib/out/options/SnapOptions
-
-
app-builder-lib/out/platformPackager
-
-
app-builder-lib/out/ProtonFramework
-
-
app-builder-lib/out/publish/BitbucketPublisher
-
-
app-builder-lib/out/publish/KeygenPublisher
-
-
app-builder-lib/out/publish/PublishManager
-
-
app-builder-lib/out/publish/s3/BaseS3Publisher
-
-
app-builder-lib/out/publish/s3/s3Publisher
-
-
app-builder-lib/out/publish/s3/spacesPublisher
-
-
app-builder-lib/out/publish/SnapStorePublisher
-
-
app-builder-lib/out/publish/updateInfoBuilder
-
-
app-builder-lib/out/targets/AppImageTarget
-
-
app-builder-lib/out/targets/AppxTarget
-
-
app-builder-lib/out/targets/archive
-
-
app-builder-lib/out/targets/ArchiveTarget
-
-
app-builder-lib/out/targets/differentialUpdateInfoBuilder
-
-
app-builder-lib/out/targets/FlatpakTarget
-
-
app-builder-lib/out/targets/FpmTarget
-
-
app-builder-lib/out/targets/LinuxTargetHelper
-
-
app-builder-lib/out/targets/MsiTarget
-
-
app-builder-lib/out/targets/MsiWrappedTarget
-
-
app-builder-lib/out/targets/nsis/nsisLang
-
-
app-builder-lib/out/targets/nsis/nsisLicense
-
-
app-builder-lib/out/targets/nsis/nsisScriptGenerator
-
-
app-builder-lib/out/targets/nsis/NsisTarget
-
-
app-builder-lib/out/targets/nsis/nsisUtil
-
-
app-builder-lib/out/targets/pkg
-
-
app-builder-lib/out/targets/snap
-
-
app-builder-lib/out/targets/targetFactory
-
-
app-builder-lib/out/targets/targetUtil
-
-
app-builder-lib/out/targets/tools
-
-
app-builder-lib/out/util/appBuilder
-
-
app-builder-lib/out/util/appFileCopier
-
-
app-builder-lib/out/util/AppFileWalker
-
-
app-builder-lib/out/util/bundledTool
-
-
app-builder-lib/out/util/cacheManager
-
-
app-builder-lib/out/util/config
-
-
app-builder-lib/out/util/filename
-
-
app-builder-lib/out/util/flags
-
-
app-builder-lib/out/util/hash
-
-
app-builder-lib/out/util/langs
-
-
app-builder-lib/out/util/license
-
-
app-builder-lib/out/util/macosVersion
-
-
app-builder-lib/out/util/macroExpander
-
-
app-builder-lib/out/util/normalizePackageData
-
-
app-builder-lib/out/util/packageDependencies
-
-
app-builder-lib/out/util/pathManager
-
-
app-builder-lib/out/util/repositoryInfo
-
-
app-builder-lib/out/util/timer
-
-
app-builder-lib/out/util/yarn
-
-
app-builder-lib/out/vm/MonoVm
-
-
app-builder-lib/out/vm/ParallelsVm
-
-
app-builder-lib/out/vm/vm
-
-
app-builder-lib/out/vm/WineVm
-
-
app-builder-lib/out/winPackager
-
app-builder-lib
-
dmg-builder/out/dmgLicense
-
-
dmg-builder/out/licenseButtons
-
-
dmg-builder/out/licenseDefaultButtons
-
-
dmg-builder
-
-
electron-publish/out/gitHubPublisher
-
-
electron-publish/out/multiProgress
-
-
electron-publish/out/progress
-
electron-publish
-
electron-updater/out/AppAdapter
-
-
electron-updater/out/AppUpdater
-
-
electron-updater/out/BaseUpdater
-
-
electron-updater/out/differentialDownloader/DataSplitter
-
-
electron-updater/out/differentialDownloader/DifferentialDownloader
-
-
electron-updater/out/differentialDownloader/downloadPlanBuilder
-
-
electron-updater/out/differentialDownloader/FileWithEmbeddedBlockMapDifferentialDownloader
-
-
electron-updater/out/differentialDownloader/GenericDifferentialDownloader
-
-
electron-updater/out/differentialDownloader/multipleRangeDownloader
-
-
electron-updater/out/differentialDownloader/ProgressDifferentialDownloadCallbackTransform
-
-
electron-updater/out/DownloadedUpdateHelper
-
-
electron-updater/out/ElectronAppAdapter
-
-
electron-updater/out/electronHttpExecutor
-
-
electron-updater/out/providerFactory
-
-
electron-updater/out/providers/BitbucketProvider
-
-
electron-updater/out/providers/GenericProvider
-
-
electron-updater/out/providers/GitHubProvider
-
-
electron-updater/out/providers/KeygenProvider
-
-
electron-updater/out/providers/PrivateGitHubProvider
-
-
electron-updater/out/providers/Provider
-
-
electron-updater/out/util
-
-
electron-updater/out/windowsExecutableCodeSignatureVerifier
-
electron-updater
-

-

electron-builder/out/builder

-

-

electron-builder/out/builder.createYargs() ⇒ yargs:Argv

-

Kind: method of electron-builder/out/builder
-

+

electron-builder

-

-

LinuxPackager ⇐ PlatformPackager

-

Kind: class of app-builder-lib/out/linuxPackager
-Extends: PlatformPackager
+

+

publishManager.awaitTasks() ⇒ Promise<void>

+

+

publishManager.cancelTasks()

+

+

publishManager.getGlobalPublishConfigurations() ⇒ Promise< | Array>

+

+

Target

+

Kind: class of app-builder-lib
Properties

Methods

-

-

linuxPackager.createTargets(targets, mapper)

-

Overrides: createTargets

+

+

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

@@ -1425,17 +1214,20 @@ Developer API only. See [Configuration](../configuration/configuration.md) for u - - + + - - + +
targetsArray<String>appOutDirString
mappercallbackarchArch
-

-

linuxPackager.artifactPatternConfig(targetSpecificOptions, defaultPattern) ⇒ module:app-builder-lib/out/platformPackager.__object

+

+

target.finishBuild() ⇒ Promise<any>

+

+

app-builder-lib.build(options, packager) ⇒ Promise<Array<String>>

+

Kind: method of app-builder-lib

@@ -1445,17 +1237,18 @@ Developer API only. See [Configuration](../configuration/configuration.md) for u - - + + - - + +
targetSpecificOptionsTargetSpecificOptions | “undefined” | undefinedoptionsPackagerOptions | module:packages/electron-publish/out/publisher.PublishOptions
defaultPatternString | undefinedpackagerPackager
-

-

linuxPackager.computeSafeArtifactName(suggestedName, ext, arch, skipDefaultArch, defaultArch, safePattern) ⇒ null | String

+

+

app-builder-lib.buildForge(forgeOptions, options) ⇒ Promise<Array<String>>

+

Kind: method of app-builder-lib

@@ -1465,8856 +1258,77 @@ Developer API only. See [Configuration](../configuration/configuration.md) for u - - - - - - - - - - - - - - - - - - + + - - + +
suggestedNameString | “undefined”
extString
archArch | “undefined”
skipDefaultArch
defaultArchStringforgeOptionsForgeOptions
safePatternoptionsPackagerOptions
-

-

linuxPackager.getDefaultFrameworkIcon() ⇒ null | String

-

-

linuxPackager.dispatchArtifactCreated(file, target, arch, safeArtifactName) ⇒ Promise<void>

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
fileString
targetTarget | “undefined”
archArch | “undefined”
safeArtifactNameString | “undefined”
-

-

linuxPackager.getElectronDestinationDir(appOutDir) ⇒ String

- - - - - - - - - - - - - -
ParamType
appOutDirString
-

-

linuxPackager.getElectronSrcDir(dist) ⇒ String

- - - - - - - - - - - - - -
ParamType
distString
-

-

linuxPackager.expandArtifactBeautyNamePattern(targetSpecificOptions, ext, arch) ⇒ String

- - - - - - - - - - - - - - - - - - - - - -
ParamType
targetSpecificOptionsTargetSpecificOptions | “undefined” | undefined
extString
archArch | “undefined”
-

-

linuxPackager.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern, skipDefaultArch, defaultArch) ⇒ String

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
targetSpecificOptionsTargetSpecificOptions | “undefined” | undefined
extString
archArch | “undefined”
defaultPatternString
skipDefaultArch
defaultArchString
-

-

linuxPackager.expandMacro(pattern, arch, extra, isProductNameSanitized) ⇒ String

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
patternString
archString | “undefined”
extraany
isProductNameSanitized
-

-

linuxPackager.generateName2(ext, classifier, deployment) ⇒ String

- - - - - - - - - - - - - - - - - - - - - -
ParamType
extString | “undefined”
classifierString | “undefined” | undefined
deploymentBoolean
-

-

linuxPackager.getIconPath() ⇒ Promise< | String>

-

-

linuxPackager.getMacOsResourcesDir(appOutDir) ⇒ String

- - - - - - - - - - - - - -
ParamType
appOutDirString
-

-

linuxPackager.pack(outDir, arch, targets, taskManager) ⇒ Promise<any>

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
outDirString
archArch
targetsArray<Target>
taskManagerAsyncTaskManager
-

-

linuxPackager.resolveIcon(sources, fallbackSources, outputFormat) ⇒ Promise<Array<IconInfo>>

- - - - - - - - - - - - - - - - - - - - - -
ParamType
sourcesArray<String>
fallbackSourcesArray<String>
outputFormat“set” | “icns” | “ico”
-

-

linuxPackager.getResource(custom, names) ⇒ Promise< | String>

- - - - - - - - - - - - - - - - - -
ParamType
customString | “undefined” | undefined
namesArray<String>
-

-

linuxPackager.getResourcesDir(appOutDir) ⇒ String

- - - - - - - - - - - - - -
ParamType
appOutDirString
-

-

linuxPackager.getTempFile(suffix) ⇒ Promise<String>

- - - - - - - - - - - - - -
ParamType
suffixString
-

-

app-builder-lib/out/linuxPackager.toAppImageOrSnapArch(arch) ⇒ String

-

Kind: method of app-builder-lib/out/linuxPackager

- - - - - - - - - - - - - -
ParamType
archArch
-

-

app-builder-lib/out/macPackager

- -

-

MacPackager ⇐ PlatformPackager

-

Kind: class of app-builder-lib/out/macPackager
-Extends: PlatformPackager
-Properties

- -

Methods

- -

-

macPackager.applyCommonInfo(appPlist, contentsPath) ⇒ Promise<void>

- - - - - - - - - - - - - - - - - -
ParamType
appPlistany
contentsPathString
-

-

macPackager.createTargets(targets, mapper)

-

Overrides: createTargets

- - - - - - - - - - - - - - - - - -
ParamType
targetsArray<String>
mappercallback
-

-

macPackager.getElectronDestinationDir(appOutDir) ⇒ String

-

Overrides: getElectronDestinationDir

- - - - - - - - - - - - - -
ParamType
appOutDirString
-

-

macPackager.getElectronSrcDir(dist) ⇒ String

-

Overrides: getElectronSrcDir

- - - - - - - - - - - - - -
ParamType
distString
-

-

macPackager.getIconPath() ⇒ Promise< | String>

-

Overrides: getIconPath
-

-

macPackager.pack(outDir, arch, targets, taskManager) ⇒ Promise<void>

-

Overrides: pack

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
outDirString
archArch
targetsArray<Target>
taskManagerAsyncTaskManager
-

-

macPackager.artifactPatternConfig(targetSpecificOptions, defaultPattern) ⇒ module:app-builder-lib/out/platformPackager.__object

- - - - - - - - - - - - - - - - - -
ParamType
targetSpecificOptionsTargetSpecificOptions | “undefined” | undefined
defaultPatternString | undefined
-

-

macPackager.computeSafeArtifactName(suggestedName, ext, arch, skipDefaultArch, defaultArch, safePattern) ⇒ null | String

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
suggestedNameString | “undefined”
extString
archArch | “undefined”
skipDefaultArch
defaultArchString
safePattern
-

-

macPackager.getDefaultFrameworkIcon() ⇒ null | String

-

-

macPackager.dispatchArtifactCreated(file, target, arch, safeArtifactName) ⇒ Promise<void>

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
fileString
targetTarget | “undefined”
archArch | “undefined”
safeArtifactNameString | “undefined”
-

-

macPackager.expandArtifactBeautyNamePattern(targetSpecificOptions, ext, arch) ⇒ String

- - - - - - - - - - - - - - - - - - - - - -
ParamType
targetSpecificOptionsTargetSpecificOptions | “undefined” | undefined
extString
archArch | “undefined”
-

-

macPackager.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern, skipDefaultArch, defaultArch) ⇒ String

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
targetSpecificOptionsTargetSpecificOptions | “undefined” | undefined
extString
archArch | “undefined”
defaultPatternString
skipDefaultArch
defaultArchString
-

-

macPackager.expandMacro(pattern, arch, extra, isProductNameSanitized) ⇒ String

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
patternString
archString | “undefined”
extraany
isProductNameSanitized
-

-

macPackager.generateName2(ext, classifier, deployment) ⇒ String

- - - - - - - - - - - - - - - - - - - - - -
ParamType
extString | “undefined”
classifierString | “undefined” | undefined
deploymentBoolean
-

-

macPackager.getMacOsResourcesDir(appOutDir) ⇒ String

- - - - - - - - - - - - - -
ParamType
appOutDirString
-

-

macPackager.resolveIcon(sources, fallbackSources, outputFormat) ⇒ Promise<Array<IconInfo>>

- - - - - - - - - - - - - - - - - - - - - -
ParamType
sourcesArray<String>
fallbackSourcesArray<String>
outputFormat“set” | “icns” | “ico”
-

-

macPackager.getResource(custom, names) ⇒ Promise< | String>

- - - - - - - - - - - - - - - - - -
ParamType
customString | “undefined” | undefined
namesArray<String>
-

-

macPackager.getResourcesDir(appOutDir) ⇒ String

- - - - - - - - - - - - - -
ParamType
appOutDirString
-

-

macPackager.getTempFile(suffix) ⇒ Promise<String>

- - - - - - - - - - - - - -
ParamType
suffixString
-

-

app-builder-lib/out/options/CommonWindowsInstallerConfiguration

-

-

app-builder-lib/out/options/CommonWindowsInstallerConfiguration.DesktopShortcutCreationPolicy : enum

-

Kind: enum of app-builder-lib/out/options/CommonWindowsInstallerConfiguration
-Properties

- -

-

app-builder-lib/out/options/macOptions

-

-

app-builder-lib/out/options/SnapOptions

- -

-

PlugDescriptor

-

Kind: interface of app-builder-lib/out/options/SnapOptions
-

-

SlotDescriptor

-

Kind: interface of app-builder-lib/out/options/SnapOptions
-

-

app-builder-lib/out/platformPackager

- -

-

IconInfo

-

Kind: interface of app-builder-lib/out/platformPackager
-Properties

- -

-

app-builder-lib/out/platformPackager.chooseNotNull(v1, v2) ⇒ undefined | null | String

-

Kind: method of app-builder-lib/out/platformPackager

- - - - - - - - - - - - - - - - - -
ParamType
v1String | “undefined” | undefined
v2String | “undefined” | undefined
-

-

app-builder-lib/out/platformPackager.computeSafeArtifactNameIfNeeded(suggestedName, safeNameProducer) ⇒ null | String

-

Kind: method of app-builder-lib/out/platformPackager

- - - - - - - - - - - - - - - - - -
ParamType
suggestedNameString | “undefined”
safeNameProducercallback
-

-

app-builder-lib/out/platformPackager.isSafeGithubName(name) ⇒ Boolean

-

Kind: method of app-builder-lib/out/platformPackager

- - - - - - - - - - - - - -
ParamType
nameString
-

-

app-builder-lib/out/platformPackager.normalizeExt(ext) ⇒ String

-

Kind: method of app-builder-lib/out/platformPackager

- - - - - - - - - - - - - -
ParamType
extString
-

-

app-builder-lib/out/platformPackager.resolveFunction(executor, name) ⇒ module:app-builder-lib/out/platformPackager.T

-

Kind: method of app-builder-lib/out/platformPackager

- - - - - - - - - - - - - - - - - -
ParamType
executormodule:app-builder-lib/out/platformPackager.T | String
nameString
-

-

app-builder-lib/out/ProtonFramework

- -

-

ProtonFramework ⇐ LibUiFramework

-

Kind: class of app-builder-lib/out/ProtonFramework
-Extends: LibUiFramework
-Properties

- -

Methods

- -

-

protonFramework.createTransformer() ⇒ null | module:packages/builder-util/out/fs.__type

-

Overrides: createTransformer
-

-

protonFramework.getDefaultIcon(platform) ⇒ String

-

Overrides: getDefaultIcon

- - - - - - - - - - - - - -
ParamType
platformPlatform
-

-

protonFramework.afterPack(context) ⇒ Promise<void>

- - - - - - - - - - - - - -
ParamType
contextmodule:app-builder-lib/out/configuration.PackContext
-

-

protonFramework.getExcludedDependencies(platform) ⇒ null | Array

- - - - - - - - - - - - - -
ParamType
platformPlatform
-

-

protonFramework.getMainFile(platform) ⇒ null | String

- - - - - - - - - - - - - -
ParamType
platformPlatform
-

-

protonFramework.prepareApplicationStageDirectory(options) ⇒ Promise<void>

- - - - - - - - - - - - - -
ParamType
optionsPrepareApplicationStageDirectoryOptions
-

-

protonFramework.beforeCopyExtraFiles(options) ⇒ Promise<any>

- - - - - - - - - - - - - -
ParamType
optionsBeforeCopyExtraFilesOptions
-

-

app-builder-lib/out/publish/BitbucketPublisher

- -

-

BitbucketPublisher ⇐ HttpPublisher

-

Kind: class of app-builder-lib/out/publish/BitbucketPublisher
-Extends: HttpPublisher
-Properties

- -

Methods

- -

-

bitbucketPublisher.convertAppPassword(username, token) ⇒ String

- - - - - - - - - - - - - - - - - -
ParamType
usernameString
tokenString
-

-

bitbucketPublisher.deleteRelease(filename) ⇒ Promise<void>

- - - - - - - - - - - - - -
ParamType
filenameString
-

-

bitbucketPublisher.toString() ⇒ String

-

-

app-builder-lib/out/publish/KeygenPublisher

- -

-

KeygenArtifact

-

Kind: interface of app-builder-lib/out/publish/KeygenPublisher
-Properties

- -

-

KeygenError

-

Kind: interface of app-builder-lib/out/publish/KeygenPublisher
-Properties

- -

-

KeygenRelease

-

Kind: interface of app-builder-lib/out/publish/KeygenPublisher
-Properties

- -

-

KeygenPublisher ⇐ HttpPublisher

-

Kind: class of app-builder-lib/out/publish/KeygenPublisher
-Extends: HttpPublisher
-Properties

- -

Methods

- -

-

keygenPublisher.deleteRelease(releaseId) ⇒ Promise<void>

- - - - - - - - - - - - - -
ParamType
releaseIdString
-

-

keygenPublisher.toString() ⇒ String

-

-

app-builder-lib/out/publish/PublishManager

- -

-

app-builder-lib/out/publish/PublishManager.computeDownloadUrl(publishConfiguration, fileName, packager) ⇒ String

-

Kind: method of app-builder-lib/out/publish/PublishManager

- - - - - - - - - - - - - - - - - - - - - -
ParamType
publishConfigurationPublishConfiguration
fileNameString | “undefined”
packagerPlatformPackager<any>
-

-

app-builder-lib/out/publish/PublishManager.createPublisher(context, version, publishConfig, options, packager) ⇒ null | Publisher

-

Kind: method of app-builder-lib/out/publish/PublishManager

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
contextmodule:packages/electron-publish/out/publisher.PublishContext
versionString
publishConfigPublishConfiguration
optionsmodule:packages/electron-publish/out/publisher.PublishOptions
packagerPackager
-

-

app-builder-lib/out/publish/PublishManager.getPublishConfigs(platformPackager, targetSpecificOptions, arch, errorIfCannot) ⇒ Promise< | Array>

-

Kind: method of app-builder-lib/out/publish/PublishManager

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
platformPackagerPlatformPackager<any>
targetSpecificOptionsPlatformSpecificBuildOptions | “undefined” | undefined
archArch | “undefined”
errorIfCannotBoolean
-

-

app-builder-lib/out/publish/PublishManager.getPublishConfigsForUpdateInfo(packager, publishConfigs, arch) ⇒ Promise< | Array>

-

Kind: method of app-builder-lib/out/publish/PublishManager

- - - - - - - - - - - - - - - - - - - - - -
ParamType
packagerPlatformPackager<any>
publishConfigsArray<PublishConfiguration> | “undefined”
archArch | “undefined”
-

-

app-builder-lib/out/publish/s3/BaseS3Publisher

- -

-

BaseS3Publisher ⇐ Publisher

-

Kind: class of app-builder-lib/out/publish/s3/BaseS3Publisher
-Extends: Publisher

- -

-

baseS3Publisher.toString() ⇒ String

-

-

baseS3Publisher.upload(task) ⇒ Promise<any>

- - - - - - - - - - - - - -
ParamType
taskmodule:packages/electron-publish/out/publisher.UploadTask
-

-

app-builder-lib/out/publish/s3/s3Publisher

- -

-

S3Publisher ⇐ BaseS3Publisher

-

Kind: class of app-builder-lib/out/publish/s3/s3Publisher
-Extends: BaseS3Publisher
-Properties

- -

Methods

- -

-

s3Publisher.toString() ⇒ String

-

Overrides: toString
-

-

s3Publisher.upload(task) ⇒ Promise<any>

- - - - - - - - - - - - - -
ParamType
taskmodule:packages/electron-publish/out/publisher.UploadTask
-

-

app-builder-lib/out/publish/s3/spacesPublisher

- -

-

SpacesPublisher ⇐ BaseS3Publisher

-

Kind: class of app-builder-lib/out/publish/s3/spacesPublisher
-Extends: BaseS3Publisher
-Properties

- -

Methods

- -

-

spacesPublisher.toString() ⇒ String

-

-

spacesPublisher.upload(task) ⇒ Promise<any>

- - - - - - - - - - - - - -
ParamType
taskmodule:packages/electron-publish/out/publisher.UploadTask
-

-

app-builder-lib/out/publish/SnapStorePublisher

- -

-

SnapStorePublisher ⇐ Publisher

-

Kind: class of app-builder-lib/out/publish/SnapStorePublisher
-Extends: Publisher
-Properties

- -

Methods

- -

-

snapStorePublisher.toString() ⇒ String

-

-

snapStorePublisher.upload(task) ⇒ Promise<any>

- - - - - - - - - - - - - -
ParamType
taskmodule:packages/electron-publish/out/publisher.UploadTask
-

-

app-builder-lib/out/publish/updateInfoBuilder

- -

-

UpdateInfoFileTask

-

Kind: interface of app-builder-lib/out/publish/updateInfoBuilder
-Properties

- -

-

app-builder-lib/out/publish/updateInfoBuilder.writeUpdateInfoFiles(updateInfoFileTasks, packager) ⇒ Promise<void>

-

Kind: method of app-builder-lib/out/publish/updateInfoBuilder

- - - - - - - - - - - - - - - - - -
ParamType
updateInfoFileTasksArray<UpdateInfoFileTask>
packagerPackager
-

-

app-builder-lib/out/targets/AppImageTarget

- -

-

AppImageTarget ⇐ Target

-

Kind: class of app-builder-lib/out/targets/AppImageTarget
-Extends: Target
-Properties

- -

Methods

- -

-

appImageTarget.build(appOutDir, arch) ⇒ Promise<any>

-

Overrides: build

- - - - - - - - - - - - - - - - - -
ParamType
appOutDirString
archArch
-

-

appImageTarget.finishBuild() ⇒ Promise<any>

-

-

app-builder-lib/out/targets/AppxTarget

- -

-

AppXTarget ⇐ Target

-

Kind: class of app-builder-lib/out/targets/AppxTarget
-Extends: Target
-Properties

- -

Methods

- -

-

appXTarget.build(appOutDir, arch) ⇒ Promise<any>

-

Overrides: build

- - - - - - - - - - - - - - - - - -
ParamType
appOutDirString
archArch
-

-

appXTarget.finishBuild() ⇒ Promise<any>

-

-

app-builder-lib/out/targets/archive

- -

-

app-builder-lib/out/targets/archive.archive(format, outFile, dirToArchive, options) ⇒ Promise<String>

-

Kind: method of app-builder-lib/out/targets/archive

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
formatString
outFileString
dirToArchiveString
optionsArchiveOptions
-

-

app-builder-lib/out/targets/archive.compute7zCompressArgs(format, options) ⇒ Array<String>

-

Kind: method of app-builder-lib/out/targets/archive

- - - - - - - - - - - - - - - - - -
ParamType
formatString
optionsArchiveOptions
-

-

app-builder-lib/out/targets/ArchiveTarget

- -

-

ArchiveTarget ⇐ Target

-

Kind: class of app-builder-lib/out/targets/ArchiveTarget
-Extends: Target
-Properties

- -

Methods

- -

-

archiveTarget.build(appOutDir, arch) ⇒ Promise<any>

-

Overrides: build

- - - - - - - - - - - - - - - - - -
ParamType
appOutDirString
archArch
-

-

archiveTarget.finishBuild() ⇒ Promise<any>

-

-

app-builder-lib/out/targets/differentialUpdateInfoBuilder

- -

-

app-builder-lib/out/targets/differentialUpdateInfoBuilder.appendBlockmap(file) ⇒ Promise<module:builder-util-runtime.BlockMapDataHolder>

-

Kind: method of app-builder-lib/out/targets/differentialUpdateInfoBuilder

- - - - - - - - - - - - - -
ParamType
fileString
-

-

app-builder-lib/out/targets/differentialUpdateInfoBuilder.createBlockmap(file, target, packager, safeArtifactName) ⇒ Promise<module:builder-util-runtime.BlockMapDataHolder>

-

Kind: method of app-builder-lib/out/targets/differentialUpdateInfoBuilder

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
fileString
targetTarget
packagerPlatformPackager<any>
safeArtifactNameString | “undefined”
-

-

app-builder-lib/out/targets/differentialUpdateInfoBuilder.createNsisWebDifferentialUpdateInfo(artifactPath, packageFiles) ⇒ null | module:app-builder-lib/out/targets/differentialUpdateInfoBuilder.__object

-

Kind: method of app-builder-lib/out/targets/differentialUpdateInfoBuilder

- - - - - - - - - - - - - - - - - -
ParamType
artifactPathString
packageFilesObject<String, any>
-

-

app-builder-lib/out/targets/FlatpakTarget

- -

-

FlatpakTarget ⇐ Target

-

Kind: class of app-builder-lib/out/targets/FlatpakTarget
-Extends: Target
-Properties

- -

Methods

- -

-

flatpakTarget.build(appOutDir, arch) ⇒ Promise<any>

-

Overrides: build

- - - - - - - - - - - - - - - - - -
ParamType
appOutDirString
archArch
-

-

flatpakTarget.finishBuild() ⇒ Promise<any>

-

-

app-builder-lib/out/targets/FpmTarget

- -

-

FpmTarget ⇐ Target

-

Kind: class of app-builder-lib/out/targets/FpmTarget
-Extends: Target
-Properties

- -

Methods

- -

-

fpmTarget.build(appOutDir, arch) ⇒ Promise<any>

-

Overrides: build

- - - - - - - - - - - - - - - - - -
ParamType
appOutDirString
archArch
-

-

fpmTarget.finishBuild() ⇒ Promise<any>

-

-

app-builder-lib/out/targets/LinuxTargetHelper

- -

-

LinuxTargetHelper

-

Kind: class of app-builder-lib/out/targets/LinuxTargetHelper
-Properties

- -

Methods

- -

-

linuxTargetHelper.computeDesktopEntry(targetSpecificOptions, exec, extra) ⇒ Promise<String>

- - - - - - - - - - - - - - - - - - - - - -
ParamType
targetSpecificOptionsLinuxTargetSpecificOptions
execString
extraObject<String, any>
-

-

linuxTargetHelper.getDescription(options) ⇒ String

- - - - - - - - - - - - - -
ParamType
optionsLinuxTargetSpecificOptions
-

-

linuxTargetHelper.getSanitizedVersion(target) ⇒ String

- - - - - - - - - - - - - -
ParamType
targetString
-

-

linuxTargetHelper.writeDesktopEntry(targetSpecificOptions, exec, destination, extra) ⇒ Promise<String>

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
targetSpecificOptionsLinuxTargetSpecificOptions
execString
destinationString | “undefined”
extraObject<String, any>
-

-

app-builder-lib/out/targets/MsiTarget

- -

-

MsiTarget ⇐ Target

-

Kind: class of app-builder-lib/out/targets/MsiTarget
-Extends: Target
-Properties

- -

Methods

- -

-

msiTarget.build(appOutDir, arch) ⇒ Promise<void>

-

Overrides: build

- - - - - - - - - - - - - - - - - -
ParamType
appOutDirString
archArch
-

-

msiTarget.finishBuild() ⇒ Promise<any>

-

-

app-builder-lib/out/targets/MsiWrappedTarget

- -

-

MsiWrappedTarget ⇐ module:app-builder-lib/out/targets/MsiTarget.default

-

Kind: class of app-builder-lib/out/targets/MsiWrappedTarget
-Extends: module:app-builder-lib/out/targets/MsiTarget.default
-Properties

- -

Methods

- -

-

msiWrappedTarget.build(appOutDir, arch) ⇒ Promise<any>

- - - - - - - - - - - - - - - - - -
ParamType
appOutDirString
archArch
-

-

msiWrappedTarget.finishBuild() ⇒ Promise<any>

-

-

app-builder-lib/out/targets/nsis/nsisLang

- -

-

LangConfigurator

-

Kind: class of app-builder-lib/out/targets/nsis/nsisLang
-Properties

- -

-

app-builder-lib/out/targets/nsis/nsisLang.addCustomMessageFileInclude(input, packager, scriptGenerator, langConfigurator) ⇒ Promise<void>

-

Kind: method of app-builder-lib/out/targets/nsis/nsisLang

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
inputString
packagerPlatformPackager<any>
scriptGeneratorNsisScriptGenerator
langConfiguratorLangConfigurator
-

-

app-builder-lib/out/targets/nsis/nsisLang.createAddLangsMacro(scriptGenerator, langConfigurator)

-

Kind: method of app-builder-lib/out/targets/nsis/nsisLang

- - - - - - - - - - - - - - - - - -
ParamType
scriptGeneratorNsisScriptGenerator
langConfiguratorLangConfigurator
-

-

app-builder-lib/out/targets/nsis/nsisLicense

-

-

app-builder-lib/out/targets/nsis/nsisLicense.computeLicensePage(packager, options, scriptGenerator, languages) ⇒ Promise<void>

-

Kind: method of app-builder-lib/out/targets/nsis/nsisLicense

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
packagerWinPackager
optionsNsisOptions
scriptGeneratorNsisScriptGenerator
languagesArray<String>
-

-

app-builder-lib/out/targets/nsis/nsisScriptGenerator

- -

-

NsisScriptGenerator

-

Kind: class of app-builder-lib/out/targets/nsis/nsisScriptGenerator

- -

-

nsisScriptGenerator.addIncludeDir(file)

- - - - - - - - - - - - - -
ParamType
fileString
-

-

nsisScriptGenerator.addPluginDir(pluginArch, dir)

- - - - - - - - - - - - - - - - - -
ParamType
pluginArchString
dirString
-

-

nsisScriptGenerator.build() ⇒ String

-

-

nsisScriptGenerator.file(outputName, file)

- - - - - - - - - - - - - - - - - -
ParamType
outputNameString | “undefined”
fileString
-

-

nsisScriptGenerator.flags(flags)

- - - - - - - - - - - - - -
ParamType
flagsArray<String>
-

-

nsisScriptGenerator.include(file)

- - - - - - - - - - - - - -
ParamType
fileString
-

-

nsisScriptGenerator.insertMacro(name, parameters)

- - - - - - - - - - - - - - - - - -
ParamType
nameString
parametersString
-

-

nsisScriptGenerator.macro(name, lines)

- - - - - - - - - - - - - - - - - -
ParamType
nameString
linesArray<String> | NsisScriptGenerator
-

-

app-builder-lib/out/targets/nsis/NsisTarget

- -

-

NsisTarget ⇐ Target

-

Kind: class of app-builder-lib/out/targets/nsis/NsisTarget
-Extends: Target
-Properties

- -

Methods

- -

-

nsisTarget.build(appOutDir, arch) ⇒ Promise<void>

-

Overrides: build

- - - - - - - - - - - - - - - - - -
ParamType
appOutDirString
archArch
-

-

nsisTarget.finishBuild() ⇒ Promise<any>

-

Overrides: finishBuild
-

-

app-builder-lib/out/targets/nsis/nsisUtil

- -

-

PackArchResult

-

Kind: interface of app-builder-lib/out/targets/nsis/nsisUtil
-Properties

- -

-

AppPackageHelper

-

Kind: class of app-builder-lib/out/targets/nsis/nsisUtil

- -

-

appPackageHelper.finishBuild() ⇒ Promise<any>

-

-

appPackageHelper.packArch(arch, target) ⇒ Promise<PackArchResult>

- - - - - - - - - - - - - - - - - -
ParamType
archArch
targetNsisTarget
-

-

CopyElevateHelper

-

Kind: class of app-builder-lib/out/targets/nsis/nsisUtil
-

-

copyElevateHelper.copy(appOutDir, target) ⇒ Promise<any>

- - - - - - - - - - - - - - - - - -
ParamType
appOutDirString
targetNsisTarget
-

-

UninstallerReader

-

Kind: class of app-builder-lib/out/targets/nsis/nsisUtil
-

-

uninstallerReader.exec(installerPath, uninstallerPath) ⇒ Promise<void>

- - - - - - - - - - - - - - - - - -
ParamType
installerPathString
uninstallerPathString
-

-

app-builder-lib/out/targets/pkg

- -

-

PkgTarget ⇐ Target

-

Kind: class of app-builder-lib/out/targets/pkg
-Extends: Target
-Properties

- -

Methods

- -

-

pkgTarget.build(appPath, arch) ⇒ Promise<any>

-

Overrides: build

- - - - - - - - - - - - - - - - - -
ParamType
appPathString
archArch
-

-

pkgTarget.finishBuild() ⇒ Promise<any>

-

-

app-builder-lib/out/targets/pkg.prepareProductBuildArgs(identity, keychain) ⇒ Array<String>

-

Kind: method of app-builder-lib/out/targets/pkg

- - - - - - - - - - - - - - - - - -
ParamType
identityIdentity | “undefined”
keychainString | “undefined” | undefined
-

-

app-builder-lib/out/targets/snap

- -

-

SnapTarget ⇐ Target

-

Kind: class of app-builder-lib/out/targets/snap
-Extends: Target
-Properties

- -

Methods

- -

-

snapTarget.build(appOutDir, arch) ⇒ Promise<any>

-

Overrides: build

- - - - - - - - - - - - - - - - - -
ParamType
appOutDirString
archArch
-

-

snapTarget.finishBuild() ⇒ Promise<any>

-

-

app-builder-lib/out/targets/targetFactory

- -

-

NoOpTarget ⇐ Target

-

Kind: class of app-builder-lib/out/targets/targetFactory
-Extends: Target
-Properties

- -

Methods

- -

-

noOpTarget.build(appOutDir, arch) ⇒ Promise<any>

-

Overrides: build

- - - - - - - - - - - - - - - - - -
ParamType
appOutDirString
archArch
-

-

noOpTarget.finishBuild() ⇒ Promise<any>

-

-

app-builder-lib/out/targets/targetFactory.computeArchToTargetNamesMap(raw, platformPackager, platform) ⇒ Map<Arch | Array<String>>

-

Kind: method of app-builder-lib/out/targets/targetFactory

- - - - - - - - - - - - - - - - - - - - - -
ParamType
rawMap<Arch | Array<String>>
platformPackagerPlatformPackager<any>
platformPlatform
-

-

app-builder-lib/out/targets/targetFactory.createCommonTarget(target, outDir, packager) ⇒ Target

-

Kind: method of app-builder-lib/out/targets/targetFactory

- - - - - - - - - - - - - - - - - - - - - -
ParamType
targetString
outDirString
packagerPlatformPackager<any>
-

-

app-builder-lib/out/targets/targetFactory.createTargets(nameToTarget, rawList, outDir, packager) ⇒ Array<Target>

-

Kind: method of app-builder-lib/out/targets/targetFactory

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
nameToTargetMap<String | Target>
rawListArray<String>
outDirString
packagerPlatformPackager<any>
-

-

app-builder-lib/out/targets/targetUtil

- -

-

StageDir

-

Kind: class of app-builder-lib/out/targets/targetUtil

- -

-

stageDir.cleanup() ⇒ Promise<void>

-

-

stageDir.getTempFile(name) ⇒ String

- - - - - - - - - - - - - -
ParamType
nameString
-

-

stageDir.toString() ⇒ String

-

-

app-builder-lib/out/targets/targetUtil.createStageDir(target, packager, arch) ⇒ Promise<StageDir>

-

Kind: method of app-builder-lib/out/targets/targetUtil

- - - - - - - - - - - - - - - - - - - - - -
ParamType
targetTarget
packagerPlatformPackager<any>
archArch
-

-

app-builder-lib/out/targets/targetUtil.createStageDirPath(target, packager, arch) ⇒ Promise<String>

-

Kind: method of app-builder-lib/out/targets/targetUtil

- - - - - - - - - - - - - - - - - - - - - -
ParamType
targetTarget
packagerPlatformPackager<any>
archArch
-

-

app-builder-lib/out/targets/targetUtil.getWindowsInstallationAppPackageName(appName) ⇒ String

-

Kind: method of app-builder-lib/out/targets/targetUtil

- - - - - - - - - - - - - -
ParamType
appNameString
-

-

app-builder-lib/out/targets/targetUtil.getWindowsInstallationDirName(appInfo, isTryToUseProductName) ⇒ String

-

Kind: method of app-builder-lib/out/targets/targetUtil

- - - - - - - - - - - - - - - - - -
ParamType
appInfoAppInfo
isTryToUseProductNameBoolean
-

-

app-builder-lib/out/targets/tools

-

-

app-builder-lib/out/targets/tools.getLinuxToolsPath() ⇒ Promise<String>

-

Kind: method of app-builder-lib/out/targets/tools
-

-

app-builder-lib/out/util/appBuilder

- -

-

app-builder-lib/out/util/appBuilder.executeAppBuilderAndWriteJson(args, data, extraOptions) ⇒ Promise<String>

-

Kind: method of app-builder-lib/out/util/appBuilder

- - - - - - - - - - - - - - - - - - - - - -
ParamType
argsArray<String>
dataany
extraOptionsmodule:child_process.SpawnOptions
-

-

app-builder-lib/out/util/appBuilder.executeAppBuilderAsJson(args) ⇒ Promise<module:app-builder-lib/out/util/appBuilder.T>

-

Kind: method of app-builder-lib/out/util/appBuilder

- - - - - - - - - - - - - -
ParamType
argsArray<String>
-

-

app-builder-lib/out/util/appBuilder.objectToArgs(to, argNameToValue)

-

Kind: method of app-builder-lib/out/util/appBuilder

- - - - - - - - - - - - - - - - - -
ParamType
toArray<String>
argNameToValueObject<String, any>
-

-

app-builder-lib/out/util/appFileCopier

- -

-

ResolvedFileSet

-

Kind: interface of app-builder-lib/out/util/appFileCopier
-Properties

- -

-

app-builder-lib/out/util/appFileCopier.computeFileSets(matchers, transformer, platformPackager, isElectronCompile) ⇒ Promise<Array<ResolvedFileSet>>

-

Kind: method of app-builder-lib/out/util/appFileCopier

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
matchersArray<module:app-builder-lib/out/fileMatcher.FileMatcher>
transformermodule:packages/builder-util/out/fs.__type | “undefined”
platformPackagerPlatformPackager<any>
isElectronCompileBoolean
-

-

app-builder-lib/out/util/appFileCopier.copyAppFiles(fileSet, packager, transformer) ⇒ Promise<void>

-

Kind: method of app-builder-lib/out/util/appFileCopier

- - - - - - - - - - - - - - - - - - - - - -
ParamType
fileSetResolvedFileSet
packagerPackager
transformermodule:packages/builder-util/out/fs.__type
-

-

app-builder-lib/out/util/appFileCopier.getDestinationPath(file, fileSet) ⇒ String

-

Kind: method of app-builder-lib/out/util/appFileCopier

- - - - - - - - - - - - - - - - - -
ParamType
fileString
fileSetResolvedFileSet
-

-

app-builder-lib/out/util/appFileCopier.transformFiles(transformer, fileSet) ⇒ Promise<void>

-

Kind: method of app-builder-lib/out/util/appFileCopier

- - - - - - - - - - - - - - - - - -
ParamType
transformermodule:packages/builder-util/out/fs.__type
fileSetResolvedFileSet
-

-

app-builder-lib/out/util/AppFileWalker

-

-

FileCopyHelper

-

Kind: class of app-builder-lib/out/util/AppFileWalker
-Properties

- -

-

app-builder-lib/out/util/bundledTool

- -

-

ToolInfo

-

Kind: interface of app-builder-lib/out/util/bundledTool
-Properties

- -

-

app-builder-lib/out/util/bundledTool.computeEnv(oldValue, newValues) ⇒ String

-

Kind: method of app-builder-lib/out/util/bundledTool

- - - - - - - - - - - - - - - - - -
ParamType
oldValueString | “undefined” | undefined
newValuesArray<String>
-

-

app-builder-lib/out/util/bundledTool.computeToolEnv(libPath) ⇒ any

-

Kind: method of app-builder-lib/out/util/bundledTool

- - - - - - - - - - - - - -
ParamType
libPathArray<String>
-

-

app-builder-lib/out/util/cacheManager

- -

-

BuildCacheInfo

-

Kind: interface of app-builder-lib/out/util/cacheManager
-Properties

- -

-

BuildCacheManager

-

Kind: class of app-builder-lib/out/util/cacheManager
-Properties

- -

Methods

- -

-

buildCacheManager.copyIfValid(digest) ⇒ Promise<Boolean>

- - - - - - - - - - - - - -
ParamType
digestString
-

-

buildCacheManager.save() ⇒ Promise<void>

-

-

app-builder-lib/out/util/cacheManager.digest(hash, files) ⇒ Promise<String>

-

Kind: method of app-builder-lib/out/util/cacheManager

- - - - - - - - - - - - - - - - - -
ParamType
hashmodule:crypto.Hash
filesArray<String>
-

-

app-builder-lib/out/util/config

- -

-

app-builder-lib/out/util/config.computeDefaultAppDirectory(projectDir, userAppDir) ⇒ Promise<String>

-

Kind: method of app-builder-lib/out/util/config

- - - - - - - - - - - - - - - - - -
ParamType
projectDirString
userAppDirString | “undefined” | undefined
-

-

app-builder-lib/out/util/config.doMergeConfigs(configs) ⇒ Configuration

-

doMergeConfigs takes configs in the order you would pass them to -Object.assign as sources.

-

Kind: method of app-builder-lib/out/util/config

- - - - - - - - - - - - - -
ParamType
configsArray<Configuration>
-

-

app-builder-lib/out/util/config.getConfig(projectDir, configPath, configFromOptions, packageMetadata) ⇒ Promise<Configuration>

-

Kind: method of app-builder-lib/out/util/config

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
projectDirString
configPathString | “undefined”
configFromOptionsConfiguration | “undefined” | undefined
packageMetadataLazy< | module:app-builder-lib/out/util/config.__type>
-

-

app-builder-lib/out/util/config.validateConfig(config, debugLogger) ⇒ Promise<void>

-

Kind: method of app-builder-lib/out/util/config

- - - - - - - - - - - - - - - - - -
ParamType
configConfiguration
debugLoggerDebugLogger
-

-

app-builder-lib/out/util/filename

- -

-

app-builder-lib/out/util/filename.getCompleteExtname(filename) ⇒ String

-

Kind: method of app-builder-lib/out/util/filename

- - - - - - - - - - - - - -
ParamType
filenameString
-

-

app-builder-lib/out/util/filename.sanitizeFileName(s) ⇒ String

-

Kind: method of app-builder-lib/out/util/filename

- - - - - - - - - - - - - -
ParamType
sString
-

-

app-builder-lib/out/util/flags

- -

-

app-builder-lib/out/util/flags.isAutoDiscoveryCodeSignIdentity() ⇒ Boolean

-

Kind: method of app-builder-lib/out/util/flags
-

-

app-builder-lib/out/util/flags.isBuildCacheEnabled() ⇒ Boolean

-

Kind: method of app-builder-lib/out/util/flags
-

-

app-builder-lib/out/util/flags.isUseSystemSigncode() ⇒ Boolean

-

Kind: method of app-builder-lib/out/util/flags
-

-

app-builder-lib/out/util/hash

-

-

app-builder-lib/out/util/hash.hashFile(file, algorithm, encoding, options) ⇒ Promise<String>

-

Kind: method of app-builder-lib/out/util/hash

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
fileString
algorithm
encoding“base64” | “hex”
optionsany
-

-

app-builder-lib/out/util/langs

- -

-

app-builder-lib/out/util/langs.lcid : any

-

Kind: constant of app-builder-lib/out/util/langs
-

-

app-builder-lib/out/util/langs.toLangWithRegion(lang) ⇒ String

-

Kind: method of app-builder-lib/out/util/langs

- - - - - - - - - - - - - -
ParamType
langString
-

-

app-builder-lib/out/util/license

- -

-

LicenseFile

-

Kind: interface of app-builder-lib/out/util/license
-Properties

- -

-

app-builder-lib/out/util/license.getLicenseAssets(fileNames, packager) ⇒ Array<module:app-builder-lib/out/util/license.__object>

-

Kind: method of app-builder-lib/out/util/license

- - - - - - - - - - - - - - - - - -
ParamType
fileNamesArray<String>
packagerPlatformPackager<any>
-

-

app-builder-lib/out/util/license.getLicenseFiles(packager) ⇒ Promise<Array<LicenseFile>>

-

Kind: method of app-builder-lib/out/util/license

- - - - - - - - - - - - - -
ParamType
packagerPlatformPackager<any>
-

-

app-builder-lib/out/util/license.getNotLocalizedLicenseFile(custom, packager, supportedExtension) ⇒ Promise< | String>

-

Kind: method of app-builder-lib/out/util/license

- - - - - - - - - - - - - - - - - - - - - -
ParamType
customString | “undefined” | undefined
packagerPlatformPackager<any>
supportedExtensionArray<String>
-

-

app-builder-lib/out/util/macosVersion

- -

-

app-builder-lib/out/util/macosVersion.isMacOsCatalina() ⇒ Boolean

-

Kind: method of app-builder-lib/out/util/macosVersion
-

-

app-builder-lib/out/util/macosVersion.isMacOsHighSierra() ⇒ Boolean

-

Kind: method of app-builder-lib/out/util/macosVersion
-

-

app-builder-lib/out/util/macosVersion.isMacOsSierra() ⇒ Promise<Boolean>

-

Kind: method of app-builder-lib/out/util/macosVersion
-

-

app-builder-lib/out/util/macroExpander

-

-

app-builder-lib/out/util/macroExpander.expandMacro(pattern, arch, appInfo, extra, isProductNameSanitized) ⇒ String

-

Kind: method of app-builder-lib/out/util/macroExpander

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
patternString
archString | “undefined” | undefined
appInfoAppInfo
extraany
isProductNameSanitized
-

-

app-builder-lib/out/util/normalizePackageData

-

-

app-builder-lib/out/util/normalizePackageData.normalizePackageData(data)

-

Kind: method of app-builder-lib/out/util/normalizePackageData

- - - - - - - - - - - - - -
ParamType
dataany
-

-

app-builder-lib/out/util/packageDependencies

- -

-

NodeModuleDirInfo

-

Kind: interface of app-builder-lib/out/util/packageDependencies
-Properties

- -

-

NodeModuleInfo

-

Kind: interface of app-builder-lib/out/util/packageDependencies
-Properties

- -

-

app-builder-lib/out/util/packageDependencies.createLazyProductionDeps(projectDir, excludedDependencies) ⇒ Lazy<Array<any>>

-

Kind: method of app-builder-lib/out/util/packageDependencies

- - - - - - - - - - - - - - - - - -
ParamType
projectDirString
excludedDependenciesArray<String> | “undefined”
-

-

app-builder-lib/out/util/pathManager

- -

-

app-builder-lib/out/util/pathManager.getTemplatePath(file) ⇒ String

-

Kind: method of app-builder-lib/out/util/pathManager

- - - - - - - - - - - - - -
ParamType
fileString
-

-

app-builder-lib/out/util/pathManager.getVendorPath(file) ⇒ String

-

Kind: method of app-builder-lib/out/util/pathManager

- - - - - - - - - - - - - -
ParamType
fileString
-

-

app-builder-lib/out/util/repositoryInfo

-

-

app-builder-lib/out/util/repositoryInfo.getRepositoryInfo(projectDir, metadata, devMetadata) ⇒ Promise< | SourceRepositoryInfo>

-

Kind: method of app-builder-lib/out/util/repositoryInfo

- - - - - - - - - - - - - - - - - - - - - -
ParamType
projectDirString
metadataMetadata
devMetadataMetadata | “undefined”
-

-

app-builder-lib/out/util/timer

- -

-

Timer

-

Kind: interface of app-builder-lib/out/util/timer
-

-

timer.end()

-

-

DevTimer ⇐ Timer

-

Kind: class of app-builder-lib/out/util/timer
-Extends: Timer

- -

-

devTimer.end()

-

Overrides: end
-

-

devTimer.endAndGet() ⇒ String

-

-

app-builder-lib/out/util/timer.time(label) ⇒ Timer

-

Kind: method of app-builder-lib/out/util/timer

- - - - - - - - - - - - - -
ParamType
labelString
-

-

app-builder-lib/out/util/yarn

- -

-

DesktopFrameworkInfo

-

Kind: interface of app-builder-lib/out/util/yarn
-Properties

- -

-

app-builder-lib/out/util/yarn.getGypEnv(frameworkInfo, platform, arch, buildFromSource) ⇒ any

-

Kind: method of app-builder-lib/out/util/yarn

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
frameworkInfoDesktopFrameworkInfo
platform“aix” | “android” | “darwin” | “freebsd” | “haiku” | “linux” | “openbsd” | “sunos” | “win32” | “cygwin” | “netbsd”
archString
buildFromSourceBoolean
-

-

app-builder-lib/out/util/yarn.installOrRebuild(config, appDir, options, forceInstall) ⇒ Promise<void>

-

Kind: method of app-builder-lib/out/util/yarn

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
configConfiguration
appDirString
optionsRebuildOptions
forceInstall
-

-

app-builder-lib/out/util/yarn.nodeGypRebuild(platform, arch, frameworkInfo) ⇒ Promise<void>

-

Kind: method of app-builder-lib/out/util/yarn

- - - - - - - - - - - - - - - - - - - - - -
ParamType
platform“aix” | “android” | “darwin” | “freebsd” | “haiku” | “linux” | “openbsd” | “sunos” | “win32” | “cygwin” | “netbsd”
archString
frameworkInfoDesktopFrameworkInfo
-

-

app-builder-lib/out/vm/MonoVm

- -

-

MonoVmManager ⇐ VmManager

-

Kind: class of app-builder-lib/out/vm/MonoVm
-Extends: VmManager

- -

-

monoVmManager.exec(file, args, options, isLogOutIfDebug) ⇒ Promise<String>

-

Overrides: exec

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
fileString
argsArray<String>
optionsmodule:child_process.ExecFileOptions
isLogOutIfDebug
-

-

monoVmManager.spawn(file, args, options, extraOptions) ⇒ Promise<any>

-

Overrides: spawn

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
fileString
argsArray<String>
optionsmodule:child_process.SpawnOptions
extraOptionsmodule:packages/builder-util/out/util.ExtraSpawnOptions
-

-

monoVmManager.toVmFile(file) ⇒ String

- - - - - - - - - - - - - -
ParamType
fileString
-

-

app-builder-lib/out/vm/ParallelsVm

- -

-

ParallelsVm

-

Kind: interface of app-builder-lib/out/vm/ParallelsVm
-Properties

- -

-

app-builder-lib/out/vm/ParallelsVm.macPathToParallelsWindows(file) ⇒ String

-

Kind: method of app-builder-lib/out/vm/ParallelsVm

- - - - - - - - - - - - - -
ParamType
fileString
-

-

app-builder-lib/out/vm/vm

- -

-

VmManager

-

Kind: class of app-builder-lib/out/vm/vm
-Properties

- -

Methods

- -

-

vmManager.exec(file, args, options, isLogOutIfDebug) ⇒ Promise<String>

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
fileString
argsArray<String>
optionsmodule:child_process.ExecFileOptions
isLogOutIfDebug
-

-

vmManager.spawn(file, args, options, extraOptions) ⇒ Promise<any>

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
fileString
argsArray<String>
optionsmodule:child_process.SpawnOptions
extraOptionsmodule:packages/builder-util/out/util.ExtraSpawnOptions
-

-

vmManager.toVmFile(file) ⇒ String

- - - - - - - - - - - - - -
ParamType
fileString
-

-

app-builder-lib/out/vm/vm.getWindowsVm(debugLogger) ⇒ Promise<VmManager>

-

Kind: method of app-builder-lib/out/vm/vm

- - - - - - - - - - - - - -
ParamType
debugLoggerDebugLogger
-

-

app-builder-lib/out/vm/WineVm

- -

-

WineVmManager ⇐ VmManager

-

Kind: class of app-builder-lib/out/vm/WineVm
-Extends: VmManager

- -

-

wineVmManager.exec(file, args, options, isLogOutIfDebug) ⇒ Promise<String>

-

Overrides: exec

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
fileString
argsArray<String>
optionsmodule:child_process.ExecFileOptions
isLogOutIfDebug
-

-

wineVmManager.spawn(file, args, options, extraOptions) ⇒ Promise<any>

-

Overrides: spawn

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
fileString
argsArray<String>
optionsmodule:child_process.SpawnOptions
extraOptionsmodule:packages/builder-util/out/util.ExtraSpawnOptions
-

-

wineVmManager.toVmFile(file) ⇒ String

-

Overrides: toVmFile

- - - - - - - - - - - - - -
ParamType
fileString
-

-

app-builder-lib/out/winPackager

- -

-

WinPackager ⇐ PlatformPackager

-

Kind: class of app-builder-lib/out/winPackager
-Extends: PlatformPackager
-Properties

- -

Methods

- -

-

winPackager.createTargets(targets, mapper)

-

Overrides: createTargets

- - - - - - - - - - - - - - - - - -
ParamType
targetsArray<String>
mappercallback
-

-

winPackager.getIconPath() ⇒ Promise< | String>

-

Overrides: getIconPath
-

-

winPackager.sign(file, logMessagePrefix) ⇒ Promise<Boolean>

- - - - - - - - - - - - - - - - - -
ParamType
fileString
logMessagePrefixString
-

-

winPackager.signAndEditResources(file, arch, outDir, internalName, requestedExecutionLevel) ⇒ Promise<void>

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
fileString
archArch
outDirString
internalNameString | “undefined”
requestedExecutionLevel“asInvoker” | “highestAvailable” | “requireAdministrator” | “undefined”
-

-

winPackager.artifactPatternConfig(targetSpecificOptions, defaultPattern) ⇒ module:app-builder-lib/out/platformPackager.__object

- - - - - - - - - - - - - - - - - -
ParamType
targetSpecificOptionsTargetSpecificOptions | “undefined” | undefined
defaultPatternString | undefined
-

-

winPackager.computeSafeArtifactName(suggestedName, ext, arch, skipDefaultArch, defaultArch, safePattern) ⇒ null | String

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
suggestedNameString | “undefined”
extString
archArch | “undefined”
skipDefaultArch
defaultArchString
safePattern
-

-

winPackager.getDefaultFrameworkIcon() ⇒ null | String

-

-

winPackager.dispatchArtifactCreated(file, target, arch, safeArtifactName) ⇒ Promise<void>

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
fileString
targetTarget | “undefined”
archArch | “undefined”
safeArtifactNameString | “undefined”
-

-

winPackager.getElectronDestinationDir(appOutDir) ⇒ String

- - - - - - - - - - - - - -
ParamType
appOutDirString
-

-

winPackager.getElectronSrcDir(dist) ⇒ String

- - - - - - - - - - - - - -
ParamType
distString
-

-

winPackager.expandArtifactBeautyNamePattern(targetSpecificOptions, ext, arch) ⇒ String

- - - - - - - - - - - - - - - - - - - - - -
ParamType
targetSpecificOptionsTargetSpecificOptions | “undefined” | undefined
extString
archArch | “undefined”
-

-

winPackager.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern, skipDefaultArch, defaultArch) ⇒ String

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
targetSpecificOptionsTargetSpecificOptions | “undefined” | undefined
extString
archArch | “undefined”
defaultPatternString
skipDefaultArch
defaultArchString
-

-

winPackager.expandMacro(pattern, arch, extra, isProductNameSanitized) ⇒ String

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
patternString
archString | “undefined”
extraany
isProductNameSanitized
-

-

winPackager.generateName2(ext, classifier, deployment) ⇒ String

- - - - - - - - - - - - - - - - - - - - - -
ParamType
extString | “undefined”
classifierString | “undefined” | undefined
deploymentBoolean
-

-

winPackager.getMacOsResourcesDir(appOutDir) ⇒ String

- - - - - - - - - - - - - -
ParamType
appOutDirString
-

-

winPackager.pack(outDir, arch, targets, taskManager) ⇒ Promise<any>

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
outDirString
archArch
targetsArray<Target>
taskManagerAsyncTaskManager
-

-

winPackager.resolveIcon(sources, fallbackSources, outputFormat) ⇒ Promise<Array<IconInfo>>

- - - - - - - - - - - - - - - - - - - - - -
ParamType
sourcesArray<String>
fallbackSourcesArray<String>
outputFormat“set” | “icns” | “ico”
-

-

winPackager.getResource(custom, names) ⇒ Promise< | String>

- - - - - - - - - - - - - - - - - -
ParamType
customString | “undefined” | undefined
namesArray<String>
-

-

winPackager.getResourcesDir(appOutDir) ⇒ String

- - - - - - - - - - - - - -
ParamType
appOutDirString
-

-

winPackager.getTempFile(suffix) ⇒ Promise<String>

- - - - - - - - - - - - - -
ParamType
suffixString
-

-

app-builder-lib

- -

-

ArtifactBuildStarted

-

Kind: interface of app-builder-lib
-Properties

- -

-

ArtifactCreated ⇐ module:packages/electron-publish/out/publisher.UploadTask

-

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

- -

-

BeforeBuildContext

-

Kind: interface of app-builder-lib
-Properties

- -

-

BuildResult

-

Kind: interface of app-builder-lib
-Properties

- -

-

CertificateFromStoreInfo

-

Kind: interface of app-builder-lib
-Properties

- -

-

FileCodeSigningInfo

-

Kind: interface of app-builder-lib
-Properties

- -

-

Framework

-

Kind: interface of app-builder-lib
-Properties

- -

Methods

- -

-

framework.afterPack(context) ⇒ Promise<any>

- - - - - - - - - - - - - -
ParamType
contextmodule:app-builder-lib/out/configuration.PackContext
-

-

framework.beforeCopyExtraFiles(options) ⇒ Promise<any>

- - - - - - - - - - - - - -
ParamType
optionsBeforeCopyExtraFilesOptions
-

-

framework.createTransformer() ⇒ null | module:packages/builder-util/out/fs.__type

-

-

framework.getDefaultIcon(platform) ⇒ null | String

- - - - - - - - - - - - - -
ParamType
platformPlatform
-

-

framework.getExcludedDependencies(platform) ⇒ null | Array

- - - - - - - - - - - - - -
ParamType
platformPlatform
-

-

framework.getMainFile(platform) ⇒ null | String

- - - - - - - - - - - - - -
ParamType
platformPlatform
-

-

framework.prepareApplicationStageDirectory(options) ⇒ Promise<any>

- - - - - - - - - - - - - -
ParamType
optionsPrepareApplicationStageDirectoryOptions
-

-

SourceRepositoryInfo

-

Kind: interface of app-builder-lib
-Properties

- -

-

AppInfo

-

Kind: class of app-builder-lib
-Properties

- -

Methods

- -

-

appInfo.computePackageUrl() ⇒ Promise< | String>

-

-

appInfo.getVersionInWeirdWindowsForm(isSetBuildNumber) ⇒ String

- - - - - - - - - - - -
Param
isSetBuildNumber
-

-

Packager

-

Kind: class of app-builder-lib
-Properties

- -

Methods

- -

-

packager._build(configuration, metadata, devMetadata, repositoryInfo) ⇒ Promise<BuildResult>

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
configurationConfiguration
metadataMetadata
devMetadataMetadata | “undefined”
repositoryInfoSourceRepositoryInfo
-

-

packager.addAfterPackHandler(handler)

- - - - - - - - - - - - - -
ParamType
handlercallback
-

-

packager.afterPack(context) ⇒ Promise<any>

- - - - - - - - - - - - - -
ParamType
contextmodule:app-builder-lib/out/configuration.PackContext
-

-

packager.artifactCreated(handler) ⇒ Packager

- - - - - - - - - - - - - -
ParamType
handlercallback
-

-

packager.build() ⇒ Promise<BuildResult>

-

-

packager.callAppxManifestCreated(path) ⇒ Promise<void>

- - - - - - - - - - - - - -
ParamType
pathString
-

-

packager.callArtifactBuildCompleted(event) ⇒ Promise<void>

- - - - - - - - - - - - - -
ParamType
eventArtifactCreated
-

-

packager.callArtifactBuildStarted(event, logFields) ⇒ Promise<void>

- - - - - - - - - - - - - - - - - -
ParamType
eventArtifactBuildStarted
logFieldsany
-

-

packager.callMsiProjectCreated(path) ⇒ Promise<void>

- - - - - - - - - - - - - -
ParamType
pathString
-

-

packager.dispatchArtifactCreated(event)

-

Only for sub artifacts (update info), for main artifacts use callArtifactBuildCompleted.

- - - - - - - - - - - - - -
ParamType
eventArtifactCreated
-

-

packager.disposeOnBuildFinish(disposer)

- - - - - - - - - - - - - -
ParamType
disposercallback
-

-

packager.installAppDependencies(platform, arch) ⇒ Promise<any>

- - - - - - - - - - - - - - - - - -
ParamType
platformPlatform
archArch
-

-

packager.getNodeDependencyInfo(platform) ⇒ Lazy<Array<NodeModuleDirInfo>>

- - - - - - - - - - - - - -
ParamType
platformPlatform | “undefined”
-

-

Platform

-

Kind: class of app-builder-lib
-Properties

- -

Methods

- -

-

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

- - - - - - - - - - - - - - - - - -
ParamType
typeString | Array<String> | “undefined”
archsArray<Arch>
-

-

platform.current() ⇒ Platform

-

-

platform.fromString(name) ⇒ Platform

- - - - - - - - - - - - - -
ParamType
nameString
-

-

platform.toString() ⇒ String

-

-

PlatformPackager

-

Kind: class of app-builder-lib
-Properties

- -

Methods

- -

-

platformPackager.artifactPatternConfig(targetSpecificOptions, defaultPattern) ⇒ module:app-builder-lib/out/platformPackager.__object

- - - - - - - - - - - - - - - - - -
ParamType
targetSpecificOptionsTargetSpecificOptions | “undefined” | undefined
defaultPatternString | undefined
-

-

platformPackager.computeSafeArtifactName(suggestedName, ext, arch, skipDefaultArch, defaultArch, safePattern) ⇒ null | String

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
suggestedNameString | “undefined”
extString
archArch | “undefined”
skipDefaultArch
defaultArchString
safePattern
-

-

platformPackager.createTargets(targets, mapper)

- - - - - - - - - - - - - - - - - -
ParamType
targetsArray<String>
mappercallback
-

-

platformPackager.getDefaultFrameworkIcon() ⇒ null | String

-

-

platformPackager.dispatchArtifactCreated(file, target, arch, safeArtifactName) ⇒ Promise<void>

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
fileString
targetTarget | “undefined”
archArch | “undefined”
safeArtifactNameString | “undefined”
-

-

platformPackager.getElectronDestinationDir(appOutDir) ⇒ String

- - - - - - - - - - - - - -
ParamType
appOutDirString
-

-

platformPackager.getElectronSrcDir(dist) ⇒ String

- - - - - - - - - - - - - -
ParamType
distString
-

-

platformPackager.expandArtifactBeautyNamePattern(targetSpecificOptions, ext, arch) ⇒ String

- - - - - - - - - - - - - - - - - - - - - -
ParamType
targetSpecificOptionsTargetSpecificOptions | “undefined” | undefined
extString
archArch | “undefined”
-

-

platformPackager.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern, skipDefaultArch, defaultArch) ⇒ String

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
targetSpecificOptionsTargetSpecificOptions | “undefined” | undefined
extString
archArch | “undefined”
defaultPatternString
skipDefaultArch
defaultArchString
-

-

platformPackager.expandMacro(pattern, arch, extra, isProductNameSanitized) ⇒ String

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
patternString
archString | “undefined”
extraany
isProductNameSanitized
-

-

platformPackager.generateName2(ext, classifier, deployment) ⇒ String

- - - - - - - - - - - - - - - - - - - - - -
ParamType
extString | “undefined”
classifierString | “undefined” | undefined
deploymentBoolean
-

-

platformPackager.getIconPath() ⇒ Promise< | String>

-

-

platformPackager.getMacOsResourcesDir(appOutDir) ⇒ String

- - - - - - - - - - - - - -
ParamType
appOutDirString
-

-

platformPackager.pack(outDir, arch, targets, taskManager) ⇒ Promise<any>

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
outDirString
archArch
targetsArray<Target>
taskManagerAsyncTaskManager
-

-

platformPackager.resolveIcon(sources, fallbackSources, outputFormat) ⇒ Promise<Array<IconInfo>>

- - - - - - - - - - - - - - - - - - - - - -
ParamType
sourcesArray<String>
fallbackSourcesArray<String>
outputFormat“set” | “icns” | “ico”
-

-

platformPackager.getResource(custom, names) ⇒ Promise< | String>

- - - - - - - - - - - - - - - - - -
ParamType
customString | “undefined” | undefined
namesArray<String>
-

-

platformPackager.getResourcesDir(appOutDir) ⇒ String

- - - - - - - - - - - - - -
ParamType
appOutDirString
-

-

platformPackager.getTempFile(suffix) ⇒ Promise<String>

- - - - - - - - - - - - - -
ParamType
suffixString
-

-

PublishManager ⇐ module:packages/electron-publish/out/publisher.PublishContext

-

Kind: class of app-builder-lib
-Extends: module:packages/electron-publish/out/publisher.PublishContext
-Properties

- -

Methods

- -

-

publishManager.awaitTasks() ⇒ Promise<void>

-

-

publishManager.cancelTasks()

-

-

publishManager.getGlobalPublishConfigurations() ⇒ Promise< | Array>

-

-

Target

-

Kind: class of app-builder-lib
-Properties

- -

Methods

- -

-

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

- - - - - - - - - - - - - - - - - -
ParamType
appOutDirString
archArch
-

-

target.finishBuild() ⇒ Promise<any>

-

-

app-builder-lib.build(options, packager) ⇒ Promise<Array<String>>

-

Kind: method of app-builder-lib

- - - - - - - - - - - - - - - - - -
ParamType
optionsPackagerOptions | module:packages/electron-publish/out/publisher.PublishOptions
packagerPackager
-

-

app-builder-lib.buildForge(forgeOptions, options) ⇒ Promise<Array<String>>

-

Kind: method of app-builder-lib

- - - - - - - - - - - - - - - - - -
ParamType
forgeOptionsForgeOptions
optionsPackagerOptions
-

-

dmg-builder/out/dmgLicense

-

-

dmg-builder/out/dmgLicense.addLicenseToDmg(packager, dmgPath) ⇒ Promise< | module:dmg-builder/out/dmgLicense.__type>

-

Kind: method of dmg-builder/out/dmgLicense

- - - - - - - - - - - - - - - - - -
ParamType
packagerPlatformPackager<any>
dmgPathString
-

-

dmg-builder/out/licenseButtons

- -

-

LicenseButtonsFile

-

Kind: interface of dmg-builder/out/licenseButtons
-Properties

- -

-

dmg-builder/out/licenseButtons.getLicenseButtons(licenseButtonFiles, langWithRegion, id, name) ⇒ Promise<String>

-

Kind: method of dmg-builder/out/licenseButtons

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
licenseButtonFilesArray<LicenseButtonsFile>
langWithRegionString
idNumber
nameString
-

-

dmg-builder/out/licenseButtons.getLicenseButtonsFile(packager) ⇒ Promise<Array<LicenseButtonsFile>>

-

Kind: method of dmg-builder/out/licenseButtons

- - - - - - - - - - - - - -
ParamType
packagerPlatformPackager<any>
-

-

dmg-builder/out/licenseDefaultButtons

-

-

dmg-builder/out/licenseDefaultButtons.getDefaultButtons(langWithRegion, id, name) ⇒ String

-

Kind: method of dmg-builder/out/licenseDefaultButtons

- - - - - - - - - - - - - - - - - - - - - -
ParamType
langWithRegionString
idNumber
nameString
-

-

dmg-builder

- -

-

dmg-builder.attachAndExecute(dmgPath, readWrite, task) ⇒ Promise<any>

-

Kind: method of dmg-builder

- - - - - - - - - - - - - - - - - - - - - -
ParamType
dmgPathString
readWriteBoolean
taskcallback
-

-

dmg-builder.computeBackground(packager) ⇒ Promise<String>

-

Kind: method of dmg-builder

- - - - - - - - - - - - - -
ParamType
packagerPlatformPackager<any>
-

-

dmg-builder.detach(name) ⇒ Promise<void>

-

Kind: method of dmg-builder

- - - - - - - - - - - - - -
ParamType
nameString
-

-

dmg-builder.getDmgTemplatePath() ⇒ String

-

Kind: method of dmg-builder
-

-

dmg-builder.getDmgVendorPath() ⇒ String

-

Kind: method of dmg-builder
-

-

electron-publish/out/gitHubPublisher

- -

-

Release

-

Kind: interface of electron-publish/out/gitHubPublisher
-Properties

- -

-

GitHubPublisher ⇐ HttpPublisher

-

Kind: class of electron-publish/out/gitHubPublisher
-Extends: HttpPublisher
-Properties

- -

Methods

- -

-

gitHubPublisher.deleteRelease() ⇒ Promise<any>

-

-

gitHubPublisher.getRelease() ⇒ Promise<any>

-

-

gitHubPublisher.toString() ⇒ String

-

-

gitHubPublisher.upload(task) ⇒ Promise<any>

- - - - - - - - - - - - - -
ParamType
taskUploadTask
-

-

electron-publish/out/multiProgress

- -

-

MultiProgress

-

Kind: class of electron-publish/out/multiProgress

- -

-

multiProgress.createBar(format, options) ⇒ ProgressBar

- - - - - - - - - - - - - - - - - -
ParamType
formatString
optionsany
-

-

multiProgress.terminate()

-

-

electron-publish/out/progress

- -

-

ProgressBar

-

Kind: class of electron-publish/out/progress
-Properties

- -

Methods

- -

-

progressBar.interrupt(message)

-

“interrupt” the progress bar and write a message above it.

- - - - - - - - - - - - - -
ParamType
messageString
-

-

progressBar.render()

-

-

progressBar.terminate()

-

-

progressBar.tick(delta)

-

“tick” the progress bar with optional len and optional tokens.

- - - - - - - - - - - - - -
ParamType
deltaNumber
-

-

progressBar.update(ratio)

-

“update” the progress bar to represent an exact percentage. -The ratio (between 0 and 1) specified will be multiplied by total and -floored, representing the closest available “tick.” For example, if a -progress bar has a length of 3 and update(0.5) is called, the progress -will be set to 1.

-

A ratio of 0.5 will attempt to set the progress to halfway.

- - - - - - - - - - - - - -
ParamType
ratioNumber
-

-

electron-publish

- -

-

PublishContext

-

Kind: interface of electron-publish
-Properties

- -

-

UploadTask

-

Kind: interface of electron-publish
-Properties

- -

-

HttpPublisher ⇐ Publisher

-

Kind: class of electron-publish
-Extends: Publisher

- -

-

httpPublisher.upload(task) ⇒ Promise<any>

-

Overrides: upload

- - - - - - - - - - - - - -
ParamType
taskUploadTask
-

-

httpPublisher.toString() ⇒ String

-

-

ProgressCallback

-

Kind: class of electron-publish
-

-

progressCallback.update(transferred, total)

- - - - - - - - - - - - - - - - - -
ParamType
transferredNumber
totalNumber
-

-

Publisher

-

Kind: class of electron-publish
-Properties

- -

Methods

- -

-

publisher.toString() ⇒ String

-

-

publisher.upload(task) ⇒ Promise<any>

- - - - - - - - - - - - - -
ParamType
taskUploadTask
-

-

electron-publish.getCiTag() ⇒ null | String

-

Kind: method of electron-publish
-

-

electron-updater/out/AppAdapter

- -

-

AppAdapter

-

Kind: interface of electron-updater/out/AppAdapter
-Properties

- -

Methods

- -

-

appAdapter.onQuit(handler)

- - - - - - - - - - - - - -
ParamType
handlercallback
-

-

appAdapter.quit()

-

-

appAdapter.relaunch()

-

-

appAdapter.whenReady() ⇒ Promise<void>

-

-

electron-updater/out/AppAdapter.getAppCacheDir() ⇒ String

-

Kind: method of electron-updater/out/AppAdapter
-

-

electron-updater/out/AppUpdater

- -

-

DownloadExecutorTask

-

Kind: interface of electron-updater/out/AppUpdater
-Properties

- -

-

DownloadNotification

-

Kind: interface of electron-updater/out/AppUpdater
-Properties

- -

-

UpdateInfoAndProvider

-

Kind: interface of electron-updater/out/AppUpdater
-Properties

- -

-

electron-updater/out/BaseUpdater

- -

-

BaseUpdater ⇐ AppUpdater

-

Kind: class of electron-updater/out/BaseUpdater
-Extends: AppUpdater

- -

-

baseUpdater.install(isSilent, isForceRunAfter) ⇒ Boolean

- - - - - - - - - - - - - - -
Param
isSilent
isForceRunAfter
-

-

baseUpdater.quitAndInstall(isSilent, isForceRunAfter)

-

Overrides: quitAndInstall

- - - - - - - - - - - - - - -
Param
isSilent
isForceRunAfter
-

-

baseUpdater.addAuthHeader(token)

-

Shortcut for explicitly adding auth tokens to request headers

- - - - - - - - - - - - - -
ParamType
tokenString
-

-

baseUpdater.checkForUpdates() ⇒ Promise< | UpdateCheckResult>

-

Asks the server whether there is an update.

-

-

baseUpdater.checkForUpdatesAndNotify(downloadNotification) ⇒ Promise< | UpdateCheckResult>

- - - - - - - - - - - - - -
ParamType
downloadNotificationDownloadNotification
-

-

baseUpdater.downloadUpdate(cancellationToken) ⇒ Promise<Array<String>>

-

Start downloading update manually. You can use this method if autoDownload option is set to false.

-

Returns: Promise<Array<String>> - Paths to downloaded files.

- - - - - - - - - - - - - -
ParamType
cancellationTokenCancellationToken
-

-

baseUpdater.getFeedURL() ⇒ undefined | null | String

-

-

baseUpdater.setFeedURL(options)

-

Configure update provider. If value is string, GenericServerOptions will be set with value as url.

- - - - - - - - - - - - - - - -
ParamTypeDescription
optionsPublishConfiguration | String | GithubOptions | S3Options | SpacesOptions | GenericServerOptions | module:builder-util-runtime/out/publishOptions.CustomPublishOptions | module:builder-util-runtime/out/publishOptions.KeygenOptions | SnapStoreOptions | module:builder-util-runtime/out/publishOptions.BitbucketOptions | StringIf you want to override configuration in the app-update.yml.
-

-

baseUpdater.isUpdaterActive() ⇒ Boolean

-

-

electron-updater/out/differentialDownloader/DataSplitter

- -

-

PartListDataTask

-

Kind: interface of electron-updater/out/differentialDownloader/DataSplitter
-Properties

- -

-

DataSplitter ⇐ internal:Writable

-

Kind: class of electron-updater/out/differentialDownloader/DataSplitter
-Extends: internal:Writable
-Properties

- -

Methods

-

dataSplitter._write(data, encoding, callback)

- - - - - - - - - - - - - - - - - - - - - -
ParamType
datamodule:global.Buffer
encodingString
callbackcallback
-

-

electron-updater/out/differentialDownloader/DataSplitter.copyData(task, out, oldFileFd, reject, resolve)

-

Kind: method of electron-updater/out/differentialDownloader/DataSplitter

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
taskOperation
outinternal:Writable
oldFileFdNumber
rejectcallback
resolvecallback
-

-

electron-updater/out/differentialDownloader/DifferentialDownloader

-

-

DifferentialDownloader

-

Kind: class of electron-updater/out/differentialDownloader/DifferentialDownloader
-Properties

- -

-

electron-updater/out/differentialDownloader/downloadPlanBuilder

- -

-

Operation

-

Kind: interface of electron-updater/out/differentialDownloader/downloadPlanBuilder
-Properties

- -

-

electron-updater/out/differentialDownloader/downloadPlanBuilder.OperationKind : enum

-

Kind: enum of electron-updater/out/differentialDownloader/downloadPlanBuilder
-Properties

- -

-

electron-updater/out/differentialDownloader/downloadPlanBuilder.computeOperations(oldBlockMap, newBlockMap, logger) ⇒ Array<Operation>

-

Kind: method of electron-updater/out/differentialDownloader/downloadPlanBuilder

- - - - - - - - - - - - - - - - - - - - - -
ParamType
oldBlockMapmodule:builder-util-runtime/out/blockMapApi.BlockMap
newBlockMapmodule:builder-util-runtime/out/blockMapApi.BlockMap
loggerLogger
-

-

electron-updater/out/differentialDownloader/FileWithEmbeddedBlockMapDifferentialDownloader

- -

-

FileWithEmbeddedBlockMapDifferentialDownloader ⇐ DifferentialDownloader

-

Kind: class of electron-updater/out/differentialDownloader/FileWithEmbeddedBlockMapDifferentialDownloader
-Extends: DifferentialDownloader
-

-

fileWithEmbeddedBlockMapDifferentialDownloader.download() ⇒ Promise<void>

-

-

electron-updater/out/differentialDownloader/GenericDifferentialDownloader

- -

-

GenericDifferentialDownloader ⇐ DifferentialDownloader

-

Kind: class of electron-updater/out/differentialDownloader/GenericDifferentialDownloader
-Extends: DifferentialDownloader
-

-

genericDifferentialDownloader.download(oldBlockMap, newBlockMap) ⇒ Promise<any>

- - - - - - - - - - - - - - - - - -
ParamType
oldBlockMapmodule:builder-util-runtime/out/blockMapApi.BlockMap
newBlockMapmodule:builder-util-runtime/out/blockMapApi.BlockMap
-

-

electron-updater/out/differentialDownloader/multipleRangeDownloader

- -

-

electron-updater/out/differentialDownloader/multipleRangeDownloader.checkIsRangesSupported(response, reject) ⇒ Boolean

-

Kind: method of electron-updater/out/differentialDownloader/multipleRangeDownloader

- - - - - - - - - - - - - - - - - -
ParamType
responsemodule:http.IncomingMessage
rejectcallback
-

-

electron-updater/out/differentialDownloader/multipleRangeDownloader.executeTasksUsingMultipleRangeRequests(differentialDownloader, tasks, out, oldFileFd, reject) ⇒ module:electron-updater/out/differentialDownloader/multipleRangeDownloader.__type

-

Kind: method of electron-updater/out/differentialDownloader/multipleRangeDownloader

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
differentialDownloaderDifferentialDownloader
tasksArray<Operation>
outinternal:Writable
oldFileFdNumber
rejectcallback
-

-

electron-updater/out/differentialDownloader/ProgressDifferentialDownloadCallbackTransform

- -

-

ProgressDifferentialDownloadInfo

-

Kind: interface of electron-updater/out/differentialDownloader/ProgressDifferentialDownloadCallbackTransform
-Properties

- -

-

ProgressInfo

-

Kind: interface of electron-updater/out/differentialDownloader/ProgressDifferentialDownloadCallbackTransform
-Properties

- -

-

ProgressDifferentialDownloadCallbackTransform ⇐ internal:Transform

-

Kind: class of electron-updater/out/differentialDownloader/ProgressDifferentialDownloadCallbackTransform
-Extends: internal:Transform

- -

-

progressDifferentialDownloadCallbackTransform._flush(callback)

- - - - - - - - - - - - - -
ParamType
callbackany
-

-

progressDifferentialDownloadCallbackTransform._transform(chunk, encoding, callback)

- - - - - - - - - - - - - - - - - - - - - -
ParamType
chunkany
encodingString
callbackany
-

-

progressDifferentialDownloadCallbackTransform.beginFileCopy()

-

-

progressDifferentialDownloadCallbackTransform.beginRangeDownload()

-

-

progressDifferentialDownloadCallbackTransform.endRangeDownload()

-

-

electron-updater/out/DownloadedUpdateHelper

-

-

electron-updater/out/DownloadedUpdateHelper.createTempUpdateFile(name, cacheDir, log) ⇒ Promise<String>

-

Kind: method of electron-updater/out/DownloadedUpdateHelper

- - - - - - - - - - - - - - - - - - - - - -
ParamType
nameString
cacheDirString
logLogger
-

-

electron-updater/out/ElectronAppAdapter

- -

-

ElectronAppAdapter ⇐ AppAdapter

-

Kind: class of electron-updater/out/ElectronAppAdapter
-Extends: AppAdapter
-Properties

- -

Methods

- -

-

electronAppAdapter.onQuit(handler)

-

Overrides: onQuit

- - - - - - - - - - - - - -
ParamType
handlercallback
-

-

electronAppAdapter.quit()

-

Overrides: quit
-

-

electronAppAdapter.relaunch()

-

Overrides: relaunch
-

-

electronAppAdapter.whenReady() ⇒ Promise<void>

-

Overrides: whenReady
-

-

electron-updater/out/electronHttpExecutor

- -

-

ElectronHttpExecutor ⇐ HttpExecutor

-

Kind: class of electron-updater/out/electronHttpExecutor
-Extends: HttpExecutor

- -

-

electronHttpExecutor.createRequest(options, callback) ⇒ Electron:ClientRequest

- - - - - - - - - - - - - - - - - -
ParamType
optionsany
callbackcallback
-

-

electronHttpExecutor.download(url, destination, options) ⇒ Promise<String>

- - - - - - - - - - - - - - - - - - - - - -
ParamType
urlURL
destinationString
optionsmodule:builder-util-runtime/out/httpExecutor.DownloadOptions
-

-

electron-updater/out/electronHttpExecutor.getNetSession() ⇒ Electron:Session

-

Kind: method of electron-updater/out/electronHttpExecutor
-

-

electron-updater/out/providerFactory

- -

-

electron-updater/out/providerFactory.createClient(data, updater, runtimeOptions) ⇒ Provider<any>

-

Kind: method of electron-updater/out/providerFactory

- - - - - - - - - - - - - - - - - - - - - -
ParamType
dataPublishConfiguration | String | GithubOptions | S3Options | SpacesOptions | GenericServerOptions | module:builder-util-runtime/out/publishOptions.CustomPublishOptions | module:builder-util-runtime/out/publishOptions.KeygenOptions | SnapStoreOptions | module:builder-util-runtime/out/publishOptions.BitbucketOptions
updaterAppUpdater
runtimeOptionsProviderRuntimeOptions
-

-

electron-updater/out/providerFactory.isUrlProbablySupportMultiRangeRequests(url) ⇒ Boolean

-

Kind: method of electron-updater/out/providerFactory

- - - - - - - - - - - - - -
ParamType
urlString
-

-

electron-updater/out/providers/BitbucketProvider

- -

-

BitbucketProvider ⇐ Provider

-

Kind: class of electron-updater/out/providers/BitbucketProvider
-Extends: Provider

- -

-

bitbucketProvider.getLatestVersion() ⇒ Promise<module:builder-util-runtime.UpdateInfo>

-

Overrides: getLatestVersion
-

-

bitbucketProvider.resolveFiles(updateInfo) ⇒ Array<ResolvedUpdateFileInfo>

-

Overrides: resolveFiles

- - - - - - - - - - - - - -
ParamType
updateInfomodule:builder-util-runtime.UpdateInfo
-

-

bitbucketProvider.toString() ⇒ String

-

-

bitbucketProvider.setRequestHeaders(value)

- - - - - - - - - - - - - -
ParamType
value[key: string]: string | “undefined”
-

-

electron-updater/out/providers/GenericProvider

- -

-

GenericProvider ⇐ Provider

-

Kind: class of electron-updater/out/providers/GenericProvider
-Extends: Provider

- -

-

genericProvider.getLatestVersion() ⇒ Promise<module:builder-util-runtime.UpdateInfo>

-

Overrides: getLatestVersion
-

-

genericProvider.resolveFiles(updateInfo) ⇒ Array<ResolvedUpdateFileInfo>

-

Overrides: resolveFiles

- - - - - - - - - - - - - -
ParamType
updateInfomodule:builder-util-runtime.UpdateInfo
-

-

genericProvider.setRequestHeaders(value)

- - - - - - - - - - - - - -
ParamType
value[key: string]: string | “undefined”
-

-

electron-updater/out/providers/GitHubProvider

- -

-

BaseGitHubProvider ⇐ Provider

-

Kind: class of electron-updater/out/providers/GitHubProvider
-Extends: Provider

- -

-

baseGitHubProvider.getLatestVersion() ⇒ Promise<module:electron-updater/out/providers/Provider.T>

-

-

baseGitHubProvider.setRequestHeaders(value)

- - - - - - - - - - - - - -
ParamType
value[key: string]: string | “undefined”
-

-

baseGitHubProvider.resolveFiles(updateInfo) ⇒ Array<ResolvedUpdateFileInfo>

- - - - - - - - - - - - - -
ParamType
updateInfomodule:electron-updater/out/providers/Provider.T
-

-

GitHubProvider ⇐ BaseGitHubProvider

-

Kind: class of electron-updater/out/providers/GitHubProvider
-Extends: BaseGitHubProvider

- -

-

gitHubProvider.getLatestVersion() ⇒ Promise<module:electron-updater/out/providers/GitHubProvider.GithubUpdateInfo>

-

Overrides: getLatestVersion
-

-

gitHubProvider.resolveFiles(updateInfo) ⇒ Array<ResolvedUpdateFileInfo>

-

Overrides: resolveFiles

- - - - - - - - - - - - - -
ParamType
updateInfomodule:electron-updater/out/providers/GitHubProvider.GithubUpdateInfo
-

-

gitHubProvider.setRequestHeaders(value)

- - - - - - - - - - - - - -
ParamType
value[key: string]: string | “undefined”
-

-

electron-updater/out/providers/GitHubProvider.computeReleaseNotes(currentVersion, isFullChangelog, feed, latestRelease) ⇒ null | String | Array

-

Kind: method of electron-updater/out/providers/GitHubProvider

- - - - - - - - - - - - - - - - - - - - - - - - - -
ParamType
currentVersionSemVer
isFullChangelogBoolean
feedXElement
latestReleaseany
-

-

electron-updater/out/providers/KeygenProvider

- -

-

KeygenProvider ⇐ Provider

-

Kind: class of electron-updater/out/providers/KeygenProvider
-Extends: Provider

- -

-

keygenProvider.getLatestVersion() ⇒ Promise<module:builder-util-runtime.UpdateInfo>

-

Overrides: getLatestVersion
-

-

keygenProvider.resolveFiles(updateInfo) ⇒ Array<ResolvedUpdateFileInfo>

-

Overrides: resolveFiles

- - - - - - - - - - - - - -
ParamType
updateInfomodule:builder-util-runtime.UpdateInfo
-

-

keygenProvider.toString() ⇒ String

-

-

keygenProvider.setRequestHeaders(value)

- - - - - - - - - - - - - -
ParamType
value[key: string]: string | “undefined”
-

-

electron-updater/out/providers/PrivateGitHubProvider

- -

-

Asset

-

Kind: interface of electron-updater/out/providers/PrivateGitHubProvider
-Properties

- -

-

PrivateGitHubUpdateInfo ⇐ module:builder-util-runtime.UpdateInfo

-

Kind: interface of electron-updater/out/providers/PrivateGitHubProvider
-Extends: module:builder-util-runtime.UpdateInfo
-Properties

- -

-

PrivateGitHubProvider ⇐ BaseGitHubProvider

-

Kind: class of electron-updater/out/providers/PrivateGitHubProvider
-Extends: BaseGitHubProvider
-Properties

- -

Methods

- -

-

privateGitHubProvider.getLatestVersion() ⇒ Promise<PrivateGitHubUpdateInfo>

-

Overrides: getLatestVersion
-

-

privateGitHubProvider.resolveFiles(updateInfo) ⇒ Array<ResolvedUpdateFileInfo>

-

Overrides: resolveFiles

- - - - - - - - - - - - - -
ParamType
updateInfoPrivateGitHubUpdateInfo
-

-

privateGitHubProvider.setRequestHeaders(value)

- - - - - - - - - - - - - -
ParamType
value[key: string]: string | “undefined”
-

-

electron-updater/out/providers/Provider

- -

-

electron-updater/out/providers/Provider.findFile(files, extension, not) ⇒ undefined | null | ResolvedUpdateFileInfo

-

Kind: method of electron-updater/out/providers/Provider

- - - - - - - - - - - - - - - - - - - - - -
ParamType
filesArray<ResolvedUpdateFileInfo>
extensionString
notArray<String>
-

-

electron-updater/out/providers/Provider.getFileList(updateInfo) ⇒ Array<module:builder-util-runtime.UpdateFileInfo>

-

Kind: method of electron-updater/out/providers/Provider

- - - - - - - - - - - - - -
ParamType
updateInfomodule:builder-util-runtime.UpdateInfo
-

-

electron-updater/out/providers/Provider.parseUpdateInfo(rawData, channelFile, channelFileUrl) ⇒ module:builder-util-runtime.UpdateInfo

-

Kind: method of electron-updater/out/providers/Provider

- - - - - - - - - - - - - - - - - - - - - -
ParamType
rawDataString | “undefined”
channelFileString
channelFileUrlmodule:url.URL
-

-

electron-updater/out/providers/Provider.resolveFiles(updateInfo, baseUrl, pathTransformer) ⇒ Array<ResolvedUpdateFileInfo>

-

Kind: method of electron-updater/out/providers/Provider

- - - - - - - - - - - - - - - - - - - - - -
ParamType
updateInfomodule:builder-util-runtime.UpdateInfo
baseUrlmodule:url.URL
pathTransformercallback
-

-

electron-updater/out/util

- -

-

electron-updater/out/util.blockmapFiles(baseUrl, oldVersion, newVersion) ⇒ Array<module:url.URL>

-

Kind: method of electron-updater/out/util

- - - - - - - - - - - - - - - - - - - - - -
ParamType
baseUrlmodule:url.URL
oldVersionString
newVersionString
-

-

electron-updater/out/util.getChannelFilename(channel) ⇒ String

-

Kind: method of electron-updater/out/util

- - - - - - - - - - - - - -
ParamType
channelString
-

-

electron-updater/out/util.newUrlFromBase(pathname, baseUrl, addRandomQueryToAvoidCaching) ⇒ module:url.URL

-

Kind: method of electron-updater/out/util

- - - - - - - - - - - - - - - - - - - - - -
ParamType
pathnameString
baseUrlmodule:url.URL
addRandomQueryToAvoidCaching
-

-

electron-updater/out/windowsExecutableCodeSignatureVerifier

-

-

electron-updater/out/windowsExecutableCodeSignatureVerifier.verifySignature(publisherNames, unescapedTempUpdateFile, logger) ⇒ Promise< | String>

-

Kind: method of electron-updater/out/windowsExecutableCodeSignatureVerifier

- - - - - - - - - - - - - - - - - - - - - -
ParamType
publisherNamesArray<String>
unescapedTempUpdateFileString
loggerLogger
-

-

electron-updater

- -

-

Logger

-

Kind: interface of electron-updater

- -

-

logger.debug(message)

- - - - - - - - - - - - - -
ParamType
messageString
-

-

logger.error(message)

- - - - - - - - - - - - - -
ParamType
messageany
-

-

logger.info(message)

- - - - - - - - - - - - - -
ParamType
messageany
-

-

logger.warn(message)

- - - - - - - - - - - - - -
ParamType
messageany
-

-

ResolvedUpdateFileInfo

-

Kind: interface of electron-updater
-Properties

- -

-

UpdateCheckResult

-

Kind: interface of electron-updater
-Properties

- -

-

UpdateDownloadedEvent ⇐ module:builder-util-runtime.UpdateInfo

-

Kind: interface of electron-updater
-Extends: module:builder-util-runtime.UpdateInfo
-Properties

+

+

electron-publish

-

-

AppImageUpdater ⇐ BaseUpdater

-

Kind: class of electron-updater
-Extends: BaseUpdater

+
  • electron-publish -

    -

    appImageUpdater.isUpdaterActive() ⇒ Boolean

    -

    Overrides: isUpdaterActive
    -

    -

    appImageUpdater.install(isSilent, isForceRunAfter) ⇒ Boolean

    - - - - - - - - - - - - - - -
    Param
    isSilent
    isForceRunAfter
    -

    -

    appImageUpdater.quitAndInstall(isSilent, isForceRunAfter)

    - - - - - - - - - - - - - - -
    Param
    isSilent
    isForceRunAfter
    -

    -

    appImageUpdater.addAuthHeader(token)

    -

    Shortcut for explicitly adding auth tokens to request headers

    - - - - - - - - - - - - - -
    ParamType
    tokenString
    -

    -

    appImageUpdater.checkForUpdates() ⇒ Promise< | UpdateCheckResult>

    -

    Asks the server whether there is an update.

    -

    -

    appImageUpdater.checkForUpdatesAndNotify(downloadNotification) ⇒ Promise< | UpdateCheckResult>

    - - - - - - - - - - - - - -
    ParamType
    downloadNotificationDownloadNotification
    -

    -

    appImageUpdater.downloadUpdate(cancellationToken) ⇒ Promise<Array<String>>

    -

    Start downloading update manually. You can use this method if autoDownload option is set to false.

    -

    Returns: Promise<Array<String>> - Paths to downloaded files.

    - - - - - - - - - - - - - -
    ParamType
    cancellationTokenCancellationToken
    -

    -

    appImageUpdater.getFeedURL() ⇒ undefined | null | String

    -

    -

    appImageUpdater.setFeedURL(options)

    -

    Configure update provider. If value is string, GenericServerOptions will be set with value as url.

    - - - - - - - - - - - - - - - -
    ParamTypeDescription
    optionsPublishConfiguration | String | GithubOptions | S3Options | SpacesOptions | GenericServerOptions | module:builder-util-runtime/out/publishOptions.CustomPublishOptions | module:builder-util-runtime/out/publishOptions.KeygenOptions | SnapStoreOptions | module:builder-util-runtime/out/publishOptions.BitbucketOptions | StringIf you want to override configuration in the app-update.yml.
    -

    -

    AppUpdater ⇐ module:tiny-typed-emitter/lib/index.TypedEmitter

    -

    Kind: class of electron-updater
    -Extends: module:tiny-typed-emitter/lib/index.TypedEmitter
    -Properties

    +
  • .ProgressCallback
    • -
  • -

    httpExecutor ElectronHttpExecutor

    +
  • .Publisher +
    • -
  • -

    isAddNoCacheQuery Boolean

    +
  • .getCiTag() ⇒ null | String
    • + -

    Methods

    +

    +

    PublishContext

    +

    Kind: interface of electron-publish
    +Properties

    +

    +

    UploadTask

    +

    Kind: interface of electron-publish
    +Properties

    +

    +

    HttpPublisher ⇐ Publisher

    +

    Kind: class of electron-publish
    +Extends: Publisher

    + -

    -

    appUpdater.addAuthHeader(token)

    -

    Shortcut for explicitly adding auth tokens to request headers

    - - - - - - - - - - - - - -
    ParamType
    tokenString
    -

    -

    appUpdater.checkForUpdates() ⇒ Promise< | UpdateCheckResult>

    -

    Asks the server whether there is an update.

    -

    -

    appUpdater.checkForUpdatesAndNotify(downloadNotification) ⇒ Promise< | UpdateCheckResult>

    - - - - - - - - - - - - - -
    ParamType
    downloadNotificationDownloadNotification
    -

    -

    appUpdater.downloadUpdate(cancellationToken) ⇒ Promise<Array<String>>

    -

    Start downloading update manually. You can use this method if autoDownload option is set to false.

    -

    Returns: Promise<Array<String>> - Paths to downloaded files.

    +

    +

    httpPublisher.upload(task) ⇒ Promise<any>

    +

    Overrides: upload

    @@ -10324,70 +1338,96 @@ will be set to 1.

    - - + +
    cancellationTokenCancellationTokentaskUploadTask
    -

    -

    appUpdater.getFeedURL() ⇒ undefined | null | String

    -

    -

    appUpdater.setFeedURL(options)

    -

    Configure update provider. If value is string, GenericServerOptions will be set with value as url.

    +

    +

    httpPublisher.toString() ⇒ String

    +

    +

    ProgressCallback

    +

    Kind: class of electron-publish
    +

    +

    progressCallback.update(transferred, total)

    - - - - + + + + + +
    Param TypeDescription
    optionsPublishConfiguration | String | GithubOptions | S3Options | SpacesOptions | GenericServerOptions | module:builder-util-runtime/out/publishOptions.CustomPublishOptions | module:builder-util-runtime/out/publishOptions.KeygenOptions | SnapStoreOptions | module:builder-util-runtime/out/publishOptions.BitbucketOptions | StringIf you want to override configuration in the app-update.yml.transferredNumber
    totalNumber
    -

    -

    appUpdater.isUpdaterActive() ⇒ Boolean

    -

    -

    appUpdater.quitAndInstall(isSilent, isForceRunAfter)

    -

    Restarts the app and installs the update after it has been downloaded. -It should only be called after update-downloaded has been emitted.

    -

    Note: autoUpdater.quitAndInstall() will close all application windows first and only emit before-quit event on app after that. -This is different from the normal quit event sequence.

    +

    +

    Publisher

    +

    Kind: class of electron-publish
    +Properties

    + +

    Methods

    + +

    +

    publisher.toString() ⇒ String

    +

    +

    publisher.upload(task) ⇒ Promise<any>

    - - - - - - - - - + +
    Param TypeDescription
    isSilentBooleanwindows-only Runs the installer in silent mode. Defaults to false.
    isForceRunAfterBooleanRun the app after finish even on silent install. Not applicable for macOS. Ignored if isSilent is set to false(In this case you can still set autoRunAppAfterInstall to false to prevent run the app after finish).taskUploadTask
    -

    -

    DebUpdater ⇐ BaseUpdater

    -

    Kind: class of electron-updater
    -Extends: BaseUpdater

    +

    +

    electron-publish.getCiTag() ⇒ null | String

    +

    Kind: method of electron-publish
    +

    +

    electron-updater

    + +

    +

    Logger

    +

    Kind: interface of electron-updater

    + +

    +

    logger.debug(message)

    @@ -10444,16 +1496,13 @@ This is different from the normal quit event sequence.

    - +
    tokenmessage String
    -

    -

    debUpdater.checkForUpdates() ⇒ Promise< | UpdateCheckResult>

    -

    Asks the server whether there is an update.

    -

    -

    debUpdater.checkForUpdatesAndNotify(downloadNotification) ⇒ Promise< | UpdateCheckResult>

    +

    +

    logger.error(message)

    @@ -10463,15 +1512,13 @@ This is different from the normal quit event sequence.

    - - + +
    downloadNotificationDownloadNotificationmessageany
    -

    -

    debUpdater.downloadUpdate(cancellationToken) ⇒ Promise<Array<String>>

    -

    Start downloading update manually. You can use this method if autoDownload option is set to false.

    -

    Returns: Promise<Array<String>> - Paths to downloaded files.

    +

    +

    logger.info(message)

    @@ -10481,42 +1528,125 @@ This is different from the normal quit event sequence.

    - - + +
    cancellationTokenCancellationTokenmessageany
    -

    -

    debUpdater.getFeedURL() ⇒ undefined | null | String

    -

    -

    debUpdater.setFeedURL(options)

    -

    Configure update provider. If value is string, GenericServerOptions will be set with value as url.

    +

    +

    logger.warn(message)

    - - - - + +
    Param TypeDescription
    optionsPublishConfiguration | String | GithubOptions | S3Options | SpacesOptions | GenericServerOptions | module:builder-util-runtime/out/publishOptions.CustomPublishOptions | module:builder-util-runtime/out/publishOptions.KeygenOptions | SnapStoreOptions | module:builder-util-runtime/out/publishOptions.BitbucketOptions | StringIf you want to override configuration in the app-update.yml.messageany
    -

    -

    debUpdater.isUpdaterActive() ⇒ Boolean

    -

    -

    MacUpdater ⇐ AppUpdater

    +

    +

    ResolvedUpdateFileInfo

    +

    Kind: interface of electron-updater
    +Properties

    + +

    +

    UpdateCheckResult

    +

    Kind: interface of electron-updater
    +Properties

    + +

    +

    UpdateDownloadedEvent ⇐ module:builder-util-runtime.UpdateInfo

    +

    Kind: interface of electron-updater
    +Extends: module:builder-util-runtime.UpdateInfo
    +Properties

    + +

    +

    AppImageUpdater ⇐ module:electron-updater/out/BaseUpdater.BaseUpdater

    Kind: class of electron-updater
    -Extends: AppUpdater

    +Extends: module:electron-updater/out/BaseUpdater.BaseUpdater
    +

    +

    appImageUpdater.isUpdaterActive() ⇒ Boolean

    +

    +

    AppUpdater ⇐ module:tiny-typed-emitter/lib/index.TypedEmitter

    +

    Kind: class of electron-updater
    +Extends: module:tiny-typed-emitter/lib/index.TypedEmitter
    +Properties

    + +

    Methods

    -

    -

    macUpdater.quitAndInstall()

    -

    Overrides: quitAndInstall
    -

    -

    macUpdater.addAuthHeader(token)

    +

    +

    appUpdater.addAuthHeader(token)

    Shortcut for explicitly adding auth tokens to request headers

    @@ -10548,10 +1676,10 @@ This is different from the normal quit event sequence.

    -

    macUpdater.checkForUpdates() ⇒ Promise< | UpdateCheckResult>

    +

    appUpdater.checkForUpdates() ⇒ Promise< | UpdateCheckResult>

    Asks the server whether there is an update.

    -

    macUpdater.checkForUpdatesAndNotify(downloadNotification) ⇒ Promise< | UpdateCheckResult>

    +

    appUpdater.checkForUpdatesAndNotify(downloadNotification) ⇒ Promise< | UpdateCheckResult>

    @@ -10562,12 +1690,12 @@ This is different from the normal quit event sequence.

    - +
    downloadNotificationDownloadNotificationmodule:electron-updater/out/AppUpdater.DownloadNotification

    -

    macUpdater.downloadUpdate(cancellationToken) ⇒ Promise<Array<String>>

    +

    appUpdater.downloadUpdate(cancellationToken) ⇒ Promise<Array<String>>

    Start downloading update manually. You can use this method if autoDownload option is set to false.

    Returns: Promise<Array<String>> - Paths to downloaded files.

    @@ -10585,9 +1713,9 @@ This is different from the normal quit event sequence.

    -

    macUpdater.getFeedURL() ⇒ undefined | null | String

    +

    appUpdater.getFeedURL() ⇒ undefined | null | String

    -

    macUpdater.setFeedURL(options)

    +

    appUpdater.setFeedURL(options)

    Configure update provider. If value is string, GenericServerOptions will be set with value as url.

    @@ -10606,68 +1734,61 @@ This is different from the normal quit event sequence.

    -

    macUpdater.isUpdaterActive() ⇒ Boolean

    -

    -

    NsisUpdater ⇐ BaseUpdater

    -

    Kind: class of electron-updater
    -Extends: BaseUpdater
    -Properties

    - -

    Methods

    - -

    -

    nsisUpdater.install(isSilent, isForceRunAfter) ⇒ Boolean

    - - - - - - - - - - - - - - -
    Param
    isSilent
    isForceRunAfter
    -

    -

    nsisUpdater.quitAndInstall(isSilent, isForceRunAfter)

    +

    appUpdater.isUpdaterActive() ⇒ Boolean

    +

    +

    appUpdater.quitAndInstall(isSilent, isForceRunAfter)

    +

    Restarts the app and installs the update after it has been downloaded. +It should only be called after update-downloaded has been emitted.

    +

    Note: autoUpdater.quitAndInstall() will close all application windows first and only emit before-quit event on app after that. +This is different from the normal quit event sequence.

    + + + + + +
    ParamTypeDescription
    isSilentBooleanwindows-only Runs the installer in silent mode. Defaults to false.
    isForceRunAfterBooleanRun the app after finish even on silent install. Not applicable for macOS. Ignored if isSilent is set to false(In this case you can still set autoRunAppAfterInstall to false to prevent run the app after finish).
    -

    -

    nsisUpdater.addAuthHeader(token)

    +

    +

    DebUpdater ⇐ module:electron-updater/out/BaseUpdater.BaseUpdater

    +

    Kind: class of electron-updater
    +Extends: module:electron-updater/out/BaseUpdater.BaseUpdater
    +

    +

    MacUpdater ⇐ AppUpdater

    +

    Kind: class of electron-updater
    +Extends: AppUpdater

    + +

    +

    macUpdater.quitAndInstall()

    +

    Overrides: quitAndInstall
    +

    +

    macUpdater.addAuthHeader(token)

    Shortcut for explicitly adding auth tokens to request headers

    @@ -10684,10 +1805,10 @@ This is different from the normal quit event sequence.

    -

    nsisUpdater.checkForUpdates() ⇒ Promise< | UpdateCheckResult>

    +

    macUpdater.checkForUpdates() ⇒ Promise< | UpdateCheckResult>

    Asks the server whether there is an update.

    -

    nsisUpdater.checkForUpdatesAndNotify(downloadNotification) ⇒ Promise< | UpdateCheckResult>

    +

    macUpdater.checkForUpdatesAndNotify(downloadNotification) ⇒ Promise< | UpdateCheckResult>

    @@ -10698,12 +1819,12 @@ This is different from the normal quit event sequence.

    - +
    downloadNotificationDownloadNotificationmodule:electron-updater/out/AppUpdater.DownloadNotification

    -

    nsisUpdater.downloadUpdate(cancellationToken) ⇒ Promise<Array<String>>

    +

    macUpdater.downloadUpdate(cancellationToken) ⇒ Promise<Array<String>>

    Start downloading update manually. You can use this method if autoDownload option is set to false.

    Returns: Promise<Array<String>> - Paths to downloaded files.

    @@ -10721,9 +1842,9 @@ This is different from the normal quit event sequence.

    -

    nsisUpdater.getFeedURL() ⇒ undefined | null | String

    +

    macUpdater.getFeedURL() ⇒ undefined | null | String

    -

    nsisUpdater.setFeedURL(options)

    +

    macUpdater.setFeedURL(options)

    Configure update provider. If value is string, GenericServerOptions will be set with value as url.

    @@ -10742,7 +1863,16 @@ This is different from the normal quit event sequence.

    -

    nsisUpdater.isUpdaterActive() ⇒ Boolean

    +

    macUpdater.isUpdaterActive() ⇒ Boolean

    +

    +

    NsisUpdater ⇐ module:electron-updater/out/BaseUpdater.BaseUpdater

    +

    Kind: class of electron-updater
    +Extends: module:electron-updater/out/BaseUpdater.BaseUpdater
    +Properties

    +

    Provider

    Kind: class of electron-updater
    @@ -10796,136 +1926,10 @@ This is different from the normal quit event sequence.

    -

    RpmUpdater ⇐ BaseUpdater

    +

    RpmUpdater ⇐ module:electron-updater/out/BaseUpdater.BaseUpdater

    Kind: class of electron-updater
    -Extends: BaseUpdater

    - -

    -

    rpmUpdater.install(isSilent, isForceRunAfter) ⇒ Boolean

    - - - - - - - - - - - - - - -
    Param
    isSilent
    isForceRunAfter
    -

    -

    rpmUpdater.quitAndInstall(isSilent, isForceRunAfter)

    - - - - - - - - - - - - - - -
    Param
    isSilent
    isForceRunAfter
    -

    -

    rpmUpdater.addAuthHeader(token)

    -

    Shortcut for explicitly adding auth tokens to request headers

    - - - - - - - - - - - - - -
    ParamType
    tokenString
    -

    -

    rpmUpdater.checkForUpdates() ⇒ Promise< | UpdateCheckResult>

    -

    Asks the server whether there is an update.

    -

    -

    rpmUpdater.checkForUpdatesAndNotify(downloadNotification) ⇒ Promise< | UpdateCheckResult>

    - - - - - - - - - - - - - -
    ParamType
    downloadNotificationDownloadNotification
    -

    -

    rpmUpdater.downloadUpdate(cancellationToken) ⇒ Promise<Array<String>>

    -

    Start downloading update manually. You can use this method if autoDownload option is set to false.

    -

    Returns: Promise<Array<String>> - Paths to downloaded files.

    - - - - - - - - - - - - - -
    ParamType
    cancellationTokenCancellationToken
    -

    -

    rpmUpdater.getFeedURL() ⇒ undefined | null | String

    -

    -

    rpmUpdater.setFeedURL(options)

    -

    Configure update provider. If value is string, GenericServerOptions will be set with value as url.

    - - - - - - - - - - - - - - - -
    ParamTypeDescription
    optionsPublishConfiguration | String | GithubOptions | S3Options | SpacesOptions | GenericServerOptions | module:builder-util-runtime/out/publishOptions.CustomPublishOptions | module:builder-util-runtime/out/publishOptions.KeygenOptions | SnapStoreOptions | module:builder-util-runtime/out/publishOptions.BitbucketOptions | StringIf you want to override configuration in the app-update.yml.
    -

    -

    rpmUpdater.isUpdaterActive() ⇒ Boolean

    -

    +Extends: module:electron-updater/out/BaseUpdater.BaseUpdater
    +

    UpdaterSignal

    Kind: class of electron-updater

    +

    CustomPublishOptions

    +

    undefined

    + +

    Inherited from PublishConfiguration:

    + diff --git a/packages/app-builder-lib/src/index.ts b/packages/app-builder-lib/src/index.ts index 17103e91ea0..31cbca39645 100644 --- a/packages/app-builder-lib/src/index.ts +++ b/packages/app-builder-lib/src/index.ts @@ -26,7 +26,7 @@ export { Configuration, AfterPackContext, MetadataDirectories } from "./configur export { ElectronBrandingOptions, ElectronDownloadOptions, ElectronPlatformName } from "./electron/ElectronFramework" export { PlatformSpecificBuildOptions, AsarOptions, FileSet, Protocol, ReleaseInfo } from "./options/PlatformSpecificBuildOptions" export { FileAssociation } from "./options/FileAssociation" -export { MacConfiguration, DmgOptions, MasConfiguration, MacOsTargetName, DmgContent, DmgWindow } from "./options/macOptions" +export { MacConfiguration, DmgOptions, MasConfiguration, MacOsTargetName, DmgContent, DmgWindow, NotarizeLegacyOptions, NotarizeNotaryOptions } from "./options/macOptions" export { PkgOptions, PkgBackgroundOptions, BackgroundAlignment, BackgroundScaling } from "./options/pkgOptions" export { WindowsConfiguration } from "./options/winOptions" export { AppXOptions } from "./options/AppXOptions" @@ -35,7 +35,7 @@ export { MsiWrappedOptions } from "./options/MsiWrappedOptions" export { CommonWindowsInstallerConfiguration } from "./options/CommonWindowsInstallerConfiguration" export { NsisOptions, NsisWebOptions, PortableOptions, CommonNsisOptions } from "./targets/nsis/nsisOptions" export { LinuxConfiguration, DebOptions, CommonLinuxOptions, LinuxTargetSpecificOptions, AppImageOptions, FlatpakOptions } from "./options/linuxOptions" -export { SnapOptions } from "./options/SnapOptions" +export { SnapOptions, PlugDescriptor, SlotDescriptor } from "./options/SnapOptions" export { Metadata, AuthorMetadata, RepositoryInfo } from "./options/metadata" export { AppInfo } from "./appInfo" export { SquirrelWindowsOptions } from "./options/SquirrelWindowsOptions" diff --git a/packages/app-builder-lib/src/options/macOptions.ts b/packages/app-builder-lib/src/options/macOptions.ts index 3ec301b9bcf..a13a5aec43a 100644 --- a/packages/app-builder-lib/src/options/macOptions.ts +++ b/packages/app-builder-lib/src/options/macOptions.ts @@ -210,7 +210,12 @@ export interface MacConfiguration extends PlatformSpecificBuildOptions { * Options to use for @electron/notarize (ref: https://github.com/electron/notarize). * Supports both `legacy` and `notarytool` notarization tools. Use `false` to explicitly disable * - * Note: In order to activate the notarization step You MUST specify one of the following via environment variables:\n1. `APPLE_API_KEY`, `APPLE_API_KEY_ID` and `APPLE_API_ISSUER`\n2. `APPLE_ID` and `APPLE_APP_SPECIFIC_PASSWORD`\n3. `APPLE_KEYCHAIN` and `APPLE_KEYCHAIN_PROFILE`\n\nFor security reasons it is recommended to use the first option (see https://github.com/electron-userland/electron-builder/issues/7859) + * Note: In order to activate the notarization step You MUST specify one of the following via environment variables: + * 1. `APPLE_API_KEY`, `APPLE_API_KEY_ID` and `APPLE_API_ISSUER`. + * 2. `APPLE_ID` and `APPLE_APP_SPECIFIC_PASSWORD` + * 3. `APPLE_KEYCHAIN` and `APPLE_KEYCHAIN_PROFILE` + * + * For security reasons it is recommended to use the first option (see https://github.com/electron-userland/electron-builder/issues/7859) */ readonly notarize?: NotarizeLegacyOptions | NotarizeNotaryOptions | boolean | null } diff --git a/scripts/jsdoc2md2html.js b/scripts/jsdoc2md2html.js index 6514738e645..de697bed977 100644 --- a/scripts/jsdoc2md2html.js +++ b/scripts/jsdoc2md2html.js @@ -22,15 +22,15 @@ async function main() { const partialDir = path.join(__dirname, "jsdoc") const partials = (await globby(["*.hbs"], {cwd: partialDir})).map(it => path.resolve(partialDir, it)) - // const files = [ - // path.join(source, "builder/electron-builder.js"), - // path.join(source, "publisher/electron-publish.js"), - // path.join(source, "updater/electron-updater.js"), - // path.join(source, "builder-lib/app-builder-lib.js"), - // path.join(source, "builder-util-runtime/builder-util-runtime.js"), - // path.join(source, "util/builder-util.js"), - // ] - const files = (await globby(["**/*.js"], {cwd: source})).map(it => path.resolve(source, it)) + const files = [ + path.join(source, "builder/electron-builder.js"), + path.join(source, "publisher/electron-publish.js"), + path.join(source, "updater/electron-updater.js"), + path.join(source, "builder-lib/app-builder-lib.js"), + path.join(source, "builder-util-runtime/builder-util-runtime.js"), + path.join(source, "util/builder-util.js"), + ] + // const files = (await globby(["**/*.js"], {cwd: source})).map(it => path.resolve(source, it)) const pages = [ { page: "api/electron-builder.md", pageUrl: "electron-builder", @@ -207,7 +207,11 @@ async function render2(files, jsdoc2MdOptions) { const pages = [ new Page("configuration/configuration.md", "Configuration"), - new Page("configuration/mac.md", "MacConfiguration"), + new Page("configuration/mac.md", null, { + "MacConfiguration": "", + "NotarizeLegacyOptions" : "", + "NotarizeNotaryOptions" : "" + }), new Page("configuration/dmg.md", "DmgOptions"), new Page("configuration/mas.md", "MasConfiguration"), new Page("configuration/pkg.md", "PkgOptions"), @@ -229,7 +233,8 @@ async function render2(files, jsdoc2MdOptions) { "SpacesOptions": "", "KeygenOptions": "", "BitbucketOptions": "", - "S3Options": "" + "S3Options": "", + "CustomPublishOptions": "" }), new Page("generated/appimage-options.md", "AppImageOptions"),