electron-builder/out/builder.createYargs() ⇒ yargs:ArgvKind: method of electron-builder/out/builder
-
app-builder-lib/out/appInfo.smarten(s) ⇒ StringKind: method of app-builder-lib/out/appInfo
| Param | -Type | -
|---|---|
| s | -String |
-
.ArtifactBuildStarted.ArtifactCreated ⇐ module:packages/electron-publish/out/publisher.UploadTask.BeforeBuildContext.BuildResult.CertificateFromStoreInfo.FileCodeSigningInfo.Framework
+.afterPack(context) ⇒ Promise<any>.beforeCopyExtraFiles(options) ⇒ Promise<any>.createTransformer() ⇒ null | module:packages/builder-util/out/fs.__type.getDefaultIcon(platform) ⇒ null | String.getExcludedDependencies(platform) ⇒ null | Array.getMainFile(platform) ⇒ null | String.prepareApplicationStageDirectory(options) ⇒ Promise<any>.PlugDescriptor.SlotDescriptor.SourceRepositoryInfo.computePackageUrl() ⇒ Promise< | String>.getVersionInWeirdWindowsForm(isSetBuildNumber) ⇒ String._build(configuration, metadata, devMetadata, repositoryInfo) ⇒ Promise<BuildResult>.addAfterPackHandler(handler).afterPack(context) ⇒ Promise<any>.artifactCreated(handler) ⇒ Packager.build() ⇒ Promise<BuildResult>.callAppxManifestCreated(path) ⇒ Promise<void>.callArtifactBuildCompleted(event) ⇒ Promise<void>.callArtifactBuildStarted(event, logFields) ⇒ Promise<void>.callMsiProjectCreated(path) ⇒ Promise<void>.dispatchArtifactCreated(event).disposeOnBuildFinish(disposer).installAppDependencies(platform, arch) ⇒ Promise<any>.getNodeDependencyInfo(platform) ⇒ Lazy<Array<module:app-builder-lib/out/util/packageDependencies.NodeModuleDirInfo>>.createTarget(type, archs) ⇒ Map<Platform | Map<Arch | Array<String>>>.current() ⇒ Platform.fromString(name) ⇒ Platform.toString() ⇒ String.artifactPatternConfig(targetSpecificOptions, defaultPattern) ⇒ module:app-builder-lib/out/platformPackager.__object.computeSafeArtifactName(suggestedName, ext, arch, skipDefaultArch, defaultArch, safePattern) ⇒ null | String.createTargets(targets, mapper).getDefaultFrameworkIcon() ⇒ null | String.dispatchArtifactCreated(file, target, arch, safeArtifactName) ⇒ Promise<void>.getElectronDestinationDir(appOutDir) ⇒ String.getElectronSrcDir(dist) ⇒ String.expandArtifactBeautyNamePattern(targetSpecificOptions, ext, arch) ⇒ String.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern, skipDefaultArch, defaultArch) ⇒ String.expandMacro(pattern, arch, extra, isProductNameSanitized) ⇒ String.generateName2(ext, classifier, deployment) ⇒ String.getIconPath() ⇒ Promise< | String>.getMacOsResourcesDir(appOutDir) ⇒ String.pack(outDir, arch, targets, taskManager) ⇒ Promise<any>.resolveIcon(sources, fallbackSources, outputFormat) ⇒ Promise<Array<module:app-builder-lib/out/platformPackager.IconInfo>>.getResource(custom, names) ⇒ Promise< | String>.getResourcesDir(appOutDir) ⇒ String.getTempFile(suffix) ⇒ Promise<String>module:packages/electron-publish/out/publisher.PublishContext
.NodeIntegrity.ReadAsarHeader.awaitTasks() ⇒ Promise<void>.cancelTasks().getGlobalPublishConfigurations() ⇒ Promise< | Array>.addFileNode(file, dirNode, size, unpacked, stat, integrity) ⇒ Node.getFile(p, followLinks) ⇒ Node.getNode(p) ⇒ null | Node.getOrCreateNode(p) ⇒ Node.readFile(file) ⇒ Promise<module:global.Buffer>.readJson(file) ⇒ Promise<any>.searchNodeFromDirectory(p, isCreate) ⇒ null | Node.build(appOutDir, arch) ⇒ Promise<any>.finishBuild() ⇒ Promise<any>.readAsar(archive) ⇒ Promise<AsarFilesystem>.readAsarHeader(archive) ⇒ Promise<ReadAsarHeader>.readAsarJson(archive, file) ⇒ Promise<any>.build(options, packager) ⇒ Promise<Array<String>>.buildForge(forgeOptions, options) ⇒ Promise<Array<String>>NodeIntegrityKind: interface of app-builder-lib/out/asar/asar
+
ArtifactBuildStartedKind: interface of app-builder-lib
Properties
algorithm “SHA256”hash StringblockSize Numberblocks Array<String>targetPresentableName Stringfile Stringarch Arch | “undefined”ReadAsarHeaderKind: interface of app-builder-lib/out/asar/asar
+
ArtifactCreated ⇐ module:packages/electron-publish/out/publisher.UploadTaskKind: interface of app-builder-lib
+Extends: module:packages/electron-publish/out/publisher.UploadTask
Properties
header Stringsize Numberpackager PlatformPackager<any>target Target | “undefined”updateInfo anysafeArtifactName String | “undefined”publishConfig PublishConfiguration | “undefined”isWriteUpdateInfo BooleanKind: class of app-builder-lib/out/asar/asar
BeforeBuildContextKind: interface of app-builder-lib
+Properties
appDir StringelectronVersion Stringplatform Platformarch StringBuildResultKind: interface of app-builder-lib
+Properties
.addFileNode(file, dirNode, size, unpacked, stat, integrity) ⇒ Node.getFile(p, followLinks) ⇒ Node.getNode(p) ⇒ null | Node.getOrCreateNode(p) ⇒ Node.readFile(file) ⇒ Promise<module:global.Buffer>.readJson(file) ⇒ Promise<any>.searchNodeFromDirectory(p, isCreate) ⇒ null | NodeoutDir StringartifactPaths Array<String>platformToTargets Map<Platform | Map<String | Target>>configuration ConfigurationCertificateFromStoreInfoKind: interface of app-builder-lib
+Properties
thumbprint Stringsubject Stringstore StringisLocalMachineStore BooleanasarFilesystem.addFileNode(file, dirNode, size, unpacked, stat, integrity) ⇒ Node| Param | -Type | -|||
|---|---|---|---|---|
| file | -String |
-|||
| dirNode | -Node |
-|||
| size | -Number |
-|||
| unpacked | -Boolean |
-
| stat | -module:fs.Stats |
+Param | +Type |
|---|---|---|---|
| integrity | -NodeIntegrity |
+context | +module:app-builder-lib/out/configuration.PackContext |
asarFilesystem.getFile(p, followLinks) ⇒ Nodeframework.beforeCopyExtraFiles(options) ⇒ Promise<any>| p | -String |
-||
| followLinks | -+ | options | +module:app-builder-lib/out/Framework.BeforeCopyExtraFilesOptions |
asarFilesystem.getNode(p) ⇒ null | Nodeframework.createTransformer() ⇒ null | module:packages/builder-util/out/fs.__typeframework.getDefaultIcon(platform) ⇒ null | String| p | -String |
+platform | +Platform |
asarFilesystem.getOrCreateNode(p) ⇒ Nodeframework.getExcludedDependencies(platform) ⇒ null | Array| p | -String |
+platform | +Platform |
asarFilesystem.readFile(file) ⇒ Promise<module:global.Buffer>framework.getMainFile(platform) ⇒ null | String| file | -String |
+platform | +Platform |
asarFilesystem.readJson(file) ⇒ Promise<any>framework.prepareApplicationStageDirectory(options) ⇒ Promise<any>| file | -String |
+options | +PrepareApplicationStageDirectoryOptions |
asarFilesystem.searchNodeFromDirectory(p, isCreate) ⇒ null | NodePlugDescriptorKind: interface of app-builder-lib
+
SlotDescriptorKind: interface of app-builder-lib
+
SourceRepositoryInfoKind: interface of app-builder-lib
+Properties
type Stringdomain Stringuser Stringproject StringKind: class of app-builder-lib
+Properties
description = smarten(this.info.metadata.description || "") Stringversion StringshortVersion String | undefinedshortVersionWindows String | undefinedbuildNumber String | undefinedbuildVersion StringproductName StringsanitizedProductName StringproductFilename Stringchannel String | “undefined”companyName String | “undefined”id StringmacBundleIdentifier Stringname StringlinuxPackageName StringsanitizedName StringupdaterCacheDirName Stringcopyright StringMethods
+.computePackageUrl() ⇒ Promise< | String>.getVersionInWeirdWindowsForm(isSetBuildNumber) ⇒ StringappInfo.computePackageUrl() ⇒ Promise< | String>appInfo.getVersionInWeirdWindowsForm(isSetBuildNumber) ⇒ String| Param | -Type | |
|---|---|---|
| p | -String |
-|
| isCreate | -Boolean |
+isSetBuildNumber |
Kind: class of app-builder-lib/out/asar/asar
+
Kind: class of app-builder-lib
Properties
files Object<String, any>unpacked Booleansize Numberoffset Stringexecutable Booleanlink Stringintegrity NodeIntegrityprojectDir StringappDir Stringmetadata MetadataareNodeModulesHandledExternally BooleanisPrepackedAppAsar BooleandevMetadata Metadata | “undefined”config ConfigurationisTwoPackageJsonProjectLayoutUsed = false BooleaneventEmitter = new EventEmitter() module:events.EventEmitter_appInfo AppInfo | “undefined”appInfo AppInfotempDirManager = new TmpDir("packager") TmpDiroptions PackagerOptionsdebugLogger = new DebugLogger(log.isDebugEnabled) DebugLoggerrepositoryInfo Promise< | SourceRepositoryInfo>[stageDirPathCustomizer=(target, packager, arch) => {
+return path.join(target.outDir, __${target.name}-${getArtifactArchName(arch, target.name)})
+}] callbackbuildResourcesDir StringrelativeBuildResourcesDirname Stringframework FrameworkMethods
+._build(configuration, metadata, devMetadata, repositoryInfo) ⇒ Promise<BuildResult>.addAfterPackHandler(handler).afterPack(context) ⇒ Promise<any>.artifactCreated(handler) ⇒ Packager.build() ⇒ Promise<BuildResult>.callAppxManifestCreated(path) ⇒ Promise<void>.callArtifactBuildCompleted(event) ⇒ Promise<void>.callArtifactBuildStarted(event, logFields) ⇒ Promise<void>.callMsiProjectCreated(path) ⇒ Promise<void>.dispatchArtifactCreated(event).disposeOnBuildFinish(disposer).installAppDependencies(platform, arch) ⇒ Promise<any>.getNodeDependencyInfo(platform) ⇒ Lazy<Array<module:app-builder-lib/out/util/packageDependencies.NodeModuleDirInfo>>app-builder-lib/out/asar/asar.readAsar(archive) ⇒ Promise<AsarFilesystem>Kind: method of app-builder-lib/out/asar/asar
packager._build(configuration, metadata, devMetadata, repositoryInfo) ⇒ Promise<BuildResult>| archive | -String |
+configuration | +Configuration |
+
| metadata | +Metadata |
+||
| devMetadata | +Metadata | “undefined” |
+||
| repositoryInfo | +SourceRepositoryInfo |
app-builder-lib/out/asar/asar.readAsarHeader(archive) ⇒ Promise<ReadAsarHeader>Kind: method of app-builder-lib/out/asar/asar
packager.addAfterPackHandler(handler)| archive | -String |
+handler | +callback |
app-builder-lib/out/asar/asar.readAsarJson(archive, file) ⇒ Promise<any>Kind: method of app-builder-lib/out/asar/asar
packager.afterPack(context) ⇒ Promise<any>| archive | -String |
-||
| file | -String |
+context | +module:app-builder-lib/out/configuration.PackContext |
.AsarIntegrity.HeaderHash.computeData(undefined) ⇒ Promise<AsarIntegrity>.hashFile(file, blockSize) ⇒ Promise<NodeIntegrity>.hashFileContents(contents, blockSize) ⇒ NodeIntegrityAsarIntegrityKind: interface of app-builder-lib/out/asar/integrity
-
HeaderHashKind: interface of app-builder-lib/out/asar/integrity
-Properties
algorithm “SHA256”hash Stringapp-builder-lib/out/asar/integrity.computeData(undefined) ⇒ Promise<AsarIntegrity>Kind: method of app-builder-lib/out/asar/integrity
packager.artifactCreated(handler) ⇒ Packager| undefined | -AsarIntegrityOptions |
+handler | +callback |
app-builder-lib/out/asar/integrity.hashFile(file, blockSize) ⇒ Promise<NodeIntegrity>Kind: method of app-builder-lib/out/asar/integrity
packager.build() ⇒ Promise<BuildResult>packager.callAppxManifestCreated(path) ⇒ Promise<void>| file | +path | String |
| blockSize | -- |
app-builder-lib/out/asar/integrity.hashFileContents(contents, blockSize) ⇒ NodeIntegrityKind: method of app-builder-lib/out/asar/integrity
packager.callArtifactBuildCompleted(event) ⇒ Promise<void>| contents | -module:global.Buffer | String |
-||
| blockSize | -+ | event | +ArtifactCreated |
app-builder-lib/out/asar/unpackDetector.isLibOrExe(file) ⇒ BooleanKind: method of app-builder-lib/out/asar/unpackDetector
packager.callArtifactBuildStarted(event, logFields) ⇒ Promise<void>| file | -String |
+event | +ArtifactBuildStarted |
+
| logFields | +any |
.download(url, output, checksum) ⇒ Promise<void>.getBin(name, url, checksum) ⇒ Promise<String>.getBinFromCustomLoc(name, version, binariesLocUrl, checksum) ⇒ Promise<String>.getBinFromUrl(name, version, checksum) ⇒ Promise<String>app-builder-lib/out/binDownload.download(url, output, checksum) ⇒ Promise<void>Kind: method of app-builder-lib/out/binDownload
packager.callMsiProjectCreated(path) ⇒ Promise<void>| url | -String |
-|
| output | +path | String |
| checksum | -String | “undefined” |
-
app-builder-lib/out/binDownload.getBin(name, url, checksum) ⇒ Promise<String>Kind: method of app-builder-lib/out/binDownload
packager.dispatchArtifactCreated(event)Only for sub artifacts (update info), for main artifacts use callArtifactBuildCompleted.
| name | -String |
-||
| url | -String | “undefined” |
-||
| checksum | -String | “undefined” |
+event | +ArtifactCreated |
app-builder-lib/out/binDownload.getBinFromCustomLoc(name, version, binariesLocUrl, checksum) ⇒ Promise<String>Kind: method of app-builder-lib/out/binDownload
packager.disposeOnBuildFinish(disposer)| name | -String |
-||
| version | -String |
-||
| binariesLocUrl | -String |
-||
| checksum | -String |
+disposer | +callback |
app-builder-lib/out/binDownload.getBinFromUrl(name, version, checksum) ⇒ Promise<String>Kind: method of app-builder-lib/out/binDownload
packager.installAppDependencies(platform, arch) ⇒ Promise<any>| name | -String |
-||
| version | -String |
+platform | +Platform |
| checksum | -String |
+arch | +Arch |
.CodeSigningInfo.findIdentityRawResult : Promise<Array<String>> | “undefined”.createKeychain(undefined) ⇒ Promise<CodeSigningInfo>.findIdentity(certType, qualifier, keychain) ⇒ Promise< | Identity>.isSignAllowed(isPrintWarn) ⇒ Boolean.removeKeychain(keychainFile, printWarn) ⇒ Promise<any>.reportError(isMas, certificateTypes, qualifier, keychainFile, isForceCodeSigning) ⇒ Promise<void>CodeSigningInfoKind: interface of app-builder-lib/out/codeSign/macCodeSign
-Properties
keychainFile String | “undefined”Kind: class of app-builder-lib/out/codeSign/macCodeSign
-Properties
name Stringhash Stringapp-builder-lib/out/codeSign/macCodeSign.findIdentityRawResult : Promise<Array<String>> | “undefined”Kind: property of app-builder-lib/out/codeSign/macCodeSign
-
app-builder-lib/out/codeSign/macCodeSign.createKeychain(undefined) ⇒ Promise<CodeSigningInfo>Kind: method of app-builder-lib/out/codeSign/macCodeSign
packager.getNodeDependencyInfo(platform) ⇒ Lazy<Array<module:app-builder-lib/out/util/packageDependencies.NodeModuleDirInfo>>| undefined | -CreateKeychainOptions |
+platform | +Platform | “undefined” |
app-builder-lib/out/codeSign/macCodeSign.findIdentity(certType, qualifier, keychain) ⇒ Promise< | Identity>Kind: method of app-builder-lib/out/codeSign/macCodeSign
Kind: class of app-builder-lib
+Properties
MAC = new Platform("mac", "mac", "darwin") PlatformLINUX = new Platform("linux", "linux", "linux") PlatformWINDOWS = new Platform("windows", "win", "win32") PlatformMethods
+.createTarget(type, archs) ⇒ Map<Platform | Map<Arch | Array<String>>>.current() ⇒ Platform.fromString(name) ⇒ Platform.toString() ⇒ Stringplatform.createTarget(type, archs) ⇒ Map<Platform | Map<Arch | Array<String>>>| certType | -“Developer ID Application” | “Developer ID Installer” | “3rd Party Mac Developer Application” | “3rd Party Mac Developer Installer” | “Mac Developer” | “Apple Development” | “Apple Distribution” |
-||
| qualifier | -String | “undefined” |
+type | +String | Array<String> | “undefined” |
| keychain | -String | “undefined” |
+archs | +Array<Arch> |
app-builder-lib/out/codeSign/macCodeSign.isSignAllowed(isPrintWarn) ⇒ BooleanKind: method of app-builder-lib/out/codeSign/macCodeSign
platform.current() ⇒ Platformplatform.fromString(name) ⇒ Platform| Param | +Type | |
|---|---|---|
| isPrintWarn | +name | +String |
app-builder-lib/out/codeSign/macCodeSign.removeKeychain(keychainFile, printWarn) ⇒ Promise<any>Kind: method of app-builder-lib/out/codeSign/macCodeSign
platform.toString() ⇒ StringKind: class of app-builder-lib
+Properties
packagerOptions PackagerOptionsbuildResourcesDir StringprojectDir Stringconfig ConfigurationplatformSpecificBuildOptions module:app-builder-lib/out/platformPackager.DCresourceList Promise<Array<String>>appInfo AppInfocompression “store” | “normal” | “maximum”debugLogger DebugLoggerdefaultTarget Array<String>fileAssociations Array<FileAssociation>forceCodeSigning BooleanMethods
+.artifactPatternConfig(targetSpecificOptions, defaultPattern) ⇒ module:app-builder-lib/out/platformPackager.__object.computeSafeArtifactName(suggestedName, ext, arch, skipDefaultArch, defaultArch, safePattern) ⇒ null | String.createTargets(targets, mapper).getDefaultFrameworkIcon() ⇒ null | String.dispatchArtifactCreated(file, target, arch, safeArtifactName) ⇒ Promise<void>.getElectronDestinationDir(appOutDir) ⇒ String.getElectronSrcDir(dist) ⇒ String.expandArtifactBeautyNamePattern(targetSpecificOptions, ext, arch) ⇒ String.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern, skipDefaultArch, defaultArch) ⇒ String.expandMacro(pattern, arch, extra, isProductNameSanitized) ⇒ String.generateName2(ext, classifier, deployment) ⇒ String.getIconPath() ⇒ Promise< | String>.getMacOsResourcesDir(appOutDir) ⇒ String.pack(outDir, arch, targets, taskManager) ⇒ Promise<any>.resolveIcon(sources, fallbackSources, outputFormat) ⇒ Promise<Array<module:app-builder-lib/out/platformPackager.IconInfo>>.getResource(custom, names) ⇒ Promise< | String>.getResourcesDir(appOutDir) ⇒ String.getTempFile(suffix) ⇒ Promise<String>platformPackager.artifactPatternConfig(targetSpecificOptions, defaultPattern) ⇒ module:app-builder-lib/out/platformPackager.__object| keychainFile | -String |
+targetSpecificOptions | +TargetSpecificOptions | “undefined” | undefined |
| printWarn | -+ | defaultPattern | +String | undefined |
app-builder-lib/out/codeSign/macCodeSign.reportError(isMas, certificateTypes, qualifier, keychainFile, isForceCodeSigning) ⇒ Promise<void>Kind: method of app-builder-lib/out/codeSign/macCodeSign
platformPackager.computeSafeArtifactName(suggestedName, ext, arch, skipDefaultArch, defaultArch, safePattern) ⇒ null | String| isMas | -Boolean |
+suggestedName | +String | “undefined” |
| certificateTypes | -Array<“Developer ID Application” | “Developer ID Installer” | “3rd Party Mac Developer Application” | “3rd Party Mac Developer Installer” | “Mac Developer” | “Apple Development” | “Apple Distribution”> |
+ext | +String |
| qualifier | -String | “undefined” | undefined |
+arch | +Arch | “undefined” |
| keychainFile | -String | “undefined” | undefined |
+skipDefaultArch | +|
| isForceCodeSigning | -Boolean |
+defaultArch | +String |
+
| safePattern | +
.CertificateInfo.doSign(configuration, packager) ⇒ Promise<void>.getCertificateFromStoreInfo(options, vm) ⇒ Promise<CertificateFromStoreInfo>.getCertInfo(file, password) ⇒ Promise<CertificateInfo>.getSignVendorPath() ⇒ Promise<String>.sign(options, packager) ⇒ Promise<Boolean>CertificateInfoKind: interface of app-builder-lib/out/codeSign/windowsCodeSign
-Properties
commonName StringbloodyMicrosoftSubjectDn Stringapp-builder-lib/out/codeSign/windowsCodeSign.doSign(configuration, packager) ⇒ Promise<void>Kind: method of app-builder-lib/out/codeSign/windowsCodeSign
platformPackager.createTargets(targets, mapper)| configuration | -CustomWindowsSignTaskConfiguration |
+targets | +Array<String> |
| packager | -WinPackager |
+mapper | +callback |
app-builder-lib/out/codeSign/windowsCodeSign.getCertificateFromStoreInfo(options, vm) ⇒ Promise<CertificateFromStoreInfo>Kind: method of app-builder-lib/out/codeSign/windowsCodeSign
platformPackager.getDefaultFrameworkIcon() ⇒ null | StringplatformPackager.dispatchArtifactCreated(file, target, arch, safeArtifactName) ⇒ Promise<void>| options | -WindowsConfiguration |
+file | +String |
+
| target | +Target | “undefined” |
+||
| arch | +Arch | “undefined” |
||
| vm | -VmManager |
+safeArtifactName | +String | “undefined” |
app-builder-lib/out/codeSign/windowsCodeSign.getCertInfo(file, password) ⇒ Promise<CertificateInfo>Kind: method of app-builder-lib/out/codeSign/windowsCodeSign
platformPackager.getElectronDestinationDir(appOutDir) ⇒ String| file | -String |
-|
| password | +appOutDir | String |
app-builder-lib/out/codeSign/windowsCodeSign.getSignVendorPath() ⇒ Promise<String>Kind: method of app-builder-lib/out/codeSign/windowsCodeSign
-
app-builder-lib/out/codeSign/windowsCodeSign.sign(options, packager) ⇒ Promise<Boolean>Kind: method of app-builder-lib/out/codeSign/windowsCodeSign
platformPackager.getElectronSrcDir(dist) ⇒ String| options | -WindowsSignOptions |
-||
| packager | -WinPackager |
+dist | +String |
app-builder-lib/out/electron/ElectronFramework.createBrandingOpts(opts) ⇒ ElectronBrandingOptionsKind: method of app-builder-lib/out/electron/ElectronFramework
platformPackager.expandArtifactBeautyNamePattern(targetSpecificOptions, ext, arch) ⇒ String| opts | -Configuration |
+targetSpecificOptions | +TargetSpecificOptions | “undefined” | undefined |
+
| ext | +String |
+||
| arch | +Arch | “undefined” |
app-builder-lib/out/electron/ElectronFramework.createElectronFrameworkSupport(configuration, packager) ⇒ Promise<Framework>Kind: method of app-builder-lib/out/electron/ElectronFramework
platformPackager.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern, skipDefaultArch, defaultArch) ⇒ String| configuration | -Configuration |
+targetSpecificOptions | +TargetSpecificOptions | “undefined” | undefined |
| packager | -Packager |
+ext | +String |
.getElectronPackage(projectDir) ⇒ Promise<any>.getElectronVersion(projectDir, config) ⇒ Promise<String>.getElectronVersionFromInstalled(projectDir) ⇒ Promise< | String>app-builder-lib/out/electron/electronVersion.getElectronPackage(projectDir) ⇒ Promise<any>Kind: method of app-builder-lib/out/electron/electronVersion
| Param | -Type | +arch | +Arch | “undefined” |
+
|---|---|---|---|
| defaultPattern | +String |
||
| projectDir | +skipDefaultArch | ++ | |
| defaultArch | String |
app-builder-lib/out/electron/electronVersion.getElectronVersion(projectDir, config) ⇒ Promise<String>Kind: method of app-builder-lib/out/electron/electronVersion
platformPackager.expandMacro(pattern, arch, extra, isProductNameSanitized) ⇒ String| projectDir | +pattern | String |
|
| config | -Configuration |
+arch | +String | “undefined” |
app-builder-lib/out/electron/electronVersion.getElectronVersionFromInstalled(projectDir) ⇒ Promise< | String>Kind: method of app-builder-lib/out/electron/electronVersion
| Param | -Type | +extra | +any |
|---|---|---|---|
| projectDir | -String |
+isProductNameSanitized | +
app-builder-lib/out/electron/injectFFMPEG.injectFFMPEG(options, electrionVersion) ⇒ Promise<String>Kind: method of app-builder-lib/out/electron/injectFFMPEG
platformPackager.generateName2(ext, classifier, deployment) ⇒ String| options | -PrepareApplicationStageDirectoryOptions |
+ext | +String | “undefined” |
| electrionVersion | -String |
+classifier | +String | “undefined” | undefined |
+
| deployment | +Boolean |
app-builder-lib/out/Framework.isElectronBased(framework) ⇒ BooleanKind: method of app-builder-lib/out/Framework
platformPackager.getIconPath() ⇒ Promise< | String>platformPackager.getMacOsResourcesDir(appOutDir) ⇒ String| framework | -Framework |
+appOutDir | +String |
Framework
-.afterPack(context) ⇒ Promise<void>.getExcludedDependencies(platform) ⇒ null | Array.getMainFile(platform) ⇒ null | String.prepareApplicationStageDirectory(options) ⇒ Promise<void>.beforeCopyExtraFiles(options) ⇒ Promise<any>.createTransformer() ⇒ null | module:packages/builder-util/out/fs.__type.getDefaultIcon(platform) ⇒ null | StringFrameworkKind: class of app-builder-lib/out/frameworks/LibUiFramework
-Extends: Framework
-Properties
name = libui StringmacOsDefaultTargets = dmg Array<String>defaultAppIdPrefix = com.libui. StringisCopyElevateHelper = false “undefined”isNpmRebuildRequired = false “undefined”Methods
-Framework
-.afterPack(context) ⇒ Promise<void>.getExcludedDependencies(platform) ⇒ null | Array.getMainFile(platform) ⇒ null | String.prepareApplicationStageDirectory(options) ⇒ Promise<void>.beforeCopyExtraFiles(options) ⇒ Promise<any>.createTransformer() ⇒ null | module:packages/builder-util/out/fs.__type.getDefaultIcon(platform) ⇒ null | StringlibUiFramework.afterPack(context) ⇒ Promise<void>Overrides: afterPack
platformPackager.pack(outDir, arch, targets, taskManager) ⇒ Promise<any>| context | -module:app-builder-lib/out/configuration.PackContext |
+outDir | +String |
libUiFramework.getExcludedDependencies(platform) ⇒ null | ArrayOverrides: getExcludedDependencies
| Param | -Type | +arch | +Arch |
|---|---|---|---|
| platform | -Platform |
+targets | +Array<Target> |
+
| taskManager | +AsyncTaskManager |
libUiFramework.getMainFile(platform) ⇒ null | StringOverrides: getMainFile
platformPackager.resolveIcon(sources, fallbackSources, outputFormat) ⇒ Promise<Array<module:app-builder-lib/out/platformPackager.IconInfo>>| platform | -Platform |
+sources | +Array<String> |
+
| fallbackSources | +Array<String> |
+||
| outputFormat | +“set” | “icns” | “ico” |
libUiFramework.prepareApplicationStageDirectory(options) ⇒ Promise<void>Overrides: prepareApplicationStageDirectory
platformPackager.getResource(custom, names) ⇒ Promise< | String>| options | -PrepareApplicationStageDirectoryOptions |
+custom | +String | “undefined” | undefined |
+
| names | +Array<String> |
libUiFramework.beforeCopyExtraFiles(options) ⇒ Promise<any>platformPackager.getResourcesDir(appOutDir) ⇒ String| options | -BeforeCopyExtraFilesOptions |
+appOutDir | +String |
libUiFramework.createTransformer() ⇒ null | module:packages/builder-util/out/fs.__typelibUiFramework.getDefaultIcon(platform) ⇒ null | StringplatformPackager.getTempFile(suffix) ⇒ Promise<String>| platform | -Platform |
+suffix | +String |
module:packages/electron-publish/out/publisher.PublishContextKind: class of app-builder-lib
+Extends: module:packages/electron-publish/out/publisher.PublishContext
+Properties
isPublish = false Booleanprogress = (process.stdout as TtyWriteStream).isTTY ? new MultiProgress() : null MultiProgressMethods
PlatformPackager
+module:packages/electron-publish/out/publisher.PublishContext
.createTargets(targets, mapper).artifactPatternConfig(targetSpecificOptions, defaultPattern) ⇒ module:app-builder-lib/out/platformPackager.__object.computeSafeArtifactName(suggestedName, ext, arch, skipDefaultArch, defaultArch, safePattern) ⇒ null | String.getDefaultFrameworkIcon() ⇒ null | String.dispatchArtifactCreated(file, target, arch, safeArtifactName) ⇒ Promise<void>.getElectronDestinationDir(appOutDir) ⇒ String.getElectronSrcDir(dist) ⇒ String.expandArtifactBeautyNamePattern(targetSpecificOptions, ext, arch) ⇒ String.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern, skipDefaultArch, defaultArch) ⇒ String.expandMacro(pattern, arch, extra, isProductNameSanitized) ⇒ String.generateName2(ext, classifier, deployment) ⇒ String.getIconPath() ⇒ Promise< | String>.getMacOsResourcesDir(appOutDir) ⇒ String.pack(outDir, arch, targets, taskManager) ⇒ Promise<any>.resolveIcon(sources, fallbackSources, outputFormat) ⇒ Promise<Array<IconInfo>>.getResource(custom, names) ⇒ Promise< | String>.getResourcesDir(appOutDir) ⇒ String.getTempFile(suffix) ⇒ Promise<String>.toAppImageOrSnapArch(arch) ⇒ String.awaitTasks() ⇒ Promise<void>.cancelTasks().getGlobalPublishConfigurations() ⇒ Promise< | Array>PlatformPackagerKind: class of app-builder-lib/out/linuxPackager
-Extends: PlatformPackager
+
publishManager.awaitTasks() ⇒ Promise<void>publishManager.cancelTasks()publishManager.getGlobalPublishConfigurations() ⇒ Promise< | Array>Kind: class of app-builder-lib
Properties
executableName StringdefaultTarget Array<String>outDir Stringoptions TargetSpecificOptions | “undefined” | undefinedMethods
PlatformPackager
+.createTargets(targets, mapper).artifactPatternConfig(targetSpecificOptions, defaultPattern) ⇒ module:app-builder-lib/out/platformPackager.__object.computeSafeArtifactName(suggestedName, ext, arch, skipDefaultArch, defaultArch, safePattern) ⇒ null | String.getDefaultFrameworkIcon() ⇒ null | String.dispatchArtifactCreated(file, target, arch, safeArtifactName) ⇒ Promise<void>.getElectronDestinationDir(appOutDir) ⇒ String.getElectronSrcDir(dist) ⇒ String.expandArtifactBeautyNamePattern(targetSpecificOptions, ext, arch) ⇒ String.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern, skipDefaultArch, defaultArch) ⇒ String.expandMacro(pattern, arch, extra, isProductNameSanitized) ⇒ String.generateName2(ext, classifier, deployment) ⇒ String.getIconPath() ⇒ Promise< | String>.getMacOsResourcesDir(appOutDir) ⇒ String.pack(outDir, arch, targets, taskManager) ⇒ Promise<any>.resolveIcon(sources, fallbackSources, outputFormat) ⇒ Promise<Array<IconInfo>>.getResource(custom, names) ⇒ Promise< | String>.getResourcesDir(appOutDir) ⇒ String.getTempFile(suffix) ⇒ Promise<String>.build(appOutDir, arch) ⇒ Promise<any>.finishBuild() ⇒ Promise<any>linuxPackager.createTargets(targets, mapper)Overrides: createTargets
target.build(appOutDir, arch) ⇒ Promise<any>| targets | -Array<String> |
+appOutDir | +String |
| mapper | -callback |
+arch | +Arch |
linuxPackager.artifactPatternConfig(targetSpecificOptions, defaultPattern) ⇒ module:app-builder-lib/out/platformPackager.__objecttarget.finishBuild() ⇒ Promise<any>app-builder-lib.build(options, packager) ⇒ Promise<Array<String>>Kind: method of app-builder-lib
| targetSpecificOptions | -TargetSpecificOptions | “undefined” | undefined |
+options | +PackagerOptions | module:packages/electron-publish/out/publisher.PublishOptions |
| defaultPattern | -String | undefined |
+packager | +Packager |
linuxPackager.computeSafeArtifactName(suggestedName, ext, arch, skipDefaultArch, defaultArch, safePattern) ⇒ null | Stringapp-builder-lib.buildForge(forgeOptions, options) ⇒ Promise<Array<String>>Kind: method of app-builder-lib
| suggestedName | -String | “undefined” |
-||
| ext | -String |
-||
| arch | -Arch | “undefined” |
-||
| skipDefaultArch | -- | ||
| defaultArch | -String |
+forgeOptions | +ForgeOptions |
| safePattern | -+ | options | +PackagerOptions |
linuxPackager.getDefaultFrameworkIcon() ⇒ null | StringlinuxPackager.dispatchArtifactCreated(file, target, arch, safeArtifactName) ⇒ Promise<void>| Param | -Type | -
|---|---|
| file | -String |
-
| target | -Target | “undefined” |
-
| arch | -Arch | “undefined” |
-
| safeArtifactName | -String | “undefined” |
-
linuxPackager.getElectronDestinationDir(appOutDir) ⇒ String| Param | -Type | -
|---|---|
| appOutDir | -String |
-
linuxPackager.getElectronSrcDir(dist) ⇒ String| Param | -Type | -
|---|---|
| dist | -String |
-
linuxPackager.expandArtifactBeautyNamePattern(targetSpecificOptions, ext, arch) ⇒ String| Param | -Type | -
|---|---|
| targetSpecificOptions | -TargetSpecificOptions | “undefined” | undefined |
-
| ext | -String |
-
| arch | -Arch | “undefined” |
-
linuxPackager.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern, skipDefaultArch, defaultArch) ⇒ String| Param | -Type | -
|---|---|
| targetSpecificOptions | -TargetSpecificOptions | “undefined” | undefined |
-
| ext | -String |
-
| arch | -Arch | “undefined” |
-
| defaultPattern | -String |
-
| skipDefaultArch | -- |
| defaultArch | -String |
-
linuxPackager.expandMacro(pattern, arch, extra, isProductNameSanitized) ⇒ String| Param | -Type | -
|---|---|
| pattern | -String |
-
| arch | -String | “undefined” |
-
| extra | -any |
-
| isProductNameSanitized | -- |
linuxPackager.generateName2(ext, classifier, deployment) ⇒ String| Param | -Type | -
|---|---|
| ext | -String | “undefined” |
-
| classifier | -String | “undefined” | undefined |
-
| deployment | -Boolean |
-
linuxPackager.getIconPath() ⇒ Promise< | String>linuxPackager.getMacOsResourcesDir(appOutDir) ⇒ String| Param | -Type | -
|---|---|
| appOutDir | -String |
-
linuxPackager.pack(outDir, arch, targets, taskManager) ⇒ Promise<any>| Param | -Type | -
|---|---|
| outDir | -String |
-
| arch | -Arch |
-
| targets | -Array<Target> |
-
| taskManager | -AsyncTaskManager |
-
linuxPackager.resolveIcon(sources, fallbackSources, outputFormat) ⇒ Promise<Array<IconInfo>>| Param | -Type | -
|---|---|
| sources | -Array<String> |
-
| fallbackSources | -Array<String> |
-
| outputFormat | -“set” | “icns” | “ico” |
-
linuxPackager.getResource(custom, names) ⇒ Promise< | String>| Param | -Type | -
|---|---|
| custom | -String | “undefined” | undefined |
-
| names | -Array<String> |
-
linuxPackager.getResourcesDir(appOutDir) ⇒ String| Param | -Type | -
|---|---|
| appOutDir | -String |
-
linuxPackager.getTempFile(suffix) ⇒ Promise<String>| Param | -Type | -
|---|---|
| suffix | -String |
-
app-builder-lib/out/linuxPackager.toAppImageOrSnapArch(arch) ⇒ StringKind: method of app-builder-lib/out/linuxPackager
| Param | -Type | -
|---|---|
| arch | -Arch |
-
PlatformPackager
-.applyCommonInfo(appPlist, contentsPath) ⇒ Promise<void>.createTargets(targets, mapper).getElectronDestinationDir(appOutDir) ⇒ String.getElectronSrcDir(dist) ⇒ String.getIconPath() ⇒ Promise< | String>.pack(outDir, arch, targets, taskManager) ⇒ Promise<void>.artifactPatternConfig(targetSpecificOptions, defaultPattern) ⇒ module:app-builder-lib/out/platformPackager.__object.computeSafeArtifactName(suggestedName, ext, arch, skipDefaultArch, defaultArch, safePattern) ⇒ null | String.getDefaultFrameworkIcon() ⇒ null | String.dispatchArtifactCreated(file, target, arch, safeArtifactName) ⇒ Promise<void>.expandArtifactBeautyNamePattern(targetSpecificOptions, ext, arch) ⇒ String.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern, skipDefaultArch, defaultArch) ⇒ String.expandMacro(pattern, arch, extra, isProductNameSanitized) ⇒ String.generateName2(ext, classifier, deployment) ⇒ String.getMacOsResourcesDir(appOutDir) ⇒ String.resolveIcon(sources, fallbackSources, outputFormat) ⇒ Promise<Array<IconInfo>>.getResource(custom, names) ⇒ Promise< | String>.getResourcesDir(appOutDir) ⇒ String.getTempFile(suffix) ⇒ Promise<String>PlatformPackagerKind: class of app-builder-lib/out/macPackager
-Extends: PlatformPackager
-Properties
**<code id="MacPackager-[codeSigningInfo=new Lazy
return createKeychain({
-tmpDir: this.info.tempDirManager,
-cscLink,
-cscKeyPassword: this.getCscPassword(),
-cscILink: chooseNotNull(this.platformSpecificBuildOptions.cscInstallerLink, process.env.CSC_INSTALLER_LINK),
-cscIKeyPassword: chooseNotNull(this.platformSpecificBuildOptions.cscInstallerKeyPassword, process.env.CSC_INSTALLER_KEY_PASSWORD),
-currentDir: this.projectDir,
-}).then(result => {
-const keychainFile = result.keychainFile
-if (keychainFile != null) {
-this.info.disposeOnBuildFinish(() => removeKeychain(keychainFile))
-}
-return result
-})
-})]">[codeSigningInfo=new Lazy
return createKeychain({ -tmpDir: this.info.tempDirManager, -cscLink, -cscKeyPassword: this.getCscPassword(), -cscILink: chooseNotNull(this.platformSpecificBuildOptions.cscInstallerLink, process.env.CSC_INSTALLER_LINK), -cscIKeyPassword: chooseNotNull(this.platformSpecificBuildOptions.cscInstallerKeyPassword, process.env.CSC_INSTALLER_KEY_PASSWORD), -currentDir: this.projectDir, -}).then(result => { -const keychainFile = result.keychainFile -if (keychainFile != null) { -this.info.disposeOnBuildFinish(() => removeKeychain(keychainFile)) -} -return result -}) -})]** Lazy<CodeSigningInfo>
-defaultTarget Array<String>
Methods
-PlatformPackager
-.applyCommonInfo(appPlist, contentsPath) ⇒ Promise<void>.createTargets(targets, mapper).getElectronDestinationDir(appOutDir) ⇒ String.getElectronSrcDir(dist) ⇒ String.getIconPath() ⇒ Promise< | String>.pack(outDir, arch, targets, taskManager) ⇒ Promise<void>.artifactPatternConfig(targetSpecificOptions, defaultPattern) ⇒ module:app-builder-lib/out/platformPackager.__object.computeSafeArtifactName(suggestedName, ext, arch, skipDefaultArch, defaultArch, safePattern) ⇒ null | String.getDefaultFrameworkIcon() ⇒ null | String.dispatchArtifactCreated(file, target, arch, safeArtifactName) ⇒ Promise<void>.expandArtifactBeautyNamePattern(targetSpecificOptions, ext, arch) ⇒ String.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern, skipDefaultArch, defaultArch) ⇒ String.expandMacro(pattern, arch, extra, isProductNameSanitized) ⇒ String.generateName2(ext, classifier, deployment) ⇒ String.getMacOsResourcesDir(appOutDir) ⇒ String.resolveIcon(sources, fallbackSources, outputFormat) ⇒ Promise<Array<IconInfo>>.getResource(custom, names) ⇒ Promise< | String>.getResourcesDir(appOutDir) ⇒ String.getTempFile(suffix) ⇒ Promise<String>macPackager.applyCommonInfo(appPlist, contentsPath) ⇒ Promise<void>| Param | -Type | -
|---|---|
| appPlist | -any |
-
| contentsPath | -String |
-
macPackager.createTargets(targets, mapper)Overrides: createTargets
| Param | -Type | -
|---|---|
| targets | -Array<String> |
-
| mapper | -callback |
-
macPackager.getElectronDestinationDir(appOutDir) ⇒ StringOverrides: getElectronDestinationDir
| Param | -Type | -
|---|---|
| appOutDir | -String |
-
macPackager.getElectronSrcDir(dist) ⇒ StringOverrides: getElectronSrcDir
| Param | -Type | -
|---|---|
| dist | -String |
-
macPackager.getIconPath() ⇒ Promise< | String>Overrides: getIconPath
-
macPackager.pack(outDir, arch, targets, taskManager) ⇒ Promise<void>Overrides: pack
| Param | -Type | -
|---|---|
| outDir | -String |
-
| arch | -Arch |
-
| targets | -Array<Target> |
-
| taskManager | -AsyncTaskManager |
-
macPackager.artifactPatternConfig(targetSpecificOptions, defaultPattern) ⇒ module:app-builder-lib/out/platformPackager.__object| Param | -Type | -
|---|---|
| targetSpecificOptions | -TargetSpecificOptions | “undefined” | undefined |
-
| defaultPattern | -String | undefined |
-
macPackager.computeSafeArtifactName(suggestedName, ext, arch, skipDefaultArch, defaultArch, safePattern) ⇒ null | String| Param | -Type | -
|---|---|
| suggestedName | -String | “undefined” |
-
| ext | -String |
-
| arch | -Arch | “undefined” |
-
| skipDefaultArch | -- |
| defaultArch | -String |
-
| safePattern | -- |
macPackager.getDefaultFrameworkIcon() ⇒ null | StringmacPackager.dispatchArtifactCreated(file, target, arch, safeArtifactName) ⇒ Promise<void>| Param | -Type | -
|---|---|
| file | -String |
-
| target | -Target | “undefined” |
-
| arch | -Arch | “undefined” |
-
| safeArtifactName | -String | “undefined” |
-
macPackager.expandArtifactBeautyNamePattern(targetSpecificOptions, ext, arch) ⇒ String| Param | -Type | -
|---|---|
| targetSpecificOptions | -TargetSpecificOptions | “undefined” | undefined |
-
| ext | -String |
-
| arch | -Arch | “undefined” |
-
macPackager.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern, skipDefaultArch, defaultArch) ⇒ String| Param | -Type | -
|---|---|
| targetSpecificOptions | -TargetSpecificOptions | “undefined” | undefined |
-
| ext | -String |
-
| arch | -Arch | “undefined” |
-
| defaultPattern | -String |
-
| skipDefaultArch | -- |
| defaultArch | -String |
-
macPackager.expandMacro(pattern, arch, extra, isProductNameSanitized) ⇒ String| Param | -Type | -
|---|---|
| pattern | -String |
-
| arch | -String | “undefined” |
-
| extra | -any |
-
| isProductNameSanitized | -- |
macPackager.generateName2(ext, classifier, deployment) ⇒ String| Param | -Type | -
|---|---|
| ext | -String | “undefined” |
-
| classifier | -String | “undefined” | undefined |
-
| deployment | -Boolean |
-
macPackager.getMacOsResourcesDir(appOutDir) ⇒ String| Param | -Type | -
|---|---|
| appOutDir | -String |
-
macPackager.resolveIcon(sources, fallbackSources, outputFormat) ⇒ Promise<Array<IconInfo>>| Param | -Type | -
|---|---|
| sources | -Array<String> |
-
| fallbackSources | -Array<String> |
-
| outputFormat | -“set” | “icns” | “ico” |
-
macPackager.getResource(custom, names) ⇒ Promise< | String>| Param | -Type | -
|---|---|
| custom | -String | “undefined” | undefined |
-
| names | -Array<String> |
-
macPackager.getResourcesDir(appOutDir) ⇒ String| Param | -Type | -
|---|---|
| appOutDir | -String |
-
macPackager.getTempFile(suffix) ⇒ Promise<String>| Param | -Type | -
|---|---|
| suffix | -String |
-
app-builder-lib/out/options/CommonWindowsInstallerConfiguration.DesktopShortcutCreationPolicy : enumKind: enum of app-builder-lib/out/options/CommonWindowsInstallerConfiguration
-Properties
FRESH_INSTALLALWAYSNEVERPlugDescriptorKind: interface of app-builder-lib/out/options/SnapOptions
-
SlotDescriptorKind: interface of app-builder-lib/out/options/SnapOptions
-
.IconInfo.chooseNotNull(v1, v2) ⇒ undefined | null | String.computeSafeArtifactNameIfNeeded(suggestedName, safeNameProducer) ⇒ null | String.isSafeGithubName(name) ⇒ Boolean.normalizeExt(ext) ⇒ String.resolveFunction(executor, name) ⇒ module:app-builder-lib/out/platformPackager.TIconInfoKind: interface of app-builder-lib/out/platformPackager
-Properties
file Stringsize Numberapp-builder-lib/out/platformPackager.chooseNotNull(v1, v2) ⇒ undefined | null | StringKind: method of app-builder-lib/out/platformPackager
| Param | -Type | -
|---|---|
| v1 | -String | “undefined” | undefined |
-
| v2 | -String | “undefined” | undefined |
-
app-builder-lib/out/platformPackager.computeSafeArtifactNameIfNeeded(suggestedName, safeNameProducer) ⇒ null | StringKind: method of app-builder-lib/out/platformPackager
| Param | -Type | -
|---|---|
| suggestedName | -String | “undefined” |
-
| safeNameProducer | -callback |
-
app-builder-lib/out/platformPackager.isSafeGithubName(name) ⇒ BooleanKind: method of app-builder-lib/out/platformPackager
| Param | -Type | -
|---|---|
| name | -String |
-
app-builder-lib/out/platformPackager.normalizeExt(ext) ⇒ StringKind: method of app-builder-lib/out/platformPackager
| Param | -Type | -
|---|---|
| ext | -String |
-
app-builder-lib/out/platformPackager.resolveFunction(executor, name) ⇒ module:app-builder-lib/out/platformPackager.TKind: method of app-builder-lib/out/platformPackager
| Param | -Type | -
|---|---|
| executor | -module:app-builder-lib/out/platformPackager.T | String |
-
| name | -String |
-
LibUiFramework
-.createTransformer() ⇒ null | module:packages/builder-util/out/fs.__type.getDefaultIcon(platform) ⇒ String.afterPack(context) ⇒ Promise<void>.getExcludedDependencies(platform) ⇒ null | Array.getMainFile(platform) ⇒ null | String.prepareApplicationStageDirectory(options) ⇒ Promise<void>.beforeCopyExtraFiles(options) ⇒ Promise<any>LibUiFrameworkKind: class of app-builder-lib/out/ProtonFramework
-Extends: LibUiFramework
-Properties
name = proton “proton”defaultAppIdPrefix = com.proton-native. “com.proton-native.”Methods
-LibUiFramework
-.createTransformer() ⇒ null | module:packages/builder-util/out/fs.__type.getDefaultIcon(platform) ⇒ String.afterPack(context) ⇒ Promise<void>.getExcludedDependencies(platform) ⇒ null | Array.getMainFile(platform) ⇒ null | String.prepareApplicationStageDirectory(options) ⇒ Promise<void>.beforeCopyExtraFiles(options) ⇒ Promise<any>protonFramework.createTransformer() ⇒ null | module:packages/builder-util/out/fs.__typeOverrides: createTransformer
-
protonFramework.getDefaultIcon(platform) ⇒ StringOverrides: getDefaultIcon
| Param | -Type | -
|---|---|
| platform | -Platform |
-
protonFramework.afterPack(context) ⇒ Promise<void>| Param | -Type | -
|---|---|
| context | -module:app-builder-lib/out/configuration.PackContext |
-
protonFramework.getExcludedDependencies(platform) ⇒ null | Array| Param | -Type | -
|---|---|
| platform | -Platform |
-
protonFramework.getMainFile(platform) ⇒ null | String| Param | -Type | -
|---|---|
| platform | -Platform |
-
protonFramework.prepareApplicationStageDirectory(options) ⇒ Promise<void>| Param | -Type | -
|---|---|
| options | -PrepareApplicationStageDirectoryOptions |
-
protonFramework.beforeCopyExtraFiles(options) ⇒ Promise<any>| Param | -Type | -
|---|---|
| options | -BeforeCopyExtraFilesOptions |
-
HttpPublisher
-.convertAppPassword(username, token) ⇒ String.deleteRelease(filename) ⇒ Promise<void>.toString() ⇒ StringHttpPublisherKind: class of app-builder-lib/out/publish/BitbucketPublisher
-Extends: HttpPublisher
-Properties
providerName = bitbucket “bitbucket”hostname = api.bitbucket.org “api.bitbucket.org”Methods
-HttpPublisher
-.convertAppPassword(username, token) ⇒ String.deleteRelease(filename) ⇒ Promise<void>.toString() ⇒ StringbitbucketPublisher.convertAppPassword(username, token) ⇒ String| Param | -Type | -
|---|---|
| username | -String |
-
| token | -String |
-
bitbucketPublisher.deleteRelease(filename) ⇒ Promise<void>| Param | -Type | -
|---|---|
| filename | -String |
-
bitbucketPublisher.toString() ⇒ String.KeygenArtifact.KeygenError.KeygenReleaseHttpPublisher
-.deleteRelease(releaseId) ⇒ Promise<void>.toString() ⇒ StringKeygenArtifactKind: interface of app-builder-lib/out/publish/KeygenPublisher
-Properties
id Stringtype “artifacts”attributes Object<String, any>relationships Object<String, any>links Object<String, any>KeygenErrorKind: interface of app-builder-lib/out/publish/KeygenPublisher
-Properties
title Stringdetail Stringcode StringKeygenReleaseKind: interface of app-builder-lib/out/publish/KeygenPublisher
-Properties
id Stringtype “releases”attributes Object<String, any>relationships Object<String, any>HttpPublisherKind: class of app-builder-lib/out/publish/KeygenPublisher
-Extends: HttpPublisher
-Properties
providerName = keygen “keygen”hostname = api.keygen.sh “api.keygen.sh”Methods
-HttpPublisher
-.deleteRelease(releaseId) ⇒ Promise<void>.toString() ⇒ StringkeygenPublisher.deleteRelease(releaseId) ⇒ Promise<void>| Param | -Type | -
|---|---|
| releaseId | -String |
-
keygenPublisher.toString() ⇒ String.computeDownloadUrl(publishConfiguration, fileName, packager) ⇒ String.createPublisher(context, version, publishConfig, options, packager) ⇒ null | Publisher.getPublishConfigs(platformPackager, targetSpecificOptions, arch, errorIfCannot) ⇒ Promise< | Array>.getPublishConfigsForUpdateInfo(packager, publishConfigs, arch) ⇒ Promise< | Array>app-builder-lib/out/publish/PublishManager.computeDownloadUrl(publishConfiguration, fileName, packager) ⇒ StringKind: method of app-builder-lib/out/publish/PublishManager
| Param | -Type | -
|---|---|
| publishConfiguration | -PublishConfiguration |
-
| fileName | -String | “undefined” |
-
| packager | -PlatformPackager<any> |
-
app-builder-lib/out/publish/PublishManager.createPublisher(context, version, publishConfig, options, packager) ⇒ null | PublisherKind: method of app-builder-lib/out/publish/PublishManager
| Param | -Type | -
|---|---|
| context | -module:packages/electron-publish/out/publisher.PublishContext |
-
| version | -String |
-
| publishConfig | -PublishConfiguration |
-
| options | -module:packages/electron-publish/out/publisher.PublishOptions |
-
| packager | -Packager |
-
app-builder-lib/out/publish/PublishManager.getPublishConfigs(platformPackager, targetSpecificOptions, arch, errorIfCannot) ⇒ Promise< | Array>Kind: method of app-builder-lib/out/publish/PublishManager
| Param | -Type | -
|---|---|
| platformPackager | -PlatformPackager<any> |
-
| targetSpecificOptions | -PlatformSpecificBuildOptions | “undefined” | undefined |
-
| arch | -Arch | “undefined” |
-
| errorIfCannot | -Boolean |
-
app-builder-lib/out/publish/PublishManager.getPublishConfigsForUpdateInfo(packager, publishConfigs, arch) ⇒ Promise< | Array>Kind: method of app-builder-lib/out/publish/PublishManager
| Param | -Type | -
|---|---|
| packager | -PlatformPackager<any> |
-
| publishConfigs | -Array<PublishConfiguration> | “undefined” |
-
| arch | -Arch | “undefined” |
-
Publisher
-.toString() ⇒ String.upload(task) ⇒ Promise<any>PublisherKind: class of app-builder-lib/out/publish/s3/BaseS3Publisher
-Extends: Publisher
Publisher
-.toString() ⇒ String.upload(task) ⇒ Promise<any>baseS3Publisher.toString() ⇒ StringbaseS3Publisher.upload(task) ⇒ Promise<any>| Param | -Type | -
|---|---|
| task | -module:packages/electron-publish/out/publisher.UploadTask |
-
BaseS3Publisher
-.toString() ⇒ String.upload(task) ⇒ Promise<any>BaseS3PublisherKind: class of app-builder-lib/out/publish/s3/s3Publisher
-Extends: BaseS3Publisher
-Properties
providerName = s3 “s3”Methods
-BaseS3Publisher
-.toString() ⇒ String.upload(task) ⇒ Promise<any>s3Publisher.toString() ⇒ StringOverrides: toString
-
s3Publisher.upload(task) ⇒ Promise<any>| Param | -Type | -
|---|---|
| task | -module:packages/electron-publish/out/publisher.UploadTask |
-
BaseS3Publisher
-.toString() ⇒ String.upload(task) ⇒ Promise<any>BaseS3PublisherKind: class of app-builder-lib/out/publish/s3/spacesPublisher
-Extends: BaseS3Publisher
-Properties
providerName = spaces “spaces”Methods
-BaseS3Publisher
-.toString() ⇒ String.upload(task) ⇒ Promise<any>spacesPublisher.toString() ⇒ StringspacesPublisher.upload(task) ⇒ Promise<any>| Param | -Type | -
|---|---|
| task | -module:packages/electron-publish/out/publisher.UploadTask |
-
Publisher
-.toString() ⇒ String.upload(task) ⇒ Promise<any>PublisherKind: class of app-builder-lib/out/publish/SnapStorePublisher
-Extends: Publisher
-Properties
providerName = snapStore “snapStore”Methods
-Publisher
-.toString() ⇒ String.upload(task) ⇒ Promise<any>snapStorePublisher.toString() ⇒ StringsnapStorePublisher.upload(task) ⇒ Promise<any>| Param | -Type | -
|---|---|
| task | -module:packages/electron-publish/out/publisher.UploadTask |
-
.UpdateInfoFileTask.writeUpdateInfoFiles(updateInfoFileTasks, packager) ⇒ Promise<void>UpdateInfoFileTaskKind: interface of app-builder-lib/out/publish/updateInfoBuilder
-Properties
file Stringinfo module:builder-util-runtime.UpdateInfopublishConfiguration PublishConfigurationpackager PlatformPackager<any>app-builder-lib/out/publish/updateInfoBuilder.writeUpdateInfoFiles(updateInfoFileTasks, packager) ⇒ Promise<void>Kind: method of app-builder-lib/out/publish/updateInfoBuilder
| Param | -Type | -
|---|---|
| updateInfoFileTasks | -Array<UpdateInfoFileTask> |
-
| packager | -Packager |
-
Target
-.build(appOutDir, arch) ⇒ Promise<any>.finishBuild() ⇒ Promise<any>TargetKind: class of app-builder-lib/out/targets/AppImageTarget
-Extends: Target
-Properties
options = { ...this.packager.platformSpecificBuildOptions, ...(this.packager.config as any)[this.name] } AppImageOptionsMethods
-Target
-.build(appOutDir, arch) ⇒ Promise<any>.finishBuild() ⇒ Promise<any>appImageTarget.build(appOutDir, arch) ⇒ Promise<any>Overrides: build
| Param | -Type | -
|---|---|
| appOutDir | -String |
-
| arch | -Arch |
-
appImageTarget.finishBuild() ⇒ Promise<any>Target
-.build(appOutDir, arch) ⇒ Promise<any>.finishBuild() ⇒ Promise<any>TargetKind: class of app-builder-lib/out/targets/AppxTarget
-Extends: Target
-Properties
options = deepAssign({}, this.packager.platformSpecificBuildOptions, this.packager.config.appx) AppXOptionsMethods
-Target
-.build(appOutDir, arch) ⇒ Promise<any>.finishBuild() ⇒ Promise<any>appXTarget.build(appOutDir, arch) ⇒ Promise<any>Overrides: build
| Param | -Type | -
|---|---|
| appOutDir | -String |
-
| arch | -Arch |
-
appXTarget.finishBuild() ⇒ Promise<any>.archive(format, outFile, dirToArchive, options) ⇒ Promise<String>.compute7zCompressArgs(format, options) ⇒ Array<String>app-builder-lib/out/targets/archive.archive(format, outFile, dirToArchive, options) ⇒ Promise<String>Kind: method of app-builder-lib/out/targets/archive
| Param | -Type | -
|---|---|
| format | -String |
-
| outFile | -String |
-
| dirToArchive | -String |
-
| options | -ArchiveOptions |
-
app-builder-lib/out/targets/archive.compute7zCompressArgs(format, options) ⇒ Array<String>Kind: method of app-builder-lib/out/targets/archive
| Param | -Type | -
|---|---|
| format | -String |
-
| options | -ArchiveOptions |
-
Target
-.build(appOutDir, arch) ⇒ Promise<any>.finishBuild() ⇒ Promise<any>TargetKind: class of app-builder-lib/out/targets/ArchiveTarget
-Extends: Target
-Properties
options = (this.packager.config as any)[this.name] TargetSpecificOptionsMethods
-Target
-.build(appOutDir, arch) ⇒ Promise<any>.finishBuild() ⇒ Promise<any>archiveTarget.build(appOutDir, arch) ⇒ Promise<any>Overrides: build
| Param | -Type | -
|---|---|
| appOutDir | -String |
-
| arch | -Arch |
-
archiveTarget.finishBuild() ⇒ Promise<any>.appendBlockmap(file) ⇒ Promise<module:builder-util-runtime.BlockMapDataHolder>.createBlockmap(file, target, packager, safeArtifactName) ⇒ Promise<module:builder-util-runtime.BlockMapDataHolder>.createNsisWebDifferentialUpdateInfo(artifactPath, packageFiles) ⇒ null | module:app-builder-lib/out/targets/differentialUpdateInfoBuilder.__objectapp-builder-lib/out/targets/differentialUpdateInfoBuilder.appendBlockmap(file) ⇒ Promise<module:builder-util-runtime.BlockMapDataHolder>Kind: method of app-builder-lib/out/targets/differentialUpdateInfoBuilder
| Param | -Type | -
|---|---|
| file | -String |
-
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
| Param | -Type | -
|---|---|
| file | -String |
-
| target | -Target |
-
| packager | -PlatformPackager<any> |
-
| safeArtifactName | -String | “undefined” |
-
app-builder-lib/out/targets/differentialUpdateInfoBuilder.createNsisWebDifferentialUpdateInfo(artifactPath, packageFiles) ⇒ null | module:app-builder-lib/out/targets/differentialUpdateInfoBuilder.__objectKind: method of app-builder-lib/out/targets/differentialUpdateInfoBuilder
| Param | -Type | -
|---|---|
| artifactPath | -String |
-
| packageFiles | -Object<String, any> |
-
Target
-.build(appOutDir, arch) ⇒ Promise<any>.finishBuild() ⇒ Promise<any>TargetKind: class of app-builder-lib/out/targets/FlatpakTarget
-Extends: Target
-Properties
[options={
-…this.packager.platformSpecificBuildOptions,
-…(this.packager.config as any)[this.name],
-}] FlatpakOptionsappId StringMethods
-Target
-.build(appOutDir, arch) ⇒ Promise<any>.finishBuild() ⇒ Promise<any>flatpakTarget.build(appOutDir, arch) ⇒ Promise<any>Overrides: build
| Param | -Type | -
|---|---|
| appOutDir | -String |
-
| arch | -Arch |
-
flatpakTarget.finishBuild() ⇒ Promise<any>Target
-.build(appOutDir, arch) ⇒ Promise<any>.finishBuild() ⇒ Promise<any>TargetKind: class of app-builder-lib/out/targets/FpmTarget
-Extends: Target
-Properties
options = { ...this.packager.platformSpecificBuildOptions, ...(this.packager.config as any)[this.name] } LinuxTargetSpecificOptionsMethods
-Target
-.build(appOutDir, arch) ⇒ Promise<any>.finishBuild() ⇒ Promise<any>fpmTarget.build(appOutDir, arch) ⇒ Promise<any>Overrides: build
| Param | -Type | -
|---|---|
| appOutDir | -String |
-
| arch | -Arch |
-
fpmTarget.finishBuild() ⇒ Promise<any>.computeDesktopEntry(targetSpecificOptions, exec, extra) ⇒ Promise<String>.getDescription(options) ⇒ String.getSanitizedVersion(target) ⇒ String.writeDesktopEntry(targetSpecificOptions, exec, destination, extra) ⇒ Promise<String>Kind: class of app-builder-lib/out/targets/LinuxTargetHelper
-Properties
maxIconPath String | “undefined”icons Promise<Array<IconInfo>>mimeTypeFiles Promise< | String>Methods
-.computeDesktopEntry(targetSpecificOptions, exec, extra) ⇒ Promise<String>.getDescription(options) ⇒ String.getSanitizedVersion(target) ⇒ String.writeDesktopEntry(targetSpecificOptions, exec, destination, extra) ⇒ Promise<String>linuxTargetHelper.computeDesktopEntry(targetSpecificOptions, exec, extra) ⇒ Promise<String>| Param | -Type | -
|---|---|
| targetSpecificOptions | -LinuxTargetSpecificOptions |
-
| exec | -String |
-
| extra | -Object<String, any> |
-
linuxTargetHelper.getDescription(options) ⇒ String| Param | -Type | -
|---|---|
| options | -LinuxTargetSpecificOptions |
-
linuxTargetHelper.getSanitizedVersion(target) ⇒ String| Param | -Type | -
|---|---|
| target | -String |
-
linuxTargetHelper.writeDesktopEntry(targetSpecificOptions, exec, destination, extra) ⇒ Promise<String>| Param | -Type | -
|---|---|
| targetSpecificOptions | -LinuxTargetSpecificOptions |
-
| exec | -String |
-
| destination | -String | “undefined” |
-
| extra | -Object<String, any> |
-
Target
-.build(appOutDir, arch) ⇒ Promise<void>.finishBuild() ⇒ Promise<any>TargetKind: class of app-builder-lib/out/targets/MsiTarget
-Extends: Target
-Properties
options = deepAssign(this.packager.platformSpecificBuildOptions, this.packager.config.msi) MsiOptionsMethods
-Target
-.build(appOutDir, arch) ⇒ Promise<void>.finishBuild() ⇒ Promise<any>msiTarget.build(appOutDir, arch) ⇒ Promise<void>Overrides: build
| Param | -Type | -
|---|---|
| appOutDir | -String |
-
| arch | -Arch |
-
msiTarget.finishBuild() ⇒ Promise<any>module:app-builder-lib/out/targets/MsiTarget.default
-.build(appOutDir, arch) ⇒ Promise<any>.finishBuild() ⇒ Promise<any>module:app-builder-lib/out/targets/MsiTarget.defaultKind: class of app-builder-lib/out/targets/MsiWrappedTarget
-Extends: module:app-builder-lib/out/targets/MsiTarget.default
-Properties
options = deepAssign(this.packager.platformSpecificBuildOptions, this.packager.config.msiWrapped) MsiWrappedOptionsMethods
-module:app-builder-lib/out/targets/MsiTarget.default
-.build(appOutDir, arch) ⇒ Promise<any>.finishBuild() ⇒ Promise<any>msiWrappedTarget.build(appOutDir, arch) ⇒ Promise<any>| Param | -Type | -
|---|---|
| appOutDir | -String |
-
| arch | -Arch |
-
msiWrappedTarget.finishBuild() ⇒ Promise<any>Kind: class of app-builder-lib/out/targets/nsis/nsisLang
-Properties
isMultiLang Booleanlangs Array<String>app-builder-lib/out/targets/nsis/nsisLang.addCustomMessageFileInclude(input, packager, scriptGenerator, langConfigurator) ⇒ Promise<void>Kind: method of app-builder-lib/out/targets/nsis/nsisLang
| Param | -Type | -
|---|---|
| input | -String |
-
| packager | -PlatformPackager<any> |
-
| scriptGenerator | -NsisScriptGenerator |
-
| langConfigurator | -LangConfigurator |
-
app-builder-lib/out/targets/nsis/nsisLang.createAddLangsMacro(scriptGenerator, langConfigurator)Kind: method of app-builder-lib/out/targets/nsis/nsisLang
| Param | -Type | -
|---|---|
| scriptGenerator | -NsisScriptGenerator |
-
| langConfigurator | -LangConfigurator |
-
app-builder-lib/out/targets/nsis/nsisLicense.computeLicensePage(packager, options, scriptGenerator, languages) ⇒ Promise<void>Kind: method of app-builder-lib/out/targets/nsis/nsisLicense
| Param | -Type | -
|---|---|
| packager | -WinPackager |
-
| options | -NsisOptions |
-
| scriptGenerator | -NsisScriptGenerator |
-
| languages | -Array<String> |
-
Kind: class of app-builder-lib/out/targets/nsis/nsisScriptGenerator
nsisScriptGenerator.addIncludeDir(file)| Param | -Type | -
|---|---|
| file | -String |
-
nsisScriptGenerator.addPluginDir(pluginArch, dir)| Param | -Type | -
|---|---|
| pluginArch | -String |
-
| dir | -String |
-
nsisScriptGenerator.build() ⇒ StringnsisScriptGenerator.file(outputName, file)| Param | -Type | -
|---|---|
| outputName | -String | “undefined” |
-
| file | -String |
-
nsisScriptGenerator.flags(flags)| Param | -Type | -
|---|---|
| flags | -Array<String> |
-
nsisScriptGenerator.include(file)| Param | -Type | -
|---|---|
| file | -String |
-
nsisScriptGenerator.insertMacro(name, parameters)| Param | -Type | -
|---|---|
| name | -String |
-
| parameters | -String |
-
nsisScriptGenerator.macro(name, lines)| Param | -Type | -
|---|---|
| name | -String |
-
| lines | -Array<String> | NsisScriptGenerator |
-
Target
-.build(appOutDir, arch) ⇒ Promise<void>.finishBuild() ⇒ Promise<any>TargetKind: class of app-builder-lib/out/targets/nsis/NsisTarget
-Extends: Target
-Properties
options NsisOptionsisAsyncSupported = false “undefined”isBuildDifferentialAware BooleanisWebInstaller BooleanMethods
-Target
-.build(appOutDir, arch) ⇒ Promise<void>.finishBuild() ⇒ Promise<any>nsisTarget.build(appOutDir, arch) ⇒ Promise<void>Overrides: build
| Param | -Type | -
|---|---|
| appOutDir | -String |
-
| arch | -Arch |
-
nsisTarget.finishBuild() ⇒ Promise<any>Overrides: finishBuild
-
.PackArchResult.finishBuild() ⇒ Promise<any>.packArch(arch, target) ⇒ Promise<PackArchResult>.copy(appOutDir, target) ⇒ Promise<any>.exec(installerPath, uninstallerPath) ⇒ Promise<void>PackArchResultKind: interface of app-builder-lib/out/targets/nsis/nsisUtil
-Properties
fileInfo module:builder-util-runtime.PackageFileInfounpackedSize NumberKind: class of app-builder-lib/out/targets/nsis/nsisUtil
.finishBuild() ⇒ Promise<any>.packArch(arch, target) ⇒ Promise<PackArchResult>appPackageHelper.finishBuild() ⇒ Promise<any>appPackageHelper.packArch(arch, target) ⇒ Promise<PackArchResult>| Param | -Type | -
|---|---|
| arch | -Arch |
-
| target | -NsisTarget |
-
Kind: class of app-builder-lib/out/targets/nsis/nsisUtil
-
copyElevateHelper.copy(appOutDir, target) ⇒ Promise<any>| Param | -Type | -
|---|---|
| appOutDir | -String |
-
| target | -NsisTarget |
-
Kind: class of app-builder-lib/out/targets/nsis/nsisUtil
-
uninstallerReader.exec(installerPath, uninstallerPath) ⇒ Promise<void>| Param | -Type | -
|---|---|
| installerPath | -String |
-
| uninstallerPath | -String |
-
Target
-.build(appPath, arch) ⇒ Promise<any>.finishBuild() ⇒ Promise<any>.prepareProductBuildArgs(identity, keychain) ⇒ Array<String>TargetKind: class of app-builder-lib/out/targets/pkg
-Extends: Target
-Properties
[options={
-allowAnywhere: true,
-allowCurrentUserHome: true,
-allowRootDirectory: true,
-…this.packager.config.pkg,
-}] PkgOptionsMethods
-Target
-.build(appPath, arch) ⇒ Promise<any>.finishBuild() ⇒ Promise<any>pkgTarget.build(appPath, arch) ⇒ Promise<any>Overrides: build
| Param | -Type | -
|---|---|
| appPath | -String |
-
| arch | -Arch |
-
pkgTarget.finishBuild() ⇒ Promise<any>app-builder-lib/out/targets/pkg.prepareProductBuildArgs(identity, keychain) ⇒ Array<String>Kind: method of app-builder-lib/out/targets/pkg
| Param | -Type | -
|---|---|
| identity | -Identity | “undefined” |
-
| keychain | -String | “undefined” | undefined |
-
Target
-.build(appOutDir, arch) ⇒ Promise<any>.finishBuild() ⇒ Promise<any>TargetKind: class of app-builder-lib/out/targets/snap
-Extends: Target
-Properties
options = { ...this.packager.platformSpecificBuildOptions, ...(this.packager.config as any)[this.name] } SnapOptionsisUseTemplateApp = false BooleanMethods
-Target
-.build(appOutDir, arch) ⇒ Promise<any>.finishBuild() ⇒ Promise<any>snapTarget.build(appOutDir, arch) ⇒ Promise<any>Overrides: build
| Param | -Type | -
|---|---|
| appOutDir | -String |
-
| arch | -Arch |
-
snapTarget.finishBuild() ⇒ Promise<any>Target
-.build(appOutDir, arch) ⇒ Promise<any>.finishBuild() ⇒ Promise<any>.computeArchToTargetNamesMap(raw, platformPackager, platform) ⇒ Map<Arch | Array<String>>.createCommonTarget(target, outDir, packager) ⇒ Target.createTargets(nameToTarget, rawList, outDir, packager) ⇒ Array<Target>TargetKind: class of app-builder-lib/out/targets/targetFactory
-Extends: Target
-Properties
optionsoutDir StringMethods
-Target
-.build(appOutDir, arch) ⇒ Promise<any>.finishBuild() ⇒ Promise<any>noOpTarget.build(appOutDir, arch) ⇒ Promise<any>Overrides: build
| Param | -Type | -
|---|---|
| appOutDir | -String |
-
| arch | -Arch |
-
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
| Param | -Type | -
|---|---|
| raw | -Map<Arch | Array<String>> |
-
| platformPackager | -PlatformPackager<any> |
-
| platform | -Platform |
-
app-builder-lib/out/targets/targetFactory.createCommonTarget(target, outDir, packager) ⇒ TargetKind: method of app-builder-lib/out/targets/targetFactory
| Param | -Type | -
|---|---|
| target | -String |
-
| outDir | -String |
-
| packager | -PlatformPackager<any> |
-
app-builder-lib/out/targets/targetFactory.createTargets(nameToTarget, rawList, outDir, packager) ⇒ Array<Target>Kind: method of app-builder-lib/out/targets/targetFactory
| Param | -Type | -
|---|---|
| nameToTarget | -Map<String | Target> |
-
| rawList | -Array<String> |
-
| outDir | -String |
-
| packager | -PlatformPackager<any> |
-
.cleanup() ⇒ Promise<void>.getTempFile(name) ⇒ String.toString() ⇒ String.createStageDir(target, packager, arch) ⇒ Promise<StageDir>.createStageDirPath(target, packager, arch) ⇒ Promise<String>.getWindowsInstallationAppPackageName(appName) ⇒ String.getWindowsInstallationDirName(appInfo, isTryToUseProductName) ⇒ StringKind: class of app-builder-lib/out/targets/targetUtil
.cleanup() ⇒ Promise<void>.getTempFile(name) ⇒ String.toString() ⇒ StringstageDir.cleanup() ⇒ Promise<void>stageDir.getTempFile(name) ⇒ String| Param | -Type | -
|---|---|
| name | -String |
-
stageDir.toString() ⇒ Stringapp-builder-lib/out/targets/targetUtil.createStageDir(target, packager, arch) ⇒ Promise<StageDir>Kind: method of app-builder-lib/out/targets/targetUtil
| Param | -Type | -
|---|---|
| target | -Target |
-
| packager | -PlatformPackager<any> |
-
| arch | -Arch |
-
app-builder-lib/out/targets/targetUtil.createStageDirPath(target, packager, arch) ⇒ Promise<String>Kind: method of app-builder-lib/out/targets/targetUtil
| Param | -Type | -
|---|---|
| target | -Target |
-
| packager | -PlatformPackager<any> |
-
| arch | -Arch |
-
app-builder-lib/out/targets/targetUtil.getWindowsInstallationAppPackageName(appName) ⇒ StringKind: method of app-builder-lib/out/targets/targetUtil
| Param | -Type | -
|---|---|
| appName | -String |
-
app-builder-lib/out/targets/targetUtil.getWindowsInstallationDirName(appInfo, isTryToUseProductName) ⇒ StringKind: method of app-builder-lib/out/targets/targetUtil
| Param | -Type | -
|---|---|
| appInfo | -AppInfo |
-
| isTryToUseProductName | -Boolean |
-
app-builder-lib/out/targets/tools.getLinuxToolsPath() ⇒ Promise<String>Kind: method of app-builder-lib/out/targets/tools
-
.executeAppBuilderAndWriteJson(args, data, extraOptions) ⇒ Promise<String>.executeAppBuilderAsJson(args) ⇒ Promise<module:app-builder-lib/out/util/appBuilder.T>.objectToArgs(to, argNameToValue)app-builder-lib/out/util/appBuilder.executeAppBuilderAndWriteJson(args, data, extraOptions) ⇒ Promise<String>Kind: method of app-builder-lib/out/util/appBuilder
| Param | -Type | -
|---|---|
| args | -Array<String> |
-
| data | -any |
-
| extraOptions | -module: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
| Param | -Type | -
|---|---|
| args | -Array<String> |
-
app-builder-lib/out/util/appBuilder.objectToArgs(to, argNameToValue)Kind: method of app-builder-lib/out/util/appBuilder
| Param | -Type | -
|---|---|
| to | -Array<String> |
-
| argNameToValue | -Object<String, any> |
-
.ResolvedFileSet.computeFileSets(matchers, transformer, platformPackager, isElectronCompile) ⇒ Promise<Array<ResolvedFileSet>>.copyAppFiles(fileSet, packager, transformer) ⇒ Promise<void>.getDestinationPath(file, fileSet) ⇒ String.transformFiles(transformer, fileSet) ⇒ Promise<void>ResolvedFileSetKind: interface of app-builder-lib/out/util/appFileCopier
-Properties
src Stringdestination Stringfiles Array<String>metadata Map<String | module:fs.Stats>transformedFiles Map<Number | String | module:global.Buffer> | “undefined”app-builder-lib/out/util/appFileCopier.computeFileSets(matchers, transformer, platformPackager, isElectronCompile) ⇒ Promise<Array<ResolvedFileSet>>Kind: method of app-builder-lib/out/util/appFileCopier
| Param | -Type | -
|---|---|
| matchers | -Array<module:app-builder-lib/out/fileMatcher.FileMatcher> |
-
| transformer | -module:packages/builder-util/out/fs.__type | “undefined” |
-
| platformPackager | -PlatformPackager<any> |
-
| isElectronCompile | -Boolean |
-
app-builder-lib/out/util/appFileCopier.copyAppFiles(fileSet, packager, transformer) ⇒ Promise<void>Kind: method of app-builder-lib/out/util/appFileCopier
| Param | -Type | -
|---|---|
| fileSet | -ResolvedFileSet |
-
| packager | -Packager |
-
| transformer | -module:packages/builder-util/out/fs.__type |
-
app-builder-lib/out/util/appFileCopier.getDestinationPath(file, fileSet) ⇒ StringKind: method of app-builder-lib/out/util/appFileCopier
| Param | -Type | -
|---|---|
| file | -String |
-
| fileSet | -ResolvedFileSet |
-
app-builder-lib/out/util/appFileCopier.transformFiles(transformer, fileSet) ⇒ Promise<void>Kind: method of app-builder-lib/out/util/appFileCopier
| Param | -Type | -
|---|---|
| transformer | -module:packages/builder-util/out/fs.__type |
-
| fileSet | -ResolvedFileSet |
-
Kind: class of app-builder-lib/out/util/AppFileWalker
-Properties
metadata = new Map<string, Stats>() Map<String | module:fs.Stats>.ToolInfo.computeEnv(oldValue, newValues) ⇒ String.computeToolEnv(libPath) ⇒ anyToolInfoKind: interface of app-builder-lib/out/util/bundledTool
-Properties
path Stringenv anyapp-builder-lib/out/util/bundledTool.computeEnv(oldValue, newValues) ⇒ StringKind: method of app-builder-lib/out/util/bundledTool
| Param | -Type | -
|---|---|
| oldValue | -String | “undefined” | undefined |
-
| newValues | -Array<String> |
-
app-builder-lib/out/util/bundledTool.computeToolEnv(libPath) ⇒ anyKind: method of app-builder-lib/out/util/bundledTool
| Param | -Type | -
|---|---|
| libPath | -Array<String> |
-
.BuildCacheInfo.copyIfValid(digest) ⇒ Promise<Boolean>.save() ⇒ Promise<void>.digest(hash, files) ⇒ Promise<String>BuildCacheInfoKind: interface of app-builder-lib/out/util/cacheManager
-Properties
executableDigest StringKind: class of app-builder-lib/out/util/cacheManager
-Properties
VERSION = 0 StringcacheDir StringcacheInfoFile StringcacheFile StringcacheInfo BuildCacheInfo | “undefined”Methods
-.copyIfValid(digest) ⇒ Promise<Boolean>.save() ⇒ Promise<void>buildCacheManager.copyIfValid(digest) ⇒ Promise<Boolean>| Param | -Type | -
|---|---|
| digest | -String |
-
buildCacheManager.save() ⇒ Promise<void>app-builder-lib/out/util/cacheManager.digest(hash, files) ⇒ Promise<String>Kind: method of app-builder-lib/out/util/cacheManager
| Param | -Type | -
|---|---|
| hash | -module:crypto.Hash |
-
| files | -Array<String> |
-
.computeDefaultAppDirectory(projectDir, userAppDir) ⇒ Promise<String>.doMergeConfigs(configs) ⇒ Configuration.getConfig(projectDir, configPath, configFromOptions, packageMetadata) ⇒ Promise<Configuration>.validateConfig(config, debugLogger) ⇒ Promise<void>app-builder-lib/out/util/config.computeDefaultAppDirectory(projectDir, userAppDir) ⇒ Promise<String>Kind: method of app-builder-lib/out/util/config
| Param | -Type | -
|---|---|
| projectDir | -String |
-
| userAppDir | -String | “undefined” | undefined |
-
app-builder-lib/out/util/config.doMergeConfigs(configs) ⇒ ConfigurationdoMergeConfigs takes configs in the order you would pass them to
-Object.assign as sources.
Kind: method of app-builder-lib/out/util/config
| Param | -Type | -
|---|---|
| configs | -Array<Configuration> |
-
app-builder-lib/out/util/config.getConfig(projectDir, configPath, configFromOptions, packageMetadata) ⇒ Promise<Configuration>Kind: method of app-builder-lib/out/util/config
| Param | -Type | -
|---|---|
| projectDir | -String |
-
| configPath | -String | “undefined” |
-
| configFromOptions | -Configuration | “undefined” | undefined |
-
| packageMetadata | -Lazy< | 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
| Param | -Type | -
|---|---|
| config | -Configuration |
-
| debugLogger | -DebugLogger |
-
.getCompleteExtname(filename) ⇒ String.sanitizeFileName(s) ⇒ Stringapp-builder-lib/out/util/filename.getCompleteExtname(filename) ⇒ StringKind: method of app-builder-lib/out/util/filename
| Param | -Type | -
|---|---|
| filename | -String |
-
app-builder-lib/out/util/filename.sanitizeFileName(s) ⇒ StringKind: method of app-builder-lib/out/util/filename
| Param | -Type | -
|---|---|
| s | -String |
-
.isAutoDiscoveryCodeSignIdentity() ⇒ Boolean.isBuildCacheEnabled() ⇒ Boolean.isUseSystemSigncode() ⇒ Booleanapp-builder-lib/out/util/flags.isAutoDiscoveryCodeSignIdentity() ⇒ BooleanKind: method of app-builder-lib/out/util/flags
-
app-builder-lib/out/util/flags.isBuildCacheEnabled() ⇒ BooleanKind: method of app-builder-lib/out/util/flags
-
app-builder-lib/out/util/flags.isUseSystemSigncode() ⇒ BooleanKind: method of app-builder-lib/out/util/flags
-
app-builder-lib/out/util/hash.hashFile(file, algorithm, encoding, options) ⇒ Promise<String>Kind: method of app-builder-lib/out/util/hash
| Param | -Type | -
|---|---|
| file | -String |
-
| algorithm | -- |
| encoding | -“base64” | “hex” |
-
| options | -any |
-
.lcid : any.toLangWithRegion(lang) ⇒ Stringapp-builder-lib/out/util/langs.lcid : anyKind: constant of app-builder-lib/out/util/langs
-
app-builder-lib/out/util/langs.toLangWithRegion(lang) ⇒ StringKind: method of app-builder-lib/out/util/langs
| Param | -Type | -
|---|---|
| lang | -String |
-
.LicenseFile.getLicenseAssets(fileNames, packager) ⇒ Array<module:app-builder-lib/out/util/license.__object>.getLicenseFiles(packager) ⇒ Promise<Array<LicenseFile>>.getNotLocalizedLicenseFile(custom, packager, supportedExtension) ⇒ Promise< | String>LicenseFileKind: interface of app-builder-lib/out/util/license
-Properties
file Stringlang StringlangWithRegion StringlangName Stringapp-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
| Param | -Type | -
|---|---|
| fileNames | -Array<String> |
-
| packager | -PlatformPackager<any> |
-
app-builder-lib/out/util/license.getLicenseFiles(packager) ⇒ Promise<Array<LicenseFile>>Kind: method of app-builder-lib/out/util/license
| Param | -Type | -
|---|---|
| packager | -PlatformPackager<any> |
-
app-builder-lib/out/util/license.getNotLocalizedLicenseFile(custom, packager, supportedExtension) ⇒ Promise< | String>Kind: method of app-builder-lib/out/util/license
| Param | -Type | -
|---|---|
| custom | -String | “undefined” | undefined |
-
| packager | -PlatformPackager<any> |
-
| supportedExtension | -Array<String> |
-
.isMacOsCatalina() ⇒ Boolean.isMacOsHighSierra() ⇒ Boolean.isMacOsSierra() ⇒ Promise<Boolean>app-builder-lib/out/util/macosVersion.isMacOsCatalina() ⇒ BooleanKind: method of app-builder-lib/out/util/macosVersion
-
app-builder-lib/out/util/macosVersion.isMacOsHighSierra() ⇒ BooleanKind: 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.expandMacro(pattern, arch, appInfo, extra, isProductNameSanitized) ⇒ StringKind: method of app-builder-lib/out/util/macroExpander
| Param | -Type | -
|---|---|
| pattern | -String |
-
| arch | -String | “undefined” | undefined |
-
| appInfo | -AppInfo |
-
| extra | -any |
-
| isProductNameSanitized | -- |
app-builder-lib/out/util/normalizePackageData.normalizePackageData(data)Kind: method of app-builder-lib/out/util/normalizePackageData
| Param | -Type | -
|---|---|
| data | -any |
-
.NodeModuleDirInfo.NodeModuleInfo.createLazyProductionDeps(projectDir, excludedDependencies) ⇒ Lazy<Array<any>>NodeModuleDirInfoKind: interface of app-builder-lib/out/util/packageDependencies
-Properties
dir Stringdeps Array<NodeModuleInfo>NodeModuleInfoKind: interface of app-builder-lib/out/util/packageDependencies
-Properties
name Stringapp-builder-lib/out/util/packageDependencies.createLazyProductionDeps(projectDir, excludedDependencies) ⇒ Lazy<Array<any>>Kind: method of app-builder-lib/out/util/packageDependencies
| Param | -Type | -
|---|---|
| projectDir | -String |
-
| excludedDependencies | -Array<String> | “undefined” |
-
.getTemplatePath(file) ⇒ String.getVendorPath(file) ⇒ Stringapp-builder-lib/out/util/pathManager.getTemplatePath(file) ⇒ StringKind: method of app-builder-lib/out/util/pathManager
| Param | -Type | -
|---|---|
| file | -String |
-
app-builder-lib/out/util/pathManager.getVendorPath(file) ⇒ StringKind: method of app-builder-lib/out/util/pathManager
| Param | -Type | -
|---|---|
| file | -String |
-
app-builder-lib/out/util/repositoryInfo.getRepositoryInfo(projectDir, metadata, devMetadata) ⇒ Promise< | SourceRepositoryInfo>Kind: method of app-builder-lib/out/util/repositoryInfo
| Param | -Type | -
|---|---|
| projectDir | -String |
-
| metadata | -Metadata |
-
| devMetadata | -Metadata | “undefined” |
-
.Timer
-.end()Timer
-.end().endAndGet() ⇒ String.time(label) ⇒ TimerTimerKind: interface of app-builder-lib/out/util/timer
-
timer.end()TimerKind: class of app-builder-lib/out/util/timer
-Extends: Timer
Timer
-.end().endAndGet() ⇒ StringdevTimer.end()Overrides: end
-
devTimer.endAndGet() ⇒ Stringapp-builder-lib/out/util/timer.time(label) ⇒ TimerKind: method of app-builder-lib/out/util/timer
| Param | -Type | -
|---|---|
| label | -String |
-
.DesktopFrameworkInfo.getGypEnv(frameworkInfo, platform, arch, buildFromSource) ⇒ any.installOrRebuild(config, appDir, options, forceInstall) ⇒ Promise<void>.nodeGypRebuild(platform, arch, frameworkInfo) ⇒ Promise<void>DesktopFrameworkInfoKind: interface of app-builder-lib/out/util/yarn
-Properties
version StringuseCustomDist Booleanapp-builder-lib/out/util/yarn.getGypEnv(frameworkInfo, platform, arch, buildFromSource) ⇒ anyKind: method of app-builder-lib/out/util/yarn
| Param | -Type | -
|---|---|
| frameworkInfo | -DesktopFrameworkInfo |
-
| platform | -“aix” | “android” | “darwin” | “freebsd” | “haiku” | “linux” | “openbsd” | “sunos” | “win32” | “cygwin” | “netbsd” |
-
| arch | -String |
-
| buildFromSource | -Boolean |
-
app-builder-lib/out/util/yarn.installOrRebuild(config, appDir, options, forceInstall) ⇒ Promise<void>Kind: method of app-builder-lib/out/util/yarn
| Param | -Type | -
|---|---|
| config | -Configuration |
-
| appDir | -String |
-
| options | -RebuildOptions |
-
| forceInstall | -- |
app-builder-lib/out/util/yarn.nodeGypRebuild(platform, arch, frameworkInfo) ⇒ Promise<void>Kind: method of app-builder-lib/out/util/yarn
| Param | -Type | -
|---|---|
| platform | -“aix” | “android” | “darwin” | “freebsd” | “haiku” | “linux” | “openbsd” | “sunos” | “win32” | “cygwin” | “netbsd” |
-
| arch | -String |
-
| frameworkInfo | -DesktopFrameworkInfo |
-
VmManager
-.exec(file, args, options, isLogOutIfDebug) ⇒ Promise<String>.spawn(file, args, options, extraOptions) ⇒ Promise<any>.toVmFile(file) ⇒ StringVmManagerKind: class of app-builder-lib/out/vm/MonoVm
-Extends: VmManager
VmManager
-.exec(file, args, options, isLogOutIfDebug) ⇒ Promise<String>.spawn(file, args, options, extraOptions) ⇒ Promise<any>.toVmFile(file) ⇒ StringmonoVmManager.exec(file, args, options, isLogOutIfDebug) ⇒ Promise<String>Overrides: exec
| Param | -Type | -
|---|---|
| file | -String |
-
| args | -Array<String> |
-
| options | -module:child_process.ExecFileOptions |
-
| isLogOutIfDebug | -- |
monoVmManager.spawn(file, args, options, extraOptions) ⇒ Promise<any>Overrides: spawn
| Param | -Type | -
|---|---|
| file | -String |
-
| args | -Array<String> |
-
| options | -module:child_process.SpawnOptions |
-
| extraOptions | -module:packages/builder-util/out/util.ExtraSpawnOptions |
-
monoVmManager.toVmFile(file) ⇒ String| Param | -Type | -
|---|---|
| file | -String |
-
.ParallelsVm.macPathToParallelsWindows(file) ⇒ StringParallelsVmKind: interface of app-builder-lib/out/vm/ParallelsVm
-Properties
id Stringname Stringos “win-10” | “win-11” | “ubuntu” | “elementary”state “running” | “suspended” | “stopped”app-builder-lib/out/vm/ParallelsVm.macPathToParallelsWindows(file) ⇒ StringKind: method of app-builder-lib/out/vm/ParallelsVm
| Param | -Type | -
|---|---|
| file | -String |
-
.exec(file, args, options, isLogOutIfDebug) ⇒ Promise<String>.spawn(file, args, options, extraOptions) ⇒ Promise<any>.toVmFile(file) ⇒ String.getWindowsVm(debugLogger) ⇒ Promise<VmManager>Kind: class of app-builder-lib/out/vm/vm
-Properties
pathSep StringMethods
-.exec(file, args, options, isLogOutIfDebug) ⇒ Promise<String>.spawn(file, args, options, extraOptions) ⇒ Promise<any>.toVmFile(file) ⇒ StringvmManager.exec(file, args, options, isLogOutIfDebug) ⇒ Promise<String>| Param | -Type | -
|---|---|
| file | -String |
-
| args | -Array<String> |
-
| options | -module:child_process.ExecFileOptions |
-
| isLogOutIfDebug | -- |
vmManager.spawn(file, args, options, extraOptions) ⇒ Promise<any>| Param | -Type | -
|---|---|
| file | -String |
-
| args | -Array<String> |
-
| options | -module:child_process.SpawnOptions |
-
| extraOptions | -module:packages/builder-util/out/util.ExtraSpawnOptions |
-
vmManager.toVmFile(file) ⇒ String| Param | -Type | -
|---|---|
| file | -String |
-
app-builder-lib/out/vm/vm.getWindowsVm(debugLogger) ⇒ Promise<VmManager>Kind: method of app-builder-lib/out/vm/vm
| Param | -Type | -
|---|---|
| debugLogger | -DebugLogger |
-
VmManager
-.exec(file, args, options, isLogOutIfDebug) ⇒ Promise<String>.spawn(file, args, options, extraOptions) ⇒ Promise<any>.toVmFile(file) ⇒ StringVmManagerKind: class of app-builder-lib/out/vm/WineVm
-Extends: VmManager
VmManager
-.exec(file, args, options, isLogOutIfDebug) ⇒ Promise<String>.spawn(file, args, options, extraOptions) ⇒ Promise<any>.toVmFile(file) ⇒ StringwineVmManager.exec(file, args, options, isLogOutIfDebug) ⇒ Promise<String>Overrides: exec
| Param | -Type | -
|---|---|
| file | -String |
-
| args | -Array<String> |
-
| options | -module:child_process.ExecFileOptions |
-
| isLogOutIfDebug | -- |
wineVmManager.spawn(file, args, options, extraOptions) ⇒ Promise<any>Overrides: spawn
| Param | -Type | -
|---|---|
| file | -String |
-
| args | -Array<String> |
-
| options | -module:child_process.SpawnOptions |
-
| extraOptions | -module:packages/builder-util/out/util.ExtraSpawnOptions |
-
wineVmManager.toVmFile(file) ⇒ StringOverrides: toVmFile
| Param | -Type | -
|---|---|
| file | -String |
-
PlatformPackager
-.createTargets(targets, mapper).getIconPath() ⇒ Promise< | String>.sign(file, logMessagePrefix) ⇒ Promise<Boolean>.signAndEditResources(file, arch, outDir, internalName, requestedExecutionLevel) ⇒ Promise<void>.artifactPatternConfig(targetSpecificOptions, defaultPattern) ⇒ module:app-builder-lib/out/platformPackager.__object.computeSafeArtifactName(suggestedName, ext, arch, skipDefaultArch, defaultArch, safePattern) ⇒ null | String.getDefaultFrameworkIcon() ⇒ null | String.dispatchArtifactCreated(file, target, arch, safeArtifactName) ⇒ Promise<void>.getElectronDestinationDir(appOutDir) ⇒ String.getElectronSrcDir(dist) ⇒ String.expandArtifactBeautyNamePattern(targetSpecificOptions, ext, arch) ⇒ String.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern, skipDefaultArch, defaultArch) ⇒ String.expandMacro(pattern, arch, extra, isProductNameSanitized) ⇒ String.generateName2(ext, classifier, deployment) ⇒ String.getMacOsResourcesDir(appOutDir) ⇒ String.pack(outDir, arch, targets, taskManager) ⇒ Promise<any>.resolveIcon(sources, fallbackSources, outputFormat) ⇒ Promise<Array<IconInfo>>.getResource(custom, names) ⇒ Promise< | String>.getResourcesDir(appOutDir) ⇒ String.getTempFile(suffix) ⇒ Promise<String>PlatformPackagerKind: class of app-builder-lib/out/winPackager
-Extends: PlatformPackager
-Properties
**<code id="WinPackager-[cscInfo=new Lazy<FileCodeSigningInfo | CertificateFromStoreInfo | null>(() => { -const platformSpecificBuildOptions = this.platformSpecificBuildOptions -if (platformSpecificBuildOptions.certificateSubjectName != null || platformSpecificBuildOptions.certificateSha1 != null) { -return this.vm.value -.then(vm => getCertificateFromStoreInfo(platformSpecificBuildOptions, vm)) -.catch((e: any) => { -// https://github.com/electron-userland/electron-builder/pull/2397 -if (platformSpecificBuildOptions.sign == null) { -throw e -} else { -log.debug({ error: e }, “getCertificateFromStoreInfo error”) -return null -} -}) -}
-const certificateFile = platformSpecificBuildOptions.certificateFile -if (certificateFile != null) { -const certificatePassword = this.getCscPassword() -return Promise.resolve({ -file: certificateFile, -password: certificatePassword == null ? null : certificatePassword.trim(), -}) -}
-const cscLink = this.getCscLink(“WIN_CSC_LINK”) -if (cscLink == null) { -return Promise.resolve(null) -}
-return (
-importCertificate(cscLink, this.info.tempDirManager, this.projectDir)
-// before then
-.catch((e: any) => {
-if (e instanceof InvalidConfigurationError) {
-throw new InvalidConfigurationError(Env WIN_CSC_LINK is not correct, cannot resolve: ${e.message})
-} else {
-throw e
-}
-})
-.then(path => {
-return {
-file: path,
-password: this.getCscPassword(),
-}
-})
-)
-})]">[cscInfo=new Lazy<FileCodeSigningInfo | CertificateFromStoreInfo | null>(() => {
-const platformSpecificBuildOptions = this.platformSpecificBuildOptions
-if (platformSpecificBuildOptions.certificateSubjectName != null || platformSpecificBuildOptions.certificateSha1 != null) {
-return this.vm.value
-.then(vm => getCertificateFromStoreInfo(platformSpecificBuildOptions, vm))
-.catch((e: any) => {
-// https://github.com/electron-userland/electron-builder/pull/2397
-if (platformSpecificBuildOptions.sign == null) {
-throw e
-} else {
-log.debug({ error: e }, “getCertificateFromStoreInfo error”)
-return null
-}
-})
-}
const certificateFile = platformSpecificBuildOptions.certificateFile -if (certificateFile != null) { -const certificatePassword = this.getCscPassword() -return Promise.resolve({ -file: certificateFile, -password: certificatePassword == null ? null : certificatePassword.trim(), -}) -}
-const cscLink = this.getCscLink(“WIN_CSC_LINK”) -if (cscLink == null) { -return Promise.resolve(null) -}
-return (
-importCertificate(cscLink, this.info.tempDirManager, this.projectDir)
-// before then
-.catch((e: any) => {
-if (e instanceof InvalidConfigurationError) {
-throw new InvalidConfigurationError(Env WIN_CSC_LINK is not correct, cannot resolve: ${e.message})
-} else {
-throw e
-}
-})
-.then(path => {
-return {
-file: path,
-password: this.getCscPassword(),
-}
-})
-)
-})]** Lazy< | FileCodeSigningInfo | CertificateFromStoreInfo>
vm = new Lazy<VmManager>(() => (process.platform === "win32" ? Promise.resolve(new VmManager()) : getWindowsVm(this.debugLogger))) Lazy<VmManager>
**<code id="WinPackager-[computedPublisherName=new Lazy<Array
const certInfo = await this.lazyCertInfo.value
-return certInfo == null ? null : [certInfo.commonName]
-})]">[computedPublisherName=new Lazy<Array
const certInfo = await this.lazyCertInfo.value -return certInfo == null ? null : [certInfo.commonName] -})]** Lazy< | Array>
-**<code id="WinPackager-[lazyCertInfo=new Lazy<CertificateInfo | null>(async () => { -const cscInfo = await this.cscInfo.value -if (cscInfo == null) { -return null -}
-if (“subject” in cscInfo) { -const bloodyMicrosoftSubjectDn = cscInfo.subject -return { -commonName: parseDn(bloodyMicrosoftSubjectDn).get(“CN”)!, -bloodyMicrosoftSubjectDn, -} -}
-const cscFile = cscInfo.file -if (cscFile == null) { -return null -} -return await getCertInfo(cscFile, cscInfo.password || “”) -})]">[lazyCertInfo=new Lazy<CertificateInfo | null>(async () => { -const cscInfo = await this.cscInfo.value -if (cscInfo == null) { -return null -}
-if (“subject” in cscInfo) { -const bloodyMicrosoftSubjectDn = cscInfo.subject -return { -commonName: parseDn(bloodyMicrosoftSubjectDn).get(“CN”)!, -bloodyMicrosoftSubjectDn, -} -}
-const cscFile = cscInfo.file -if (cscFile == null) { -return null -} -return await getCertInfo(cscFile, cscInfo.password || “”) -})]** Lazy< | CertificateInfo>
-isForceCodeSigningVerification Boolean
defaultTarget Array<String>
Methods
-PlatformPackager
-.createTargets(targets, mapper).getIconPath() ⇒ Promise< | String>.sign(file, logMessagePrefix) ⇒ Promise<Boolean>.signAndEditResources(file, arch, outDir, internalName, requestedExecutionLevel) ⇒ Promise<void>.artifactPatternConfig(targetSpecificOptions, defaultPattern) ⇒ module:app-builder-lib/out/platformPackager.__object.computeSafeArtifactName(suggestedName, ext, arch, skipDefaultArch, defaultArch, safePattern) ⇒ null | String.getDefaultFrameworkIcon() ⇒ null | String.dispatchArtifactCreated(file, target, arch, safeArtifactName) ⇒ Promise<void>.getElectronDestinationDir(appOutDir) ⇒ String.getElectronSrcDir(dist) ⇒ String.expandArtifactBeautyNamePattern(targetSpecificOptions, ext, arch) ⇒ String.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern, skipDefaultArch, defaultArch) ⇒ String.expandMacro(pattern, arch, extra, isProductNameSanitized) ⇒ String.generateName2(ext, classifier, deployment) ⇒ String.getMacOsResourcesDir(appOutDir) ⇒ String.pack(outDir, arch, targets, taskManager) ⇒ Promise<any>.resolveIcon(sources, fallbackSources, outputFormat) ⇒ Promise<Array<IconInfo>>.getResource(custom, names) ⇒ Promise< | String>.getResourcesDir(appOutDir) ⇒ String.getTempFile(suffix) ⇒ Promise<String>winPackager.createTargets(targets, mapper)Overrides: createTargets
| Param | -Type | -
|---|---|
| targets | -Array<String> |
-
| mapper | -callback |
-
winPackager.getIconPath() ⇒ Promise< | String>Overrides: getIconPath
-
winPackager.sign(file, logMessagePrefix) ⇒ Promise<Boolean>| Param | -Type | -
|---|---|
| file | -String |
-
| logMessagePrefix | -String |
-
winPackager.signAndEditResources(file, arch, outDir, internalName, requestedExecutionLevel) ⇒ Promise<void>| Param | -Type | -
|---|---|
| file | -String |
-
| arch | -Arch |
-
| outDir | -String |
-
| internalName | -String | “undefined” |
-
| requestedExecutionLevel | -“asInvoker” | “highestAvailable” | “requireAdministrator” | “undefined” |
-
winPackager.artifactPatternConfig(targetSpecificOptions, defaultPattern) ⇒ module:app-builder-lib/out/platformPackager.__object| Param | -Type | -
|---|---|
| targetSpecificOptions | -TargetSpecificOptions | “undefined” | undefined |
-
| defaultPattern | -String | undefined |
-
winPackager.computeSafeArtifactName(suggestedName, ext, arch, skipDefaultArch, defaultArch, safePattern) ⇒ null | String| Param | -Type | -
|---|---|
| suggestedName | -String | “undefined” |
-
| ext | -String |
-
| arch | -Arch | “undefined” |
-
| skipDefaultArch | -- |
| defaultArch | -String |
-
| safePattern | -- |
winPackager.getDefaultFrameworkIcon() ⇒ null | StringwinPackager.dispatchArtifactCreated(file, target, arch, safeArtifactName) ⇒ Promise<void>| Param | -Type | -
|---|---|
| file | -String |
-
| target | -Target | “undefined” |
-
| arch | -Arch | “undefined” |
-
| safeArtifactName | -String | “undefined” |
-
winPackager.getElectronDestinationDir(appOutDir) ⇒ String| Param | -Type | -
|---|---|
| appOutDir | -String |
-
winPackager.getElectronSrcDir(dist) ⇒ String| Param | -Type | -
|---|---|
| dist | -String |
-
winPackager.expandArtifactBeautyNamePattern(targetSpecificOptions, ext, arch) ⇒ String| Param | -Type | -
|---|---|
| targetSpecificOptions | -TargetSpecificOptions | “undefined” | undefined |
-
| ext | -String |
-
| arch | -Arch | “undefined” |
-
winPackager.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern, skipDefaultArch, defaultArch) ⇒ String| Param | -Type | -
|---|---|
| targetSpecificOptions | -TargetSpecificOptions | “undefined” | undefined |
-
| ext | -String |
-
| arch | -Arch | “undefined” |
-
| defaultPattern | -String |
-
| skipDefaultArch | -- |
| defaultArch | -String |
-
winPackager.expandMacro(pattern, arch, extra, isProductNameSanitized) ⇒ String| Param | -Type | -
|---|---|
| pattern | -String |
-
| arch | -String | “undefined” |
-
| extra | -any |
-
| isProductNameSanitized | -- |
winPackager.generateName2(ext, classifier, deployment) ⇒ String| Param | -Type | -
|---|---|
| ext | -String | “undefined” |
-
| classifier | -String | “undefined” | undefined |
-
| deployment | -Boolean |
-
winPackager.getMacOsResourcesDir(appOutDir) ⇒ String| Param | -Type | -
|---|---|
| appOutDir | -String |
-
winPackager.pack(outDir, arch, targets, taskManager) ⇒ Promise<any>| Param | -Type | -
|---|---|
| outDir | -String |
-
| arch | -Arch |
-
| targets | -Array<Target> |
-
| taskManager | -AsyncTaskManager |
-
winPackager.resolveIcon(sources, fallbackSources, outputFormat) ⇒ Promise<Array<IconInfo>>| Param | -Type | -
|---|---|
| sources | -Array<String> |
-
| fallbackSources | -Array<String> |
-
| outputFormat | -“set” | “icns” | “ico” |
-
winPackager.getResource(custom, names) ⇒ Promise< | String>| Param | -Type | -
|---|---|
| custom | -String | “undefined” | undefined |
-
| names | -Array<String> |
-
winPackager.getResourcesDir(appOutDir) ⇒ String| Param | -Type | -
|---|---|
| appOutDir | -String |
-
winPackager.getTempFile(suffix) ⇒ Promise<String>| Param | -Type | -
|---|---|
| suffix | -String |
-
.ArtifactBuildStarted.ArtifactCreated ⇐ module:packages/electron-publish/out/publisher.UploadTask.BeforeBuildContext.BuildResult.CertificateFromStoreInfo.FileCodeSigningInfo.Framework
-.afterPack(context) ⇒ Promise<any>.beforeCopyExtraFiles(options) ⇒ Promise<any>.createTransformer() ⇒ null | module:packages/builder-util/out/fs.__type.getDefaultIcon(platform) ⇒ null | String.getExcludedDependencies(platform) ⇒ null | Array.getMainFile(platform) ⇒ null | String.prepareApplicationStageDirectory(options) ⇒ Promise<any>.SourceRepositoryInfo.computePackageUrl() ⇒ Promise< | String>.getVersionInWeirdWindowsForm(isSetBuildNumber) ⇒ String._build(configuration, metadata, devMetadata, repositoryInfo) ⇒ Promise<BuildResult>.addAfterPackHandler(handler).afterPack(context) ⇒ Promise<any>.artifactCreated(handler) ⇒ Packager.build() ⇒ Promise<BuildResult>.callAppxManifestCreated(path) ⇒ Promise<void>.callArtifactBuildCompleted(event) ⇒ Promise<void>.callArtifactBuildStarted(event, logFields) ⇒ Promise<void>.callMsiProjectCreated(path) ⇒ Promise<void>.dispatchArtifactCreated(event).disposeOnBuildFinish(disposer).installAppDependencies(platform, arch) ⇒ Promise<any>.getNodeDependencyInfo(platform) ⇒ Lazy<Array<NodeModuleDirInfo>>.createTarget(type, archs) ⇒ Map<Platform | Map<Arch | Array<String>>>.current() ⇒ Platform.fromString(name) ⇒ Platform.toString() ⇒ String.artifactPatternConfig(targetSpecificOptions, defaultPattern) ⇒ module:app-builder-lib/out/platformPackager.__object.computeSafeArtifactName(suggestedName, ext, arch, skipDefaultArch, defaultArch, safePattern) ⇒ null | String.createTargets(targets, mapper).getDefaultFrameworkIcon() ⇒ null | String.dispatchArtifactCreated(file, target, arch, safeArtifactName) ⇒ Promise<void>.getElectronDestinationDir(appOutDir) ⇒ String.getElectronSrcDir(dist) ⇒ String.expandArtifactBeautyNamePattern(targetSpecificOptions, ext, arch) ⇒ String.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern, skipDefaultArch, defaultArch) ⇒ String.expandMacro(pattern, arch, extra, isProductNameSanitized) ⇒ String.generateName2(ext, classifier, deployment) ⇒ String.getIconPath() ⇒ Promise< | String>.getMacOsResourcesDir(appOutDir) ⇒ String.pack(outDir, arch, targets, taskManager) ⇒ Promise<any>.resolveIcon(sources, fallbackSources, outputFormat) ⇒ Promise<Array<IconInfo>>.getResource(custom, names) ⇒ Promise< | String>.getResourcesDir(appOutDir) ⇒ String.getTempFile(suffix) ⇒ Promise<String>module:packages/electron-publish/out/publisher.PublishContext
-.awaitTasks() ⇒ Promise<void>.cancelTasks().getGlobalPublishConfigurations() ⇒ Promise< | Array>.build(appOutDir, arch) ⇒ Promise<any>.finishBuild() ⇒ Promise<any>.build(options, packager) ⇒ Promise<Array<String>>.buildForge(forgeOptions, options) ⇒ Promise<Array<String>>ArtifactBuildStartedKind: interface of app-builder-lib
-Properties
targetPresentableName Stringfile Stringarch Arch | “undefined”ArtifactCreated ⇐ module:packages/electron-publish/out/publisher.UploadTaskKind: interface of app-builder-lib
-Extends: module:packages/electron-publish/out/publisher.UploadTask
-Properties
packager PlatformPackager<any>target Target | “undefined”updateInfo anysafeArtifactName String | “undefined”publishConfig PublishConfiguration | “undefined”isWriteUpdateInfo BooleanBeforeBuildContextKind: interface of app-builder-lib
-Properties
appDir StringelectronVersion Stringplatform Platformarch StringBuildResultKind: interface of app-builder-lib
-Properties
outDir StringartifactPaths Array<String>platformToTargets Map<Platform | Map<String | Target>>configuration ConfigurationCertificateFromStoreInfoKind: interface of app-builder-lib
-Properties
thumbprint Stringsubject Stringstore StringisLocalMachineStore BooleanFileCodeSigningInfoKind: interface of app-builder-lib
-Properties
file Stringpassword String | “undefined”FrameworkKind: interface of app-builder-lib
-Properties
name Stringversion StringdistMacOsAppName StringmacOsDefaultTargets Array<String>defaultAppIdPrefix StringisNpmRebuildRequired BooleanisCopyElevateHelper BooleanMethods
-.Framework
-.afterPack(context) ⇒ Promise<any>.beforeCopyExtraFiles(options) ⇒ Promise<any>.createTransformer() ⇒ null | module:packages/builder-util/out/fs.__type.getDefaultIcon(platform) ⇒ null | String.getExcludedDependencies(platform) ⇒ null | Array.getMainFile(platform) ⇒ null | String.prepareApplicationStageDirectory(options) ⇒ Promise<any>framework.afterPack(context) ⇒ Promise<any>| Param | -Type | -
|---|---|
| context | -module:app-builder-lib/out/configuration.PackContext |
-
framework.beforeCopyExtraFiles(options) ⇒ Promise<any>| Param | -Type | -
|---|---|
| options | -BeforeCopyExtraFilesOptions |
-
framework.createTransformer() ⇒ null | module:packages/builder-util/out/fs.__typeframework.getDefaultIcon(platform) ⇒ null | String| Param | -Type | -
|---|---|
| platform | -Platform |
-
framework.getExcludedDependencies(platform) ⇒ null | Array| Param | -Type | -
|---|---|
| platform | -Platform |
-
framework.getMainFile(platform) ⇒ null | String| Param | -Type | -
|---|---|
| platform | -Platform |
-
framework.prepareApplicationStageDirectory(options) ⇒ Promise<any>| Param | -Type | -
|---|---|
| options | -PrepareApplicationStageDirectoryOptions |
-
SourceRepositoryInfoKind: interface of app-builder-lib
-Properties
type Stringdomain Stringuser Stringproject StringKind: class of app-builder-lib
-Properties
description = smarten(this.info.metadata.description || "") Stringversion StringshortVersion String | undefinedshortVersionWindows String | undefinedbuildNumber String | undefinedbuildVersion StringproductName StringsanitizedProductName StringproductFilename Stringchannel String | “undefined”companyName String | “undefined”id StringmacBundleIdentifier Stringname StringlinuxPackageName StringsanitizedName StringupdaterCacheDirName Stringcopyright StringMethods
-.computePackageUrl() ⇒ Promise< | String>.getVersionInWeirdWindowsForm(isSetBuildNumber) ⇒ StringappInfo.computePackageUrl() ⇒ Promise< | String>appInfo.getVersionInWeirdWindowsForm(isSetBuildNumber) ⇒ String| Param | -
|---|
| isSetBuildNumber | -
Kind: class of app-builder-lib
-Properties
projectDir StringappDir Stringmetadata MetadataareNodeModulesHandledExternally BooleanisPrepackedAppAsar BooleandevMetadata Metadata | “undefined”config ConfigurationisTwoPackageJsonProjectLayoutUsed = false BooleaneventEmitter = new EventEmitter() module:events.EventEmitter_appInfo AppInfo | “undefined”appInfo AppInfotempDirManager = new TmpDir("packager") TmpDiroptions PackagerOptionsdebugLogger = new DebugLogger(log.isDebugEnabled) DebugLoggerrepositoryInfo Promise< | SourceRepositoryInfo>[stageDirPathCustomizer=(target, packager, arch) => {
-return path.join(target.outDir, __${target.name}-${getArtifactArchName(arch, target.name)})
-}] callbackbuildResourcesDir StringrelativeBuildResourcesDirname Stringframework FrameworkMethods
-._build(configuration, metadata, devMetadata, repositoryInfo) ⇒ Promise<BuildResult>.addAfterPackHandler(handler).afterPack(context) ⇒ Promise<any>.artifactCreated(handler) ⇒ Packager.build() ⇒ Promise<BuildResult>.callAppxManifestCreated(path) ⇒ Promise<void>.callArtifactBuildCompleted(event) ⇒ Promise<void>.callArtifactBuildStarted(event, logFields) ⇒ Promise<void>.callMsiProjectCreated(path) ⇒ Promise<void>.dispatchArtifactCreated(event).disposeOnBuildFinish(disposer).installAppDependencies(platform, arch) ⇒ Promise<any>.getNodeDependencyInfo(platform) ⇒ Lazy<Array<NodeModuleDirInfo>>packager._build(configuration, metadata, devMetadata, repositoryInfo) ⇒ Promise<BuildResult>| Param | -Type | -
|---|---|
| configuration | -Configuration |
-
| metadata | -Metadata |
-
| devMetadata | -Metadata | “undefined” |
-
| repositoryInfo | -SourceRepositoryInfo |
-
packager.addAfterPackHandler(handler)| Param | -Type | -
|---|---|
| handler | -callback |
-
packager.afterPack(context) ⇒ Promise<any>| Param | -Type | -
|---|---|
| context | -module:app-builder-lib/out/configuration.PackContext |
-
packager.artifactCreated(handler) ⇒ Packager| Param | -Type | -
|---|---|
| handler | -callback |
-
packager.build() ⇒ Promise<BuildResult>packager.callAppxManifestCreated(path) ⇒ Promise<void>| Param | -Type | -
|---|---|
| path | -String |
-
packager.callArtifactBuildCompleted(event) ⇒ Promise<void>| Param | -Type | -
|---|---|
| event | -ArtifactCreated |
-
packager.callArtifactBuildStarted(event, logFields) ⇒ Promise<void>| Param | -Type | -
|---|---|
| event | -ArtifactBuildStarted |
-
| logFields | -any |
-
packager.callMsiProjectCreated(path) ⇒ Promise<void>| Param | -Type | -
|---|---|
| path | -String |
-
packager.dispatchArtifactCreated(event)Only for sub artifacts (update info), for main artifacts use callArtifactBuildCompleted.
| Param | -Type | -
|---|---|
| event | -ArtifactCreated |
-
packager.disposeOnBuildFinish(disposer)| Param | -Type | -
|---|---|
| disposer | -callback |
-
packager.installAppDependencies(platform, arch) ⇒ Promise<any>| Param | -Type | -
|---|---|
| platform | -Platform |
-
| arch | -Arch |
-
packager.getNodeDependencyInfo(platform) ⇒ Lazy<Array<NodeModuleDirInfo>>| Param | -Type | -
|---|---|
| platform | -Platform | “undefined” |
-
Kind: class of app-builder-lib
-Properties
MAC = new Platform("mac", "mac", "darwin") PlatformLINUX = new Platform("linux", "linux", "linux") PlatformWINDOWS = new Platform("windows", "win", "win32") PlatformMethods
-.createTarget(type, archs) ⇒ Map<Platform | Map<Arch | Array<String>>>.current() ⇒ Platform.fromString(name) ⇒ Platform.toString() ⇒ Stringplatform.createTarget(type, archs) ⇒ Map<Platform | Map<Arch | Array<String>>>| Param | -Type | -
|---|---|
| type | -String | Array<String> | “undefined” |
-
| archs | -Array<Arch> |
-
platform.current() ⇒ Platformplatform.fromString(name) ⇒ Platform| Param | -Type | -
|---|---|
| name | -String |
-
platform.toString() ⇒ StringKind: class of app-builder-lib
-Properties
packagerOptions PackagerOptionsbuildResourcesDir StringprojectDir Stringconfig ConfigurationplatformSpecificBuildOptions module:app-builder-lib/out/platformPackager.DCresourceList Promise<Array<String>>appInfo AppInfocompression “store” | “normal” | “maximum”debugLogger DebugLoggerdefaultTarget Array<String>fileAssociations Array<FileAssociation>forceCodeSigning BooleanMethods
-.artifactPatternConfig(targetSpecificOptions, defaultPattern) ⇒ module:app-builder-lib/out/platformPackager.__object.computeSafeArtifactName(suggestedName, ext, arch, skipDefaultArch, defaultArch, safePattern) ⇒ null | String.createTargets(targets, mapper).getDefaultFrameworkIcon() ⇒ null | String.dispatchArtifactCreated(file, target, arch, safeArtifactName) ⇒ Promise<void>.getElectronDestinationDir(appOutDir) ⇒ String.getElectronSrcDir(dist) ⇒ String.expandArtifactBeautyNamePattern(targetSpecificOptions, ext, arch) ⇒ String.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern, skipDefaultArch, defaultArch) ⇒ String.expandMacro(pattern, arch, extra, isProductNameSanitized) ⇒ String.generateName2(ext, classifier, deployment) ⇒ String.getIconPath() ⇒ Promise< | String>.getMacOsResourcesDir(appOutDir) ⇒ String.pack(outDir, arch, targets, taskManager) ⇒ Promise<any>.resolveIcon(sources, fallbackSources, outputFormat) ⇒ Promise<Array<IconInfo>>.getResource(custom, names) ⇒ Promise< | String>.getResourcesDir(appOutDir) ⇒ String.getTempFile(suffix) ⇒ Promise<String>platformPackager.artifactPatternConfig(targetSpecificOptions, defaultPattern) ⇒ module:app-builder-lib/out/platformPackager.__object| Param | -Type | -
|---|---|
| targetSpecificOptions | -TargetSpecificOptions | “undefined” | undefined |
-
| defaultPattern | -String | undefined |
-
platformPackager.computeSafeArtifactName(suggestedName, ext, arch, skipDefaultArch, defaultArch, safePattern) ⇒ null | String| Param | -Type | -
|---|---|
| suggestedName | -String | “undefined” |
-
| ext | -String |
-
| arch | -Arch | “undefined” |
-
| skipDefaultArch | -- |
| defaultArch | -String |
-
| safePattern | -- |
platformPackager.createTargets(targets, mapper)| Param | -Type | -
|---|---|
| targets | -Array<String> |
-
| mapper | -callback |
-
platformPackager.getDefaultFrameworkIcon() ⇒ null | StringplatformPackager.dispatchArtifactCreated(file, target, arch, safeArtifactName) ⇒ Promise<void>| Param | -Type | -
|---|---|
| file | -String |
-
| target | -Target | “undefined” |
-
| arch | -Arch | “undefined” |
-
| safeArtifactName | -String | “undefined” |
-
platformPackager.getElectronDestinationDir(appOutDir) ⇒ String| Param | -Type | -
|---|---|
| appOutDir | -String |
-
platformPackager.getElectronSrcDir(dist) ⇒ String| Param | -Type | -
|---|---|
| dist | -String |
-
platformPackager.expandArtifactBeautyNamePattern(targetSpecificOptions, ext, arch) ⇒ String| Param | -Type | -
|---|---|
| targetSpecificOptions | -TargetSpecificOptions | “undefined” | undefined |
-
| ext | -String |
-
| arch | -Arch | “undefined” |
-
platformPackager.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern, skipDefaultArch, defaultArch) ⇒ String| Param | -Type | -
|---|---|
| targetSpecificOptions | -TargetSpecificOptions | “undefined” | undefined |
-
| ext | -String |
-
| arch | -Arch | “undefined” |
-
| defaultPattern | -String |
-
| skipDefaultArch | -- |
| defaultArch | -String |
-
platformPackager.expandMacro(pattern, arch, extra, isProductNameSanitized) ⇒ String| Param | -Type | -
|---|---|
| pattern | -String |
-
| arch | -String | “undefined” |
-
| extra | -any |
-
| isProductNameSanitized | -- |
platformPackager.generateName2(ext, classifier, deployment) ⇒ String| Param | -Type | -
|---|---|
| ext | -String | “undefined” |
-
| classifier | -String | “undefined” | undefined |
-
| deployment | -Boolean |
-
platformPackager.getIconPath() ⇒ Promise< | String>platformPackager.getMacOsResourcesDir(appOutDir) ⇒ String| Param | -Type | -
|---|---|
| appOutDir | -String |
-
platformPackager.pack(outDir, arch, targets, taskManager) ⇒ Promise<any>| Param | -Type | -
|---|---|
| outDir | -String |
-
| arch | -Arch |
-
| targets | -Array<Target> |
-
| taskManager | -AsyncTaskManager |
-
platformPackager.resolveIcon(sources, fallbackSources, outputFormat) ⇒ Promise<Array<IconInfo>>| Param | -Type | -
|---|---|
| sources | -Array<String> |
-
| fallbackSources | -Array<String> |
-
| outputFormat | -“set” | “icns” | “ico” |
-
platformPackager.getResource(custom, names) ⇒ Promise< | String>| Param | -Type | -
|---|---|
| custom | -String | “undefined” | undefined |
-
| names | -Array<String> |
-
platformPackager.getResourcesDir(appOutDir) ⇒ String| Param | -Type | -
|---|---|
| appOutDir | -String |
-
platformPackager.getTempFile(suffix) ⇒ Promise<String>| Param | -Type | -
|---|---|
| suffix | -String |
-
module:packages/electron-publish/out/publisher.PublishContextKind: class of app-builder-lib
-Extends: module:packages/electron-publish/out/publisher.PublishContext
-Properties
isPublish = false Booleanprogress = (process.stdout as TtyWriteStream).isTTY ? new MultiProgress() : null MultiProgressMethods
-module:packages/electron-publish/out/publisher.PublishContext
-.awaitTasks() ⇒ Promise<void>.cancelTasks().getGlobalPublishConfigurations() ⇒ Promise< | Array>publishManager.awaitTasks() ⇒ Promise<void>publishManager.cancelTasks()publishManager.getGlobalPublishConfigurations() ⇒ Promise< | Array>Kind: class of app-builder-lib
-Properties
outDir Stringoptions TargetSpecificOptions | “undefined” | undefinedMethods
-.build(appOutDir, arch) ⇒ Promise<any>.finishBuild() ⇒ Promise<any>target.build(appOutDir, arch) ⇒ Promise<any>| Param | -Type | -
|---|---|
| appOutDir | -String |
-
| arch | -Arch |
-
target.finishBuild() ⇒ Promise<any>app-builder-lib.build(options, packager) ⇒ Promise<Array<String>>Kind: method of app-builder-lib
| Param | -Type | -
|---|---|
| options | -PackagerOptions | module:packages/electron-publish/out/publisher.PublishOptions |
-
| packager | -Packager |
-
app-builder-lib.buildForge(forgeOptions, options) ⇒ Promise<Array<String>>Kind: method of app-builder-lib
| Param | -Type | -
|---|---|
| forgeOptions | -ForgeOptions |
-
| options | -PackagerOptions |
-
dmg-builder/out/dmgLicense.addLicenseToDmg(packager, dmgPath) ⇒ Promise< | module:dmg-builder/out/dmgLicense.__type>Kind: method of dmg-builder/out/dmgLicense
| Param | -Type | -
|---|---|
| packager | -PlatformPackager<any> |
-
| dmgPath | -String |
-
.LicenseButtonsFile.getLicenseButtons(licenseButtonFiles, langWithRegion, id, name) ⇒ Promise<String>.getLicenseButtonsFile(packager) ⇒ Promise<Array<LicenseButtonsFile>>LicenseButtonsFileKind: interface of dmg-builder/out/licenseButtons
-Properties
file Stringlang StringlangWithRegion StringlangName Stringdmg-builder/out/licenseButtons.getLicenseButtons(licenseButtonFiles, langWithRegion, id, name) ⇒ Promise<String>Kind: method of dmg-builder/out/licenseButtons
| Param | -Type | -
|---|---|
| licenseButtonFiles | -Array<LicenseButtonsFile> |
-
| langWithRegion | -String |
-
| id | -Number |
-
| name | -String |
-
dmg-builder/out/licenseButtons.getLicenseButtonsFile(packager) ⇒ Promise<Array<LicenseButtonsFile>>Kind: method of dmg-builder/out/licenseButtons
| Param | -Type | -
|---|---|
| packager | -PlatformPackager<any> |
-
dmg-builder/out/licenseDefaultButtons.getDefaultButtons(langWithRegion, id, name) ⇒ StringKind: method of dmg-builder/out/licenseDefaultButtons
| Param | -Type | -
|---|---|
| langWithRegion | -String |
-
| id | -Number |
-
| name | -String |
-
.attachAndExecute(dmgPath, readWrite, task) ⇒ Promise<any>.computeBackground(packager) ⇒ Promise<String>.detach(name) ⇒ Promise<void>.getDmgTemplatePath() ⇒ String.getDmgVendorPath() ⇒ Stringdmg-builder.attachAndExecute(dmgPath, readWrite, task) ⇒ Promise<any>Kind: method of dmg-builder
| Param | -Type | -
|---|---|
| dmgPath | -String |
-
| readWrite | -Boolean |
-
| task | -callback |
-
dmg-builder.computeBackground(packager) ⇒ Promise<String>Kind: method of dmg-builder
| Param | -Type | -
|---|---|
| packager | -PlatformPackager<any> |
-
dmg-builder.detach(name) ⇒ Promise<void>Kind: method of dmg-builder
| Param | -Type | -
|---|---|
| name | -String |
-
dmg-builder.getDmgTemplatePath() ⇒ StringKind: method of dmg-builder
-
dmg-builder.getDmgVendorPath() ⇒ StringKind: method of dmg-builder
-
.ReleaseHttpPublisher
-.deleteRelease() ⇒ Promise<any>.getRelease() ⇒ Promise<any>.toString() ⇒ String.upload(task) ⇒ Promise<any>ReleaseKind: interface of electron-publish/out/gitHubPublisher
-Properties
id Numbertag_name Stringdraft Booleanprerelease Booleanpublished_at Stringupload_url StringHttpPublisherKind: class of electron-publish/out/gitHubPublisher
-Extends: HttpPublisher
-Properties
_release = new Lazy(() => (this.token === "__test__" ? Promise.resolve(null as any) : this.getOrCreateRelease())) Lazy<any>providerName = github “github”Methods
-HttpPublisher
-.deleteRelease() ⇒ Promise<any>.getRelease() ⇒ Promise<any>.toString() ⇒ String.upload(task) ⇒ Promise<any>gitHubPublisher.deleteRelease() ⇒ Promise<any>gitHubPublisher.getRelease() ⇒ Promise<any>gitHubPublisher.toString() ⇒ StringgitHubPublisher.upload(task) ⇒ Promise<any>| Param | -Type | -
|---|---|
| task | -UploadTask |
-
Kind: class of electron-publish/out/multiProgress
multiProgress.createBar(format, options) ⇒ ProgressBar| Param | -Type | -
|---|---|
| format | -String |
-
| options | -any |
-
multiProgress.terminate()Kind: class of electron-publish/out/progress
-Properties
total = 0 NumberMethods
- - -progressBar.interrupt(message)“interrupt” the progress bar and write a message above it.
-| Param | -Type | -
|---|---|
| message | -String |
-
progressBar.render()progressBar.terminate()progressBar.tick(delta)“tick” the progress bar with optional len and optional tokens.
| Param | -Type | -
|---|---|
| delta | -Number |
-
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.
-| Param | -Type | -
|---|---|
| ratio | -Number |
-
.PublishContext.UploadTaskPublisher
-.upload(task) ⇒ Promise<any>.toString() ⇒ String.toString() ⇒ String.upload(task) ⇒ Promise<any>.getCiTag() ⇒ null | StringPublishContextKind: interface of electron-publish
-Properties
cancellationToken CancellationTokenprogress MultiProgress | “undefined”UploadTaskKind: interface of electron-publish
-Properties
file StringfileContent module:global.Buffer | “undefined”arch Arch | “undefined”safeArtifactName String | “undefined”timeout Number | “undefined”PublisherKind: class of electron-publish
-Extends: Publisher
Publisher
-.upload(task) ⇒ Promise<any>.toString() ⇒ StringhttpPublisher.upload(task) ⇒ Promise<any>Overrides: upload
| Param | -Type | -
|---|---|
| task | -UploadTask |
-
httpPublisher.toString() ⇒ StringKind: class of electron-publish
-
progressCallback.update(transferred, total)| Param | -Type | -
|---|---|
| transferred | -Number |
-
| total | -Number |
-
Kind: class of electron-publish
-Properties
providerName “github” | “s3” | “spaces” | “generic” | “custom” | “snapStore” | “keygen” | “bitbucket”Methods
-.toString() ⇒ String.upload(task) ⇒ Promise<any>publisher.toString() ⇒ Stringpublisher.upload(task) ⇒ Promise<any>| Param | -Type | -
|---|---|
| task | -UploadTask |
-
electron-publish.getCiTag() ⇒ null | StringKind: method of electron-publish
-
.AppAdapter
-.onQuit(handler).quit().relaunch().whenReady() ⇒ Promise<void>.getAppCacheDir() ⇒ StringAppAdapterKind: interface of electron-updater/out/AppAdapter
-Properties
version Stringname StringisPackaged BooleanappUpdateConfigPath String - Path to update metadata file.userDataPath String - Path to user data directory.baseCachePath String - Path to cache directory.Methods
-.AppAdapter
-.onQuit(handler).quit().relaunch().whenReady() ⇒ Promise<void>appAdapter.onQuit(handler)| Param | -Type | -
|---|---|
| handler | -callback |
-
appAdapter.quit()appAdapter.relaunch()appAdapter.whenReady() ⇒ Promise<void>electron-updater/out/AppAdapter.getAppCacheDir() ⇒ StringKind: method of electron-updater/out/AppAdapter
-
DownloadExecutorTaskKind: interface of electron-updater/out/AppUpdater
-Properties
fileExtension StringfileInfo ResolvedUpdateFileInfodownloadUpdateOptions DownloadUpdateOptionstask callbackdone callbackDownloadNotificationKind: interface of electron-updater/out/AppUpdater
-Properties
body Stringtitle StringUpdateInfoAndProviderKind: interface of electron-updater/out/AppUpdater
-Properties
info module:builder-util-runtime.UpdateInfoprovider Provider<any>AppUpdater
-.install(isSilent, isForceRunAfter) ⇒ Boolean.quitAndInstall(isSilent, isForceRunAfter).addAuthHeader(token).checkForUpdates() ⇒ Promise< | UpdateCheckResult>.checkForUpdatesAndNotify(downloadNotification) ⇒ Promise< | UpdateCheckResult>.downloadUpdate(cancellationToken) ⇒ Promise<Array<String>>.getFeedURL() ⇒ undefined | null | String.setFeedURL(options).isUpdaterActive() ⇒ BooleanAppUpdaterKind: class of electron-updater/out/BaseUpdater
-Extends: AppUpdater
AppUpdater
-.install(isSilent, isForceRunAfter) ⇒ Boolean.quitAndInstall(isSilent, isForceRunAfter).addAuthHeader(token).checkForUpdates() ⇒ Promise< | UpdateCheckResult>.checkForUpdatesAndNotify(downloadNotification) ⇒ Promise< | UpdateCheckResult>.downloadUpdate(cancellationToken) ⇒ Promise<Array<String>>.getFeedURL() ⇒ undefined | null | String.setFeedURL(options).isUpdaterActive() ⇒ BooleanbaseUpdater.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
-| Param | -Type | -
|---|---|
| token | -String |
-
baseUpdater.checkForUpdates() ⇒ Promise< | UpdateCheckResult>Asks the server whether there is an update.
- -baseUpdater.checkForUpdatesAndNotify(downloadNotification) ⇒ Promise< | UpdateCheckResult>| Param | -Type | -
|---|---|
| downloadNotification | -DownloadNotification |
-
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.
| Param | -Type | -
|---|---|
| cancellationToken | -CancellationToken |
-
baseUpdater.getFeedURL() ⇒ undefined | null | StringbaseUpdater.setFeedURL(options)Configure update provider. If value is string, GenericServerOptions will be set with value as url.
| Param | -Type | -Description | -
|---|---|---|
| options | -PublishConfiguration | 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 | String |
-If you want to override configuration in the app-update.yml. |
-
baseUpdater.isUpdaterActive() ⇒ Boolean.PartListDataTaskinternal:Writable
-
-.copyData(task, out, oldFileFd, reject, resolve)PartListDataTaskKind: interface of electron-updater/out/differentialDownloader/DataSplitter
-Properties
oldFileFd Numbertasks Array<Operation>start Numberend Numberinternal:WritableKind: class of electron-updater/out/differentialDownloader/DataSplitter
-Extends: internal:Writable
-Properties
partIndex = -1 NumberisFinished BooleandataSplitter._write(data, encoding, callback)| Param | -Type | -
|---|---|
| data | -module:global.Buffer |
-
| encoding | -String |
-
| callback | -callback |
-
electron-updater/out/differentialDownloader/DataSplitter.copyData(task, out, oldFileFd, reject, resolve)Kind: method of electron-updater/out/differentialDownloader/DataSplitter
| Param | -Type | -
|---|---|
| task | -Operation |
-
| out | -internal:Writable |
-
| oldFileFd | -Number |
-
| reject | -callback |
-
| resolve | -callback |
-
Kind: class of electron-updater/out/differentialDownloader/DifferentialDownloader
-Properties
fileMetadataBuffer module:global.Buffer | “undefined”.Operation.OperationKind : enum.computeOperations(oldBlockMap, newBlockMap, logger) ⇒ Array<Operation>OperationKind: interface of electron-updater/out/differentialDownloader/downloadPlanBuilder
-Properties
kind OperationKindstart Numberend Numberelectron-updater/out/differentialDownloader/downloadPlanBuilder.OperationKind : enumKind: enum of electron-updater/out/differentialDownloader/downloadPlanBuilder
-Properties
COPYDOWNLOADelectron-updater/out/differentialDownloader/downloadPlanBuilder.computeOperations(oldBlockMap, newBlockMap, logger) ⇒ Array<Operation>Kind: method of electron-updater/out/differentialDownloader/downloadPlanBuilder
| Param | -Type | -
|---|---|
| oldBlockMap | -module:builder-util-runtime/out/blockMapApi.BlockMap |
-
| newBlockMap | -module:builder-util-runtime/out/blockMapApi.BlockMap |
-
| logger | -Logger |
-
DifferentialDownloader
-.download() ⇒ Promise<void>DifferentialDownloaderKind: class of electron-updater/out/differentialDownloader/FileWithEmbeddedBlockMapDifferentialDownloader
-Extends: DifferentialDownloader
-
fileWithEmbeddedBlockMapDifferentialDownloader.download() ⇒ Promise<void>DifferentialDownloader
-.download(oldBlockMap, newBlockMap) ⇒ Promise<any>DifferentialDownloaderKind: class of electron-updater/out/differentialDownloader/GenericDifferentialDownloader
-Extends: DifferentialDownloader
-
genericDifferentialDownloader.download(oldBlockMap, newBlockMap) ⇒ Promise<any>| Param | -Type | -
|---|---|
| oldBlockMap | -module:builder-util-runtime/out/blockMapApi.BlockMap |
-
| newBlockMap | -module:builder-util-runtime/out/blockMapApi.BlockMap |
-
.checkIsRangesSupported(response, reject) ⇒ Boolean.executeTasksUsingMultipleRangeRequests(differentialDownloader, tasks, out, oldFileFd, reject) ⇒ module:electron-updater/out/differentialDownloader/multipleRangeDownloader.__typeelectron-updater/out/differentialDownloader/multipleRangeDownloader.checkIsRangesSupported(response, reject) ⇒ BooleanKind: method of electron-updater/out/differentialDownloader/multipleRangeDownloader
| Param | -Type | -
|---|---|
| response | -module:http.IncomingMessage |
-
| reject | -callback |
-
electron-updater/out/differentialDownloader/multipleRangeDownloader.executeTasksUsingMultipleRangeRequests(differentialDownloader, tasks, out, oldFileFd, reject) ⇒ module:electron-updater/out/differentialDownloader/multipleRangeDownloader.__typeKind: method of electron-updater/out/differentialDownloader/multipleRangeDownloader
| Param | -Type | -
|---|---|
| differentialDownloader | -DifferentialDownloader |
-
| tasks | -Array<Operation> |
-
| out | -internal:Writable |
-
| oldFileFd | -Number |
-
| reject | -callback |
-
ProgressDifferentialDownloadInfoKind: interface of electron-updater/out/differentialDownloader/ProgressDifferentialDownloadCallbackTransform
-Properties
expectedByteCounts Array<Number>grandTotal NumberProgressInfoKind: interface of electron-updater/out/differentialDownloader/ProgressDifferentialDownloadCallbackTransform
-Properties
total Numberdelta Numbertransferred Numberpercent NumberbytesPerSecond Numberinternal:TransformKind: class of electron-updater/out/differentialDownloader/ProgressDifferentialDownloadCallbackTransform
-Extends: internal:Transform
internal:Transform
-
-progressDifferentialDownloadCallbackTransform._flush(callback)| Param | -Type | -
|---|---|
| callback | -any |
-
progressDifferentialDownloadCallbackTransform._transform(chunk, encoding, callback)| Param | -Type | -
|---|---|
| chunk | -any |
-
| encoding | -String |
-
| callback | -any |
-
progressDifferentialDownloadCallbackTransform.beginFileCopy()progressDifferentialDownloadCallbackTransform.beginRangeDownload()progressDifferentialDownloadCallbackTransform.endRangeDownload()electron-updater/out/DownloadedUpdateHelper.createTempUpdateFile(name, cacheDir, log) ⇒ Promise<String>Kind: method of electron-updater/out/DownloadedUpdateHelper
| Param | -Type | -
|---|---|
| name | -String |
-
| cacheDir | -String |
-
| log | -Logger |
-
AppAdapter
-.onQuit(handler).quit().relaunch().whenReady() ⇒ Promise<void>AppAdapterKind: class of electron-updater/out/ElectronAppAdapter
-Extends: AppAdapter
-Properties
version Stringname StringisPackaged BooleanappUpdateConfigPath StringuserDataPath StringbaseCachePath StringMethods
-AppAdapter
-.onQuit(handler).quit().relaunch().whenReady() ⇒ Promise<void>electronAppAdapter.onQuit(handler)Overrides: onQuit
| Param | -Type | -
|---|---|
| handler | -callback |
-
electronAppAdapter.quit()Overrides: quit
-
electronAppAdapter.relaunch()Overrides: relaunch
-
electronAppAdapter.whenReady() ⇒ Promise<void>Overrides: whenReady
-
HttpExecutor
-.createRequest(options, callback) ⇒ Electron:ClientRequest.download(url, destination, options) ⇒ Promise<String>.getNetSession() ⇒ Electron:SessionHttpExecutorKind: class of electron-updater/out/electronHttpExecutor
-Extends: HttpExecutor
HttpExecutor
-.createRequest(options, callback) ⇒ Electron:ClientRequest.download(url, destination, options) ⇒ Promise<String>electronHttpExecutor.createRequest(options, callback) ⇒ Electron:ClientRequest| Param | -Type | -
|---|---|
| options | -any |
-
| callback | -callback |
-
electronHttpExecutor.download(url, destination, options) ⇒ Promise<String>| Param | -Type | -
|---|---|
| url | -URL |
-
| destination | -String |
-
| options | -module:builder-util-runtime/out/httpExecutor.DownloadOptions |
-
electron-updater/out/electronHttpExecutor.getNetSession() ⇒ Electron:SessionKind: method of electron-updater/out/electronHttpExecutor
-
electron-updater/out/providerFactory.createClient(data, updater, runtimeOptions) ⇒ Provider<any>Kind: method of electron-updater/out/providerFactory
| Param | -Type | -
|---|---|
| data | -PublishConfiguration | 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 |
-
| updater | -AppUpdater |
-
| runtimeOptions | -ProviderRuntimeOptions |
-
electron-updater/out/providerFactory.isUrlProbablySupportMultiRangeRequests(url) ⇒ BooleanKind: method of electron-updater/out/providerFactory
| Param | -Type | -
|---|---|
| url | -String |
-
Provider
-.getLatestVersion() ⇒ Promise<module:builder-util-runtime.UpdateInfo>.resolveFiles(updateInfo) ⇒ Array<ResolvedUpdateFileInfo>.toString() ⇒ String.setRequestHeaders(value)ProviderKind: class of electron-updater/out/providers/BitbucketProvider
-Extends: Provider
Provider
-.getLatestVersion() ⇒ Promise<module:builder-util-runtime.UpdateInfo>.resolveFiles(updateInfo) ⇒ Array<ResolvedUpdateFileInfo>.toString() ⇒ String.setRequestHeaders(value)bitbucketProvider.getLatestVersion() ⇒ Promise<module:builder-util-runtime.UpdateInfo>Overrides: getLatestVersion
-
bitbucketProvider.resolveFiles(updateInfo) ⇒ Array<ResolvedUpdateFileInfo>Overrides: resolveFiles
| Param | -Type | -
|---|---|
| updateInfo | -module:builder-util-runtime.UpdateInfo |
-
bitbucketProvider.toString() ⇒ StringbitbucketProvider.setRequestHeaders(value)| Param | -Type | -
|---|---|
| value | -[key: string]: string | “undefined” |
-
Provider
-.getLatestVersion() ⇒ Promise<module:builder-util-runtime.UpdateInfo>.resolveFiles(updateInfo) ⇒ Array<ResolvedUpdateFileInfo>.setRequestHeaders(value)ProviderKind: class of electron-updater/out/providers/GenericProvider
-Extends: Provider
Provider
-.getLatestVersion() ⇒ Promise<module:builder-util-runtime.UpdateInfo>.resolveFiles(updateInfo) ⇒ Array<ResolvedUpdateFileInfo>.setRequestHeaders(value)genericProvider.getLatestVersion() ⇒ Promise<module:builder-util-runtime.UpdateInfo>Overrides: getLatestVersion
-
genericProvider.resolveFiles(updateInfo) ⇒ Array<ResolvedUpdateFileInfo>Overrides: resolveFiles
| Param | -Type | -
|---|---|
| updateInfo | -module:builder-util-runtime.UpdateInfo |
-
genericProvider.setRequestHeaders(value)| Param | -Type | -
|---|---|
| value | -[key: string]: string | “undefined” |
-
Provider
-.getLatestVersion() ⇒ Promise<module:electron-updater/out/providers/Provider.T>.setRequestHeaders(value).resolveFiles(updateInfo) ⇒ Array<ResolvedUpdateFileInfo>BaseGitHubProvider
-.getLatestVersion() ⇒ Promise<module:electron-updater/out/providers/GitHubProvider.GithubUpdateInfo>.resolveFiles(updateInfo) ⇒ Array<ResolvedUpdateFileInfo>.setRequestHeaders(value).computeReleaseNotes(currentVersion, isFullChangelog, feed, latestRelease) ⇒ null | String | ArrayProviderKind: class of electron-updater/out/providers/GitHubProvider
-Extends: Provider
Provider
-.getLatestVersion() ⇒ Promise<module:electron-updater/out/providers/Provider.T>.setRequestHeaders(value).resolveFiles(updateInfo) ⇒ Array<ResolvedUpdateFileInfo>baseGitHubProvider.getLatestVersion() ⇒ Promise<module:electron-updater/out/providers/Provider.T>baseGitHubProvider.setRequestHeaders(value)| Param | -Type | -
|---|---|
| value | -[key: string]: string | “undefined” |
-
baseGitHubProvider.resolveFiles(updateInfo) ⇒ Array<ResolvedUpdateFileInfo>| Param | -Type | -
|---|---|
| updateInfo | -module:electron-updater/out/providers/Provider.T |
-
BaseGitHubProviderKind: class of electron-updater/out/providers/GitHubProvider
-Extends: BaseGitHubProvider
BaseGitHubProvider
-.getLatestVersion() ⇒ Promise<module:electron-updater/out/providers/GitHubProvider.GithubUpdateInfo>.resolveFiles(updateInfo) ⇒ Array<ResolvedUpdateFileInfo>.setRequestHeaders(value)gitHubProvider.getLatestVersion() ⇒ Promise<module:electron-updater/out/providers/GitHubProvider.GithubUpdateInfo>Overrides: getLatestVersion
-
gitHubProvider.resolveFiles(updateInfo) ⇒ Array<ResolvedUpdateFileInfo>Overrides: resolveFiles
| Param | -Type | -
|---|---|
| updateInfo | -module:electron-updater/out/providers/GitHubProvider.GithubUpdateInfo |
-
gitHubProvider.setRequestHeaders(value)| Param | -Type | -
|---|---|
| value | -[key: string]: string | “undefined” |
-
electron-updater/out/providers/GitHubProvider.computeReleaseNotes(currentVersion, isFullChangelog, feed, latestRelease) ⇒ null | String | ArrayKind: method of electron-updater/out/providers/GitHubProvider
| Param | -Type | -
|---|---|
| currentVersion | -SemVer |
-
| isFullChangelog | -Boolean |
-
| feed | -XElement |
-
| latestRelease | -any |
-
Provider
-.getLatestVersion() ⇒ Promise<module:builder-util-runtime.UpdateInfo>.resolveFiles(updateInfo) ⇒ Array<ResolvedUpdateFileInfo>.toString() ⇒ String.setRequestHeaders(value)ProviderKind: class of electron-updater/out/providers/KeygenProvider
-Extends: Provider
Provider
-.getLatestVersion() ⇒ Promise<module:builder-util-runtime.UpdateInfo>.resolveFiles(updateInfo) ⇒ Array<ResolvedUpdateFileInfo>.toString() ⇒ String.setRequestHeaders(value)keygenProvider.getLatestVersion() ⇒ Promise<module:builder-util-runtime.UpdateInfo>Overrides: getLatestVersion
-
keygenProvider.resolveFiles(updateInfo) ⇒ Array<ResolvedUpdateFileInfo>Overrides: resolveFiles
| Param | -Type | -
|---|---|
| updateInfo | -module:builder-util-runtime.UpdateInfo |
-
keygenProvider.toString() ⇒ StringkeygenProvider.setRequestHeaders(value)| Param | -Type | -
|---|---|
| value | -[key: string]: string | “undefined” |
-
.Asset.PrivateGitHubUpdateInfo ⇐ module:builder-util-runtime.UpdateInfoBaseGitHubProvider
-.getLatestVersion() ⇒ Promise<PrivateGitHubUpdateInfo>.resolveFiles(updateInfo) ⇒ Array<ResolvedUpdateFileInfo>.setRequestHeaders(value)AssetKind: interface of electron-updater/out/providers/PrivateGitHubProvider
-Properties
name Stringurl StringPrivateGitHubUpdateInfo ⇐ module:builder-util-runtime.UpdateInfoKind: interface of electron-updater/out/providers/PrivateGitHubProvider
-Extends: module:builder-util-runtime.UpdateInfo
-Properties
assets Array<Asset>BaseGitHubProviderKind: class of electron-updater/out/providers/PrivateGitHubProvider
-Extends: BaseGitHubProvider
-Properties
fileExtraDownloadHeaders [key: string]: string | “undefined”Methods
-BaseGitHubProvider
-.getLatestVersion() ⇒ Promise<PrivateGitHubUpdateInfo>.resolveFiles(updateInfo) ⇒ Array<ResolvedUpdateFileInfo>.setRequestHeaders(value)privateGitHubProvider.getLatestVersion() ⇒ Promise<PrivateGitHubUpdateInfo>Overrides: getLatestVersion
-
privateGitHubProvider.resolveFiles(updateInfo) ⇒ Array<ResolvedUpdateFileInfo>Overrides: resolveFiles
| Param | -Type | -
|---|---|
| updateInfo | -PrivateGitHubUpdateInfo |
-
privateGitHubProvider.setRequestHeaders(value)| Param | -Type | -
|---|---|
| value | -[key: string]: string | “undefined” |
-
.findFile(files, extension, not) ⇒ undefined | null | ResolvedUpdateFileInfo.getFileList(updateInfo) ⇒ Array<module:builder-util-runtime.UpdateFileInfo>.parseUpdateInfo(rawData, channelFile, channelFileUrl) ⇒ module:builder-util-runtime.UpdateInfo.resolveFiles(updateInfo, baseUrl, pathTransformer) ⇒ Array<ResolvedUpdateFileInfo>electron-updater/out/providers/Provider.findFile(files, extension, not) ⇒ undefined | null | ResolvedUpdateFileInfoKind: method of electron-updater/out/providers/Provider
| Param | -Type | -
|---|---|
| files | -Array<ResolvedUpdateFileInfo> |
-
| extension | -String |
-
| not | -Array<String> |
-
electron-updater/out/providers/Provider.getFileList(updateInfo) ⇒ Array<module:builder-util-runtime.UpdateFileInfo>Kind: method of electron-updater/out/providers/Provider
| Param | -Type | -
|---|---|
| updateInfo | -module:builder-util-runtime.UpdateInfo |
-
electron-updater/out/providers/Provider.parseUpdateInfo(rawData, channelFile, channelFileUrl) ⇒ module:builder-util-runtime.UpdateInfoKind: method of electron-updater/out/providers/Provider
| Param | -Type | -
|---|---|
| rawData | -String | “undefined” |
-
| channelFile | -String |
-
| channelFileUrl | -module:url.URL |
-
electron-updater/out/providers/Provider.resolveFiles(updateInfo, baseUrl, pathTransformer) ⇒ Array<ResolvedUpdateFileInfo>Kind: method of electron-updater/out/providers/Provider
| Param | -Type | -
|---|---|
| updateInfo | -module:builder-util-runtime.UpdateInfo |
-
| baseUrl | -module:url.URL |
-
| pathTransformer | -callback |
-
.blockmapFiles(baseUrl, oldVersion, newVersion) ⇒ Array<module:url.URL>.getChannelFilename(channel) ⇒ String.newUrlFromBase(pathname, baseUrl, addRandomQueryToAvoidCaching) ⇒ module:url.URLelectron-updater/out/util.blockmapFiles(baseUrl, oldVersion, newVersion) ⇒ Array<module:url.URL>Kind: method of electron-updater/out/util
| Param | -Type | -
|---|---|
| baseUrl | -module:url.URL |
-
| oldVersion | -String |
-
| newVersion | -String |
-
electron-updater/out/util.getChannelFilename(channel) ⇒ StringKind: method of electron-updater/out/util
| Param | -Type | -
|---|---|
| channel | -String |
-
electron-updater/out/util.newUrlFromBase(pathname, baseUrl, addRandomQueryToAvoidCaching) ⇒ module:url.URLKind: method of electron-updater/out/util
| Param | -Type | -
|---|---|
| pathname | -String |
-
| baseUrl | -module:url.URL |
-
| addRandomQueryToAvoidCaching | -- |
electron-updater/out/windowsExecutableCodeSignatureVerifier.verifySignature(publisherNames, unescapedTempUpdateFile, logger) ⇒ Promise< | String>Kind: method of electron-updater/out/windowsExecutableCodeSignatureVerifier
| Param | -Type | -
|---|---|
| publisherNames | -Array<String> |
-
| unescapedTempUpdateFile | -String |
-
| logger | -Logger |
-
.Logger
-
-.ResolvedUpdateFileInfo.UpdateCheckResult.UpdateDownloadedEvent ⇐ module:builder-util-runtime.UpdateInfoBaseUpdater
-.isUpdaterActive() ⇒ Boolean.install(isSilent, isForceRunAfter) ⇒ Boolean.quitAndInstall(isSilent, isForceRunAfter).addAuthHeader(token).checkForUpdates() ⇒ Promise< | UpdateCheckResult>.checkForUpdatesAndNotify(downloadNotification) ⇒ Promise< | UpdateCheckResult>.downloadUpdate(cancellationToken) ⇒ Promise<Array<String>>.getFeedURL() ⇒ undefined | null | String.setFeedURL(options)module:tiny-typed-emitter/lib/index.TypedEmitter
-.addAuthHeader(token).checkForUpdates() ⇒ Promise< | UpdateCheckResult>.checkForUpdatesAndNotify(downloadNotification) ⇒ Promise< | UpdateCheckResult>.downloadUpdate(cancellationToken) ⇒ Promise<Array<String>>.getFeedURL() ⇒ undefined | null | String.setFeedURL(options).isUpdaterActive() ⇒ Boolean.quitAndInstall(isSilent, isForceRunAfter)BaseUpdater
-.install(isSilent, isForceRunAfter) ⇒ Boolean.quitAndInstall(isSilent, isForceRunAfter).addAuthHeader(token).checkForUpdates() ⇒ Promise< | UpdateCheckResult>.checkForUpdatesAndNotify(downloadNotification) ⇒ Promise< | UpdateCheckResult>.downloadUpdate(cancellationToken) ⇒ Promise<Array<String>>.getFeedURL() ⇒ undefined | null | String.setFeedURL(options).isUpdaterActive() ⇒ BooleanAppUpdater
-.quitAndInstall().addAuthHeader(token).checkForUpdates() ⇒ Promise< | UpdateCheckResult>.checkForUpdatesAndNotify(downloadNotification) ⇒ Promise< | UpdateCheckResult>.downloadUpdate(cancellationToken) ⇒ Promise<Array<String>>.getFeedURL() ⇒ undefined | null | String.setFeedURL(options).isUpdaterActive() ⇒ BooleanBaseUpdater
-.install(isSilent, isForceRunAfter) ⇒ Boolean.quitAndInstall(isSilent, isForceRunAfter).addAuthHeader(token).checkForUpdates() ⇒ Promise< | UpdateCheckResult>.checkForUpdatesAndNotify(downloadNotification) ⇒ Promise< | UpdateCheckResult>.downloadUpdate(cancellationToken) ⇒ Promise<Array<String>>.getFeedURL() ⇒ undefined | null | String.setFeedURL(options).isUpdaterActive() ⇒ Boolean.getLatestVersion() ⇒ Promise<module:electron-updater/out/providers/Provider.T>.setRequestHeaders(value).resolveFiles(updateInfo) ⇒ Array<ResolvedUpdateFileInfo>BaseUpdater
-.install(isSilent, isForceRunAfter) ⇒ Boolean.quitAndInstall(isSilent, isForceRunAfter).addAuthHeader(token).checkForUpdates() ⇒ Promise< | UpdateCheckResult>.checkForUpdatesAndNotify(downloadNotification) ⇒ Promise< | UpdateCheckResult>.downloadUpdate(cancellationToken) ⇒ Promise<Array<String>>.getFeedURL() ⇒ undefined | null | String.setFeedURL(options).isUpdaterActive() ⇒ Boolean.autoUpdater : AppUpdaterLoggerKind: interface of electron-updater
.Logger
-
-logger.debug(message)| Param | -Type | -
|---|---|
| message | -String |
-
logger.error(message)| Param | -Type | -
|---|---|
| message | -any |
-
logger.info(message)| Param | -Type | -
|---|---|
| message | -any |
-
logger.warn(message)| Param | -Type | -
|---|---|
| message | -any |
-
ResolvedUpdateFileInfoKind: interface of electron-updater
-Properties
url module:url.URLinfo module:builder-util-runtime.UpdateFileInfopackageInfo module:builder-util-runtime.PackageFileInfoUpdateCheckResultKind: interface of electron-updater
-Properties
updateInfo module:builder-util-runtime.UpdateInfodownloadPromise Promise<Array<String>> | “undefined”cancellationToken CancellationTokenversionInfo module:builder-util-runtime.UpdateInfo - Deprecated:UpdateDownloadedEvent ⇐ module:builder-util-runtime.UpdateInfoKind: interface of electron-updater
-Extends: module:builder-util-runtime.UpdateInfo
-Properties
downloadedFile StringBaseUpdaterKind: class of electron-updater
-Extends: BaseUpdater
BaseUpdater
+.PublishContext.UploadTaskPublisher
.isUpdaterActive() ⇒ Boolean.install(isSilent, isForceRunAfter) ⇒ Boolean.quitAndInstall(isSilent, isForceRunAfter).addAuthHeader(token).checkForUpdates() ⇒ Promise< | UpdateCheckResult>.checkForUpdatesAndNotify(downloadNotification) ⇒ Promise< | UpdateCheckResult>.downloadUpdate(cancellationToken) ⇒ Promise<Array<String>>.getFeedURL() ⇒ undefined | null | String.setFeedURL(options).upload(task) ⇒ Promise<any>.toString() ⇒ StringappImageUpdater.isUpdaterActive() ⇒ BooleanOverrides: 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
-| Param | -Type | -
|---|---|
| token | -String |
-
appImageUpdater.checkForUpdates() ⇒ Promise< | UpdateCheckResult>Asks the server whether there is an update.
- -appImageUpdater.checkForUpdatesAndNotify(downloadNotification) ⇒ Promise< | UpdateCheckResult>| Param | -Type | -
|---|---|
| downloadNotification | -DownloadNotification |
-
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.
| Param | -Type | -
|---|---|
| cancellationToken | -CancellationToken |
-
appImageUpdater.getFeedURL() ⇒ undefined | null | StringappImageUpdater.setFeedURL(options)Configure update provider. If value is string, GenericServerOptions will be set with value as url.
| Param | -Type | -Description | -
|---|---|---|
| options | -PublishConfiguration | 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 | String |
-If you want to override configuration in the app-update.yml. |
-
module:tiny-typed-emitter/lib/index.TypedEmitterKind: class of electron-updater
-Extends: module:tiny-typed-emitter/lib/index.TypedEmitter
-Properties
autoDownload = true Boolean - Whether to automatically download an update when it is found.
autoInstallOnAppQuit = true Boolean - Whether to automatically install a downloaded update on app quit (if quitAndInstall was not called before).
autoRunAppAfterInstall = true Boolean - windows-only Whether to run the app after finish install when run the installer NOT in silent mode.
allowPrerelease = false Boolean - GitHub provider only. Whether to allow update to pre-release versions. Defaults to true if application version contains prerelease components (e.g. 0.12.1-alpha.1, here alpha is a prerelease component), otherwise false.
If true, downgrade will be allowed (allowDowngrade will be set to true).
fullChangelog = false Boolean - GitHub provider only. Get all release notes (from current version to latest), not just the latest.
allowDowngrade = false Boolean - Whether to allow version downgrade (when a user from the beta channel wants to go back to the stable channel).
Taken in account only if channel differs (pre-release version component in terms of semantic versioning).
-disableWebInstaller = false Boolean - Web installer files might not have signature verification, this switch prevents to load them unless it is needed.
Currently false to prevent breaking the current API, but it should be changed to default true at some point that breaking changes are allowed.
-forceDevUpdateConfig = false Boolean - Allows developer to force the updater to work in “dev” mode, looking for “dev-app-update.yml” instead of “app-update.yml” Dev: path.join(this.app.getAppPath(), "dev-app-update.yml") Prod: path.join(process.resourcesPath!, "app-update.yml")
currentVersion SemVer - The current application version.
channel String | “undefined” - Get the update channel. Not applicable for GitHub. Doesn’t return channel from the update configuration, only if was previously set.
requestHeaders [key: string]: string | “undefined” - The request headers.
netSession Electron:Session
logger Logger | “undefined” - The logger. You can pass electron-log, winston or another logger with the following interface: { info(), warn(), error() }. Set it to null if you would like to disable a logging feature.
signals = new UpdaterSignal(this) UpdaterSignal
configOnDisk = new Lazy<any>(() => this.loadUpdateConfig()) Lazy<any>
.update(transferred, total)httpExecutor ElectronHttpExecutor
.toString() ⇒ String.upload(task) ⇒ Promise<any>isAddNoCacheQuery Boolean
.getCiTag() ⇒ null | StringMethods
+ +PublishContextKind: interface of electron-publish
+Properties
module:tiny-typed-emitter/lib/index.TypedEmitter
+cancellationToken CancellationTokenprogress module:electron-publish/out/multiProgress.MultiProgress | “undefined”UploadTaskKind: interface of electron-publish
+Properties
.addAuthHeader(token).checkForUpdates() ⇒ Promise< | UpdateCheckResult>.checkForUpdatesAndNotify(downloadNotification) ⇒ Promise< | UpdateCheckResult>.downloadUpdate(cancellationToken) ⇒ Promise<Array<String>>.getFeedURL() ⇒ undefined | null | String.setFeedURL(options).isUpdaterActive() ⇒ Boolean.quitAndInstall(isSilent, isForceRunAfter)file StringfileContent module:global.Buffer | “undefined”arch Arch | “undefined”safeArtifactName String | “undefined”timeout Number | “undefined”PublisherKind: class of electron-publish
+Extends: Publisher
Publisher
+.upload(task) ⇒ Promise<any>.toString() ⇒ StringappUpdater.addAuthHeader(token)Shortcut for explicitly adding auth tokens to request headers
-| Param | -Type | -
|---|---|
| token | -String |
-
appUpdater.checkForUpdates() ⇒ Promise< | UpdateCheckResult>Asks the server whether there is an update.
- -appUpdater.checkForUpdatesAndNotify(downloadNotification) ⇒ Promise< | UpdateCheckResult>| Param | -Type | -
|---|---|
| downloadNotification | -DownloadNotification |
-
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
| cancellationToken | -CancellationToken |
+task | +UploadTask |
appUpdater.getFeedURL() ⇒ undefined | null | StringappUpdater.setFeedURL(options)Configure update provider. If value is string, GenericServerOptions will be set with value as url.
httpPublisher.toString() ⇒ StringKind: class of electron-publish
+
progressCallback.update(transferred, total)| Param | Type | -Description | ||
|---|---|---|---|---|
| options | -PublishConfiguration | 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 | String |
-If you want to override configuration in the app-update.yml. |
+transferred | +Number |
+
| total | +Number |
appUpdater.isUpdaterActive() ⇒ BooleanappUpdater.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.
Kind: class of electron-publish
+Properties
providerName “github” | “s3” | “spaces” | “generic” | “custom” | “snapStore” | “keygen” | “bitbucket”Methods
+.toString() ⇒ String.upload(task) ⇒ Promise<any>publisher.toString() ⇒ Stringpublisher.upload(task) ⇒ Promise<any>| Param | Type | -Description | ||
|---|---|---|---|---|
| isSilent | -Boolean |
-windows-only Runs the installer in silent mode. Defaults to false. |
-||
| isForceRunAfter | -Boolean |
-Run 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). |
+task | +UploadTask |
BaseUpdaterKind: class of electron-updater
-Extends: BaseUpdater
electron-publish.getCiTag() ⇒ null | StringKind: method of electron-publish
+
.Logger
+
+.ResolvedUpdateFileInfo.UpdateCheckResult.UpdateDownloadedEvent ⇐ module:builder-util-runtime.UpdateInfomodule:electron-updater/out/BaseUpdater.BaseUpdater
BaseUpdater
+.isUpdaterActive() ⇒ Booleanmodule:tiny-typed-emitter/lib/index.TypedEmitter
.install(isSilent, isForceRunAfter) ⇒ Boolean.quitAndInstall(isSilent, isForceRunAfter).addAuthHeader(token).checkForUpdates() ⇒ Promise< | UpdateCheckResult>.checkForUpdatesAndNotify(downloadNotification) ⇒ Promise< | UpdateCheckResult>.getFeedURL() ⇒ undefined | null | String.setFeedURL(options).isUpdaterActive() ⇒ Boolean.quitAndInstall(isSilent, isForceRunAfter)module:electron-updater/out/BaseUpdater.BaseUpdaterAppUpdater
+.quitAndInstall().addAuthHeader(token).checkForUpdates() ⇒ Promise< | UpdateCheckResult>.checkForUpdatesAndNotify(downloadNotification) ⇒ Promise< | UpdateCheckResult>.downloadUpdate(cancellationToken) ⇒ Promise<Array<String>>.getFeedURL() ⇒ undefined | null | String.setFeedURL(options).isUpdaterActive() ⇒ BooleandebUpdater.install(isSilent, isForceRunAfter) ⇒ Boolean| Param | -
|---|
| isSilent | -
| isForceRunAfter | -
debUpdater.quitAndInstall(isSilent, isForceRunAfter)| Param | -
|---|
| isSilent | -
| isForceRunAfter | -
debUpdater.addAuthHeader(token)Shortcut for explicitly adding auth tokens to request headers
+module:electron-updater/out/BaseUpdater.BaseUpdater.getLatestVersion() ⇒ Promise<module:electron-updater/out/providers/Provider.T>.setRequestHeaders(value).resolveFiles(updateInfo) ⇒ Array<ResolvedUpdateFileInfo>module:electron-updater/out/BaseUpdater.BaseUpdater.autoUpdater : AppUpdaterLoggerKind: interface of electron-updater
.Logger
+
+logger.debug(message)| token | +message | String |
debUpdater.checkForUpdates() ⇒ Promise< | UpdateCheckResult>Asks the server whether there is an update.
- -debUpdater.checkForUpdatesAndNotify(downloadNotification) ⇒ Promise< | UpdateCheckResult>logger.error(message)| downloadNotification | -DownloadNotification |
+message | +any |
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)| cancellationToken | -CancellationToken |
+message | +any |
debUpdater.getFeedURL() ⇒ undefined | null | StringdebUpdater.setFeedURL(options)Configure update provider. If value is string, GenericServerOptions will be set with value as url.
logger.warn(message)| Param | Type | -Description | ||
|---|---|---|---|---|
| options | -PublishConfiguration | 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 | String |
-If you want to override configuration in the app-update.yml. |
+message | +any |
debUpdater.isUpdaterActive() ⇒ BooleanAppUpdaterResolvedUpdateFileInfoKind: interface of electron-updater
+Properties
url module:url.URLinfo module:builder-util-runtime.UpdateFileInfopackageInfo module:builder-util-runtime.PackageFileInfoUpdateCheckResultKind: interface of electron-updater
+Properties
updateInfo module:builder-util-runtime.UpdateInfodownloadPromise Promise<Array<String>> | “undefined”cancellationToken CancellationTokenversionInfo module:builder-util-runtime.UpdateInfo - Deprecated:UpdateDownloadedEvent ⇐ module:builder-util-runtime.UpdateInfoKind: interface of electron-updater
+Extends: module:builder-util-runtime.UpdateInfo
+Properties
downloadedFile Stringmodule:electron-updater/out/BaseUpdater.BaseUpdaterKind: class of electron-updater
-Extends: AppUpdater
module:electron-updater/out/BaseUpdater.BaseUpdaterappImageUpdater.isUpdaterActive() ⇒ Booleanmodule:tiny-typed-emitter/lib/index.TypedEmitterKind: class of electron-updater
+Extends: module:tiny-typed-emitter/lib/index.TypedEmitter
+Properties
autoDownload = true Boolean - Whether to automatically download an update when it is found.
autoInstallOnAppQuit = true Boolean - Whether to automatically install a downloaded update on app quit (if quitAndInstall was not called before).
autoRunAppAfterInstall = true Boolean - windows-only Whether to run the app after finish install when run the installer NOT in silent mode.
allowPrerelease = false Boolean - GitHub provider only. Whether to allow update to pre-release versions. Defaults to true if application version contains prerelease components (e.g. 0.12.1-alpha.1, here alpha is a prerelease component), otherwise false.
If true, downgrade will be allowed (allowDowngrade will be set to true).
fullChangelog = false Boolean - GitHub provider only. Get all release notes (from current version to latest), not just the latest.
allowDowngrade = false Boolean - Whether to allow version downgrade (when a user from the beta channel wants to go back to the stable channel).
Taken in account only if channel differs (pre-release version component in terms of semantic versioning).
+disableWebInstaller = false Boolean - Web installer files might not have signature verification, this switch prevents to load them unless it is needed.
Currently false to prevent breaking the current API, but it should be changed to default true at some point that breaking changes are allowed.
+forceDevUpdateConfig = false Boolean - Allows developer to force the updater to work in “dev” mode, looking for “dev-app-update.yml” instead of “app-update.yml” Dev: path.join(this.app.getAppPath(), "dev-app-update.yml") Prod: path.join(process.resourcesPath!, "app-update.yml")
currentVersion SemVer - The current application version.
channel String | “undefined” - Get the update channel. Not applicable for GitHub. Doesn’t return channel from the update configuration, only if was previously set.
requestHeaders [key: string]: string | “undefined” - The request headers.
netSession Electron:Session
logger Logger | “undefined” - The logger. You can pass electron-log, winston or another logger with the following interface: { info(), warn(), error() }. Set it to null if you would like to disable a logging feature.
signals = new UpdaterSignal(this) UpdaterSignal
configOnDisk = new Lazy<any>(() => this.loadUpdateConfig()) Lazy<any>
httpExecutor module:electron-updater/out/electronHttpExecutor.ElectronHttpExecutor
isAddNoCacheQuery Boolean
Methods
AppUpdater
+module:tiny-typed-emitter/lib/index.TypedEmitter
.quitAndInstall().addAuthHeader(token).checkForUpdates() ⇒ Promise< | UpdateCheckResult>.checkForUpdatesAndNotify(downloadNotification) ⇒ Promise< | UpdateCheckResult>.getFeedURL() ⇒ undefined | null | String.setFeedURL(options).isUpdaterActive() ⇒ Boolean.quitAndInstall(isSilent, isForceRunAfter)macUpdater.quitAndInstall()Overrides: quitAndInstall
-
macUpdater.addAuthHeader(token)appUpdater.addAuthHeader(token)Shortcut for explicitly adding auth tokens to request headers
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>| downloadNotification | -DownloadNotification |
+module: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.
macUpdater.getFeedURL() ⇒ undefined | null | StringappUpdater.getFeedURL() ⇒ undefined | null | StringmacUpdater.setFeedURL(options)appUpdater.setFeedURL(options)Configure update provider. If value is string, GenericServerOptions will be set with value as url.
macUpdater.isUpdaterActive() ⇒ BooleanBaseUpdaterKind: class of electron-updater
-Extends: BaseUpdater
-Properties
installDirectory String - Specify custom install directory pathverifyUpdateCodeSignature module:electron-updater.__type - The verifyUpdateCodeSignature. You can pass win-verify-signature or another custom verify function: (publisherName: string[], path: string) => Promise<string | null>. The default verify function uses windowsExecutableCodeSignatureVerifierMethods
-BaseUpdater
-.install(isSilent, isForceRunAfter) ⇒ Boolean.quitAndInstall(isSilent, isForceRunAfter).addAuthHeader(token).checkForUpdates() ⇒ Promise< | UpdateCheckResult>.checkForUpdatesAndNotify(downloadNotification) ⇒ Promise< | UpdateCheckResult>.downloadUpdate(cancellationToken) ⇒ Promise<Array<String>>.getFeedURL() ⇒ undefined | null | String.setFeedURL(options).isUpdaterActive() ⇒ BooleannsisUpdater.install(isSilent, isForceRunAfter) ⇒ Boolean| Param | -
|---|
| isSilent | -
| isForceRunAfter | -
nsisUpdater.quitAndInstall(isSilent, isForceRunAfter)appUpdater.isUpdaterActive() ⇒ BooleanappUpdater.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.
| Param | +Type | +Description |
|---|---|---|
| isSilent | +Boolean |
+windows-only Runs the installer in silent mode. Defaults to false. |
| isForceRunAfter | +Boolean |
+Run 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)module:electron-updater/out/BaseUpdater.BaseUpdaterKind: class of electron-updater
+Extends: module:electron-updater/out/BaseUpdater.BaseUpdater
+
AppUpdaterKind: class of electron-updater
+Extends: AppUpdater
AppUpdater
+.quitAndInstall().addAuthHeader(token).checkForUpdates() ⇒ Promise< | UpdateCheckResult>.checkForUpdatesAndNotify(downloadNotification) ⇒ Promise< | UpdateCheckResult>.downloadUpdate(cancellationToken) ⇒ Promise<Array<String>>.getFeedURL() ⇒ undefined | null | String.setFeedURL(options).isUpdaterActive() ⇒ BooleanmacUpdater.quitAndInstall()Overrides: quitAndInstall
+
macUpdater.addAuthHeader(token)Shortcut for explicitly adding auth tokens to request headers
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>| downloadNotification | -DownloadNotification |
+module: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.
nsisUpdater.getFeedURL() ⇒ undefined | null | StringmacUpdater.getFeedURL() ⇒ undefined | null | StringnsisUpdater.setFeedURL(options)macUpdater.setFeedURL(options)Configure update provider. If value is string, GenericServerOptions will be set with value as url.
nsisUpdater.isUpdaterActive() ⇒ BooleanmacUpdater.isUpdaterActive() ⇒ Booleanmodule:electron-updater/out/BaseUpdater.BaseUpdaterKind: class of electron-updater
+Extends: module:electron-updater/out/BaseUpdater.BaseUpdater
+Properties
installDirectory String - Specify custom install directory pathverifyUpdateCodeSignature module:electron-updater.__type - The verifyUpdateCodeSignature. You can pass win-verify-signature or another custom verify function: (publisherName: string[], path: string) => Promise<string | null>. The default verify function uses windowsExecutableCodeSignatureVerifierKind: class of electron-updater
@@ -10796,136 +1926,10 @@ This is different from the normal quit event sequence.
BaseUpdatermodule:electron-updater/out/BaseUpdater.BaseUpdaterKind: class of electron-updater
-Extends: BaseUpdater
BaseUpdater
-.install(isSilent, isForceRunAfter) ⇒ Boolean.quitAndInstall(isSilent, isForceRunAfter).addAuthHeader(token).checkForUpdates() ⇒ Promise< | UpdateCheckResult>.checkForUpdatesAndNotify(downloadNotification) ⇒ Promise< | UpdateCheckResult>.downloadUpdate(cancellationToken) ⇒ Promise<Array<String>>.getFeedURL() ⇒ undefined | null | String.setFeedURL(options).isUpdaterActive() ⇒ BooleanrpmUpdater.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
-| Param | -Type | -
|---|---|
| token | -String |
-
rpmUpdater.checkForUpdates() ⇒ Promise< | UpdateCheckResult>Asks the server whether there is an update.
- -rpmUpdater.checkForUpdatesAndNotify(downloadNotification) ⇒ Promise< | UpdateCheckResult>| Param | -Type | -
|---|---|
| downloadNotification | -DownloadNotification |
-
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.
| Param | -Type | -
|---|---|
| cancellationToken | -CancellationToken |
-
rpmUpdater.getFeedURL() ⇒ undefined | null | StringrpmUpdater.setFeedURL(options)Configure update provider. If value is string, GenericServerOptions will be set with value as url.
| Param | -Type | -Description | -
|---|---|---|
| options | -PublishConfiguration | 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 | String |
-If you want to override configuration in the app-update.yml. |
-
rpmUpdater.isUpdaterActive() ⇒ Booleanmodule:electron-updater/out/BaseUpdater.BaseUpdaterKind: class of electron-updater
undefined
category String | “undefined” - The application category type, as shown in the Finder via View -> Arrange by Application Category when viewing the Applications directory.
notarize NotarizeLegacyOptions | NotarizeNotaryOptions | Boolean | “undefined” - 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)
undefined
+appBundleId String | “undefined” - The app bundle identifier your Electron app is using. E.g. com.github.electron. Useful if notarization ID differs from app ID (unlikely). Only used by legacy notarization toolascProvider String | “undefined” - Your Team Short Name. Only used by legacy notarization toolundefined
+teamId String - The team ID you want to notarize under for when using notarytool/ String | “undefined” - The directory path.
undefined
+provider “custom” - The provider. Must be custom.updateProvider module:builder-util-runtime/out/publishOptions.__type - The Provider to provide UpdateInfo regarding available updates. Required to use custom providers with electron-updater.Inherited from PublishConfiguration:
publishAutoUpdate = true Boolean - Whether to publish auto update info files.
Auto update relies only on the first provider in the list (you can specify several publishers). Thus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.
+requestHeaders module:http.OutgoingHttpHeaders - Any custom request headers
timeout = 120000 Number | “undefined” - Request timeout in milliseconds. (Default is 2 minutes; O is ignored)