From e8d1d0d508c7fc099f6ad700e5e35c5b40b3ad7d Mon Sep 17 00:00:00 2001 From: develar Date: Thu, 9 Mar 2017 18:23:10 +0100 Subject: [PATCH] feat(nsis): always add plugin dir to override nsis plugins --- docs/API.md | 6646 ++++++++++++++--- docs/Options.md | 3 +- jsdoc/scope.hbs | 10 + package.json | 7 +- packages/electron-builder-core/src/core.ts | 34 +- packages/electron-builder-core/tsconfig.json | 1 + .../src/publishOptions.ts | 92 +- packages/electron-builder-util/src/util.ts | 15 + packages/electron-builder-util/tsconfig.json | 1 + packages/electron-builder/src/asarUtil.ts | 2 +- packages/electron-builder/src/index.ts | 10 +- packages/electron-builder/src/metadata.ts | 58 +- packages/electron-builder/src/packager.ts | 3 + packages/electron-builder/src/packager/mac.ts | 3 +- .../electron-builder/src/platformPackager.ts | 4 +- .../electron-builder/src/repositoryInfo.ts | 3 +- .../electron-builder/src/targets/archive.ts | 2 +- packages/electron-builder/src/targets/nsis.ts | 8 +- .../electron-builder/templates/nsis/langs.nsh | 4 +- .../templates/nsis/oneClick.nsh | 6 +- packages/electron-builder/tsconfig.json | 1 + packages/electron-publish/tsconfig.json | 1 + test/src/windows/oneClickInstallerTest.ts | 1 - 23 files changed, 5817 insertions(+), 1098 deletions(-) create mode 100644 jsdoc/scope.hbs diff --git a/docs/API.md b/docs/API.md index 474f73575c7..b32aba367ac 100644 --- a/docs/API.md +++ b/docs/API.md @@ -1,98 +1,343 @@ ## Modules -* [electron-updater/out/AppUpdater](#module_electron-updater/out/AppUpdater) - * [`.Logger`](#module_electron-updater/out/AppUpdater.Logger) - * [`.error(message)`](#module_electron-updater/out/AppUpdater.Logger+error) - * [`.info(message)`](#module_electron-updater/out/AppUpdater.Logger+info) - * [`.warn(message)`](#module_electron-updater/out/AppUpdater.Logger+warn) - * [.AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) ⇐ internal:EventEmitter - * [`.checkForUpdates()`](#module_electron-updater/out/AppUpdater.AppUpdater+checkForUpdates) ⇒ Promise - * [`.downloadUpdate(cancellationToken)`](#module_electron-updater/out/AppUpdater.AppUpdater+downloadUpdate) ⇒ Promise - * [`.getFeedURL()`](#module_electron-updater/out/AppUpdater.AppUpdater+getFeedURL) ⇒ - * [`.setFeedURL(options)`](#module_electron-updater/out/AppUpdater.AppUpdater+setFeedURL) - * [`.loadUpdateConfig()`](#module_electron-updater/out/AppUpdater.AppUpdater+loadUpdateConfig) ⇒ Promise - * [`.quitAndInstall()`](#module_electron-updater/out/AppUpdater.AppUpdater+quitAndInstall) - * [`.dispatchError(e)`](#module_electron-updater/out/AppUpdater.AppUpdater+dispatchError) - * [`.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)`](#module_electron-updater/out/AppUpdater.AppUpdater+doDownloadUpdate) ⇒ Promise - * [`.onUpdateAvailable(versionInfo, fileInfo)`](#module_electron-updater/out/AppUpdater.AppUpdater+onUpdateAvailable) -* [electron-updater/out/BintrayProvider](#module_electron-updater/out/BintrayProvider) - * [.BintrayProvider](#module_electron-updater/out/BintrayProvider.BintrayProvider) ⇐ [Provider](#module_electron-updater/out/api.Provider) - * [`.getLatestVersion()`](#module_electron-updater/out/BintrayProvider.BintrayProvider+getLatestVersion) ⇒ Promise - * [`.getUpdateFile(versionInfo)`](#module_electron-updater/out/BintrayProvider.BintrayProvider+getUpdateFile) ⇒ Promise - * [`.setRequestHeaders(value)`](#module_electron-updater/out/api.Provider+setRequestHeaders) -* [electron-updater/out/GenericProvider](#module_electron-updater/out/GenericProvider) - * [.GenericProvider](#module_electron-updater/out/GenericProvider.GenericProvider) ⇐ [Provider](#module_electron-updater/out/api.Provider) - * [`.getLatestVersion()`](#module_electron-updater/out/GenericProvider.GenericProvider+getLatestVersion) ⇒ Promise - * [`.getUpdateFile(versionInfo)`](#module_electron-updater/out/GenericProvider.GenericProvider+getUpdateFile) ⇒ Promise - * [`.setRequestHeaders(value)`](#module_electron-updater/out/api.Provider+setRequestHeaders) - * [`.validateUpdateInfo(info)`](#module_electron-updater/out/GenericProvider.validateUpdateInfo) -* [electron-updater/out/GitHubProvider](#module_electron-updater/out/GitHubProvider) - * [.GitHubProvider](#module_electron-updater/out/GitHubProvider.GitHubProvider) ⇐ [Provider](#module_electron-updater/out/api.Provider) - * [`.getLatestVersion()`](#module_electron-updater/out/GitHubProvider.GitHubProvider+getLatestVersion) ⇒ Promise - * [`.getUpdateFile(versionInfo)`](#module_electron-updater/out/GitHubProvider.GitHubProvider+getUpdateFile) ⇒ Promise - * [`.setRequestHeaders(value)`](#module_electron-updater/out/api.Provider+setRequestHeaders) -* [electron-updater/out/MacUpdater](#module_electron-updater/out/MacUpdater) - * [.MacUpdater](#module_electron-updater/out/MacUpdater.MacUpdater) ⇐ [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) - * [`.quitAndInstall()`](#module_electron-updater/out/MacUpdater.MacUpdater+quitAndInstall) - * [`.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)`](#module_electron-updater/out/MacUpdater.MacUpdater+doDownloadUpdate) ⇒ module:bluebird-lst.Bluebird - * [`.onUpdateAvailable(versionInfo, fileInfo)`](#module_electron-updater/out/MacUpdater.MacUpdater+onUpdateAvailable) - * [`.checkForUpdates()`](#module_electron-updater/out/AppUpdater.AppUpdater+checkForUpdates) ⇒ Promise - * [`.downloadUpdate(cancellationToken)`](#module_electron-updater/out/AppUpdater.AppUpdater+downloadUpdate) ⇒ Promise - * [`.getFeedURL()`](#module_electron-updater/out/AppUpdater.AppUpdater+getFeedURL) ⇒ - * [`.setFeedURL(options)`](#module_electron-updater/out/AppUpdater.AppUpdater+setFeedURL) - * [`.loadUpdateConfig()`](#module_electron-updater/out/AppUpdater.AppUpdater+loadUpdateConfig) ⇒ Promise - * [`.dispatchError(e)`](#module_electron-updater/out/AppUpdater.AppUpdater+dispatchError) -* [electron-updater/out/NsisUpdater](#module_electron-updater/out/NsisUpdater) - * [.NsisUpdater](#module_electron-updater/out/NsisUpdater.NsisUpdater) ⇐ [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) - * [`.quitAndInstall()`](#module_electron-updater/out/NsisUpdater.NsisUpdater+quitAndInstall) - * [`.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)`](#module_electron-updater/out/NsisUpdater.NsisUpdater+doDownloadUpdate) ⇒ Promise - * [`.checkForUpdates()`](#module_electron-updater/out/AppUpdater.AppUpdater+checkForUpdates) ⇒ Promise - * [`.downloadUpdate(cancellationToken)`](#module_electron-updater/out/AppUpdater.AppUpdater+downloadUpdate) ⇒ Promise - * [`.getFeedURL()`](#module_electron-updater/out/AppUpdater.AppUpdater+getFeedURL) ⇒ - * [`.setFeedURL(options)`](#module_electron-updater/out/AppUpdater.AppUpdater+setFeedURL) - * [`.loadUpdateConfig()`](#module_electron-updater/out/AppUpdater.AppUpdater+loadUpdateConfig) ⇒ Promise - * [`.dispatchError(e)`](#module_electron-updater/out/AppUpdater.AppUpdater+dispatchError) - * [`.onUpdateAvailable(versionInfo, fileInfo)`](#module_electron-updater/out/AppUpdater.AppUpdater+onUpdateAvailable) -* [electron-updater/out/api](#module_electron-updater/out/api) - * [`.FileInfo`](#module_electron-updater/out/api.FileInfo) - * [`.UpdateCheckResult`](#module_electron-updater/out/api.UpdateCheckResult) - * [.Provider](#module_electron-updater/out/api.Provider) - * [`.getLatestVersion()`](#module_electron-updater/out/api.Provider+getLatestVersion) ⇒ Promise - * [`.setRequestHeaders(value)`](#module_electron-updater/out/api.Provider+setRequestHeaders) - * [`.getUpdateFile(versionInfo)`](#module_electron-updater/out/api.Provider+getUpdateFile) ⇒ Promise - * [.UpdaterSignal](#module_electron-updater/out/api.UpdaterSignal) - * [`.progress(handler)`](#module_electron-updater/out/api.UpdaterSignal+progress) - * [`.updateCancelled(handler)`](#module_electron-updater/out/api.UpdaterSignal+updateCancelled) - * [`.updateDownloaded(handler)`](#module_electron-updater/out/api.UpdaterSignal+updateDownloaded) - * [`.getDefaultChannelName()`](#module_electron-updater/out/api.getDefaultChannelName) ⇒ string - * [`.getCustomChannelName(channel)`](#module_electron-updater/out/api.getCustomChannelName) ⇒ string - * [`.getCurrentPlatform()`](#module_electron-updater/out/api.getCurrentPlatform) ⇒ - * [`.getChannelFilename(channel)`](#module_electron-updater/out/api.getChannelFilename) ⇒ string -* [electron-updater/out/electronHttpExecutor](#module_electron-updater/out/electronHttpExecutor) - * [.ElectronHttpExecutor](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor) ⇐ [HttpExecutor](#module_electron-builder-http.HttpExecutor) - * [`.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+doApiRequest) ⇒ Promise - * [`.download(url, destination, options)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+download) ⇒ Promise - * [`.doRequest(options, callback)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+doRequest) ⇒ - * [`.request(options, cancellationToken, data)`](#module_electron-builder-http.HttpExecutor+request) ⇒ Promise - * [`.addTimeOutHandler(request, callback)`](#module_electron-builder-http.HttpExecutor+addTimeOutHandler) - * [`.doDownload(requestOptions, destination, redirectCount, options, callback, onCancel)`](#module_electron-builder-http.HttpExecutor+doDownload) - * [`.handleResponse(response, options, cancellationToken, resolve, reject, redirectCount, requestProcessor)`](#module_electron-builder-http.HttpExecutor+handleResponse) -* [electron-updater](#module_electron-updater) - * [`.autoUpdater`](#module_electron-updater.autoUpdater) : [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) +* [electron-builder/out/appInfo](#module_electron-builder/out/appInfo) + * [.AppInfo](#module_electron-builder/out/appInfo.AppInfo) + * [`.computePackageUrl()`](#module_electron-builder/out/appInfo.AppInfo+computePackageUrl) ⇒ Promise +* [electron-builder/out/asar](#module_electron-builder/out/asar) + * [.AsarFilesystem](#module_electron-builder/out/asar.AsarFilesystem) + * [`.getFile(p, followLinks)`](#module_electron-builder/out/asar.AsarFilesystem+getFile) ⇒ [Node](#module_electron-builder/out/asar.Node) + * [`.insertDirectory(p, unpacked)`](#module_electron-builder/out/asar.AsarFilesystem+insertDirectory) ⇒ module:electron-builder/out/asar.__type + * [`.insertFileNode(node, stat, file)`](#module_electron-builder/out/asar.AsarFilesystem+insertFileNode) + * [`.getNode(p)`](#module_electron-builder/out/asar.AsarFilesystem+getNode) ⇒ [Node](#module_electron-builder/out/asar.Node) + * [`.getOrCreateNode(p)`](#module_electron-builder/out/asar.AsarFilesystem+getOrCreateNode) ⇒ [Node](#module_electron-builder/out/asar.Node) + * [`.readFile(file)`](#module_electron-builder/out/asar.AsarFilesystem+readFile) ⇒ Promise + * [`.readJson(file)`](#module_electron-builder/out/asar.AsarFilesystem+readJson) ⇒ Promise + * [`.searchNodeFromDirectory(p)`](#module_electron-builder/out/asar.AsarFilesystem+searchNodeFromDirectory) ⇒ [Node](#module_electron-builder/out/asar.Node) + * [.Node](#module_electron-builder/out/asar.Node) + * [`.readAsar(archive)`](#module_electron-builder/out/asar.readAsar) ⇒ Promise + * [`.readAsarJson(archive, file)`](#module_electron-builder/out/asar.readAsarJson) ⇒ Promise +* [electron-builder/out/asarUtil](#module_electron-builder/out/asarUtil) + * [`.checkFileInArchive(asarFile, relativeFile, messagePrefix)`](#module_electron-builder/out/asarUtil.checkFileInArchive) ⇒ Promise + * [`.createAsarArchive(src, resourcesPath, options, filter, unpackPattern)`](#module_electron-builder/out/asarUtil.createAsarArchive) ⇒ Promise +* [electron-builder/out/builder](#module_electron-builder/out/builder) + * [`.normalizeOptions(args)`](#module_electron-builder/out/builder.normalizeOptions) ⇒ module:electron-builder/out/builder.BuildOptions +* [electron-builder/out/cli/cliOptions](#module_electron-builder/out/cli/cliOptions) + * [`.createYargs()`](#module_electron-builder/out/cli/cliOptions.createYargs) ⇒ any +* [electron-builder/out/codeSign](#module_electron-builder/out/codeSign) + * [`.CodeSigningInfo`](#module_electron-builder/out/codeSign.CodeSigningInfo) + * [`.findIdentityRawResult`](#module_electron-builder/out/codeSign.findIdentityRawResult) : Promise | null + * [`.createKeychain(tmpDir, cscLink, cscKeyPassword, cscILink, cscIKeyPassword)`](#module_electron-builder/out/codeSign.createKeychain) ⇒ Promise + * [`.downloadCertificate(urlOrBase64, tmpDir)`](#module_electron-builder/out/codeSign.downloadCertificate) ⇒ Promise + * [`.findIdentity(certType, qualifier, keychain)`](#module_electron-builder/out/codeSign.findIdentity) ⇒ Promise + * [`.sign(path, name, keychain)`](#module_electron-builder/out/codeSign.sign) ⇒ Promise +* [electron-builder/out/fileMatcher](#module_electron-builder/out/fileMatcher) + * [.FileMatcher](#module_electron-builder/out/fileMatcher.FileMatcher) + * [`.addAllPattern()`](#module_electron-builder/out/fileMatcher.FileMatcher+addAllPattern) + * [`.addPattern(pattern)`](#module_electron-builder/out/fileMatcher.FileMatcher+addPattern) + * [`.computeParsedPatterns(result, fromDir)`](#module_electron-builder/out/fileMatcher.FileMatcher+computeParsedPatterns) + * [`.containsOnlyIgnore()`](#module_electron-builder/out/fileMatcher.FileMatcher+containsOnlyIgnore) ⇒ boolean + * [`.createFilter(ignoreFiles, rawFilter, excludePatterns)`](#module_electron-builder/out/fileMatcher.FileMatcher+createFilter) ⇒ module:electron-builder-util/out/fs.__type + * [`.isEmpty()`](#module_electron-builder/out/fileMatcher.FileMatcher+isEmpty) ⇒ boolean + * [`.copyFiles(patterns)`](#module_electron-builder/out/fileMatcher.copyFiles) ⇒ Promise +* [electron-builder/out/linuxPackager](#module_electron-builder/out/linuxPackager) + * [.LinuxPackager](#module_electron-builder/out/linuxPackager.LinuxPackager) ⇐ [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) + * [`.createTargets(targets, mapper, cleanupTasks)`](#module_electron-builder/out/linuxPackager.LinuxPackager+createTargets) + * [`.postInitApp(appOutDir)`](#module_electron-builder/out/linuxPackager.LinuxPackager+postInitApp) ⇒ Promise + * [`.getDefaultIcon(ext)`](#module_electron-builder/out/platformPackager.PlatformPackager+getDefaultIcon) ⇒ Promise + * [`.dispatchArtifactCreated(file, target, safeArtifactName)`](#module_electron-builder/out/platformPackager.PlatformPackager+dispatchArtifactCreated) + * [`.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern)`](#module_electron-builder/out/platformPackager.PlatformPackager+expandArtifactNamePattern) ⇒ string + * [`.expandMacro(pattern, arch, extra)`](#module_electron-builder/out/platformPackager.PlatformPackager+expandMacro) ⇒ string + * [`.generateName(ext, arch, deployment, classifier)`](#module_electron-builder/out/platformPackager.PlatformPackager+generateName) ⇒ string + * [`.generateName2(ext, classifier, deployment)`](#module_electron-builder/out/platformPackager.PlatformPackager+generateName2) ⇒ string + * [`.getIconPath()`](#module_electron-builder/out/platformPackager.PlatformPackager+getIconPath) ⇒ Promise + * [`.getMacOsResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getMacOsResourcesDir) ⇒ string + * [`.pack(outDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+pack) ⇒ Promise + * [`.getResource(custom, names)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResource) ⇒ Promise + * [`.getResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResourcesDir) ⇒ string + * [`.getTempFile(suffix)`](#module_electron-builder/out/platformPackager.PlatformPackager+getTempFile) ⇒ Promise + * [`.computeAppOutDir(outDir, arch)`](#module_electron-builder/out/platformPackager.PlatformPackager+computeAppOutDir) ⇒ string + * [`.getCscPassword()`](#module_electron-builder/out/platformPackager.PlatformPackager+getCscPassword) ⇒ string + * [`.doGetCscPassword()`](#module_electron-builder/out/platformPackager.PlatformPackager+doGetCscPassword) ⇒ any + * [`.doPack(outDir, appOutDir, platformName, arch, platformSpecificBuildOptions, targets)`](#module_electron-builder/out/platformPackager.PlatformPackager+doPack) ⇒ Promise + * [`.packageInDistributableFormat(appOutDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+packageInDistributableFormat) + * [`.prepareAppInfo(appInfo)`](#module_electron-builder/out/platformPackager.PlatformPackager+prepareAppInfo) ⇒ [AppInfo](#module_electron-builder/out/appInfo.AppInfo) +* [electron-builder/out/macPackager](#module_electron-builder/out/macPackager) + * [.MacPackager](#module_electron-builder/out/macPackager.MacPackager) ⇐ [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) + * [`.createTargets(targets, mapper, cleanupTasks)`](#module_electron-builder/out/macPackager.MacPackager+createTargets) + * [`.getIconPath()`](#module_electron-builder/out/macPackager.MacPackager+getIconPath) ⇒ Promise + * [`.pack(outDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/macPackager.MacPackager+pack) ⇒ Promise + * [`.doFlat(appPath, outFile, identity, keychain)`](#module_electron-builder/out/macPackager.MacPackager+doFlat) ⇒ Promise + * [`.doSign(opts)`](#module_electron-builder/out/macPackager.MacPackager+doSign) ⇒ Promise + * [`.prepareAppInfo(appInfo)`](#module_electron-builder/out/macPackager.MacPackager+prepareAppInfo) ⇒ [AppInfo](#module_electron-builder/out/appInfo.AppInfo) + * [`.getDefaultIcon(ext)`](#module_electron-builder/out/platformPackager.PlatformPackager+getDefaultIcon) ⇒ Promise + * [`.dispatchArtifactCreated(file, target, safeArtifactName)`](#module_electron-builder/out/platformPackager.PlatformPackager+dispatchArtifactCreated) + * [`.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern)`](#module_electron-builder/out/platformPackager.PlatformPackager+expandArtifactNamePattern) ⇒ string + * [`.expandMacro(pattern, arch, extra)`](#module_electron-builder/out/platformPackager.PlatformPackager+expandMacro) ⇒ string + * [`.generateName(ext, arch, deployment, classifier)`](#module_electron-builder/out/platformPackager.PlatformPackager+generateName) ⇒ string + * [`.generateName2(ext, classifier, deployment)`](#module_electron-builder/out/platformPackager.PlatformPackager+generateName2) ⇒ string + * [`.getMacOsResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getMacOsResourcesDir) ⇒ string + * [`.getResource(custom, names)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResource) ⇒ Promise + * [`.getResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResourcesDir) ⇒ string + * [`.getTempFile(suffix)`](#module_electron-builder/out/platformPackager.PlatformPackager+getTempFile) ⇒ Promise + * [`.computeAppOutDir(outDir, arch)`](#module_electron-builder/out/platformPackager.PlatformPackager+computeAppOutDir) ⇒ string + * [`.getCscPassword()`](#module_electron-builder/out/platformPackager.PlatformPackager+getCscPassword) ⇒ string + * [`.doGetCscPassword()`](#module_electron-builder/out/platformPackager.PlatformPackager+doGetCscPassword) ⇒ any + * [`.doPack(outDir, appOutDir, platformName, arch, platformSpecificBuildOptions, targets)`](#module_electron-builder/out/platformPackager.PlatformPackager+doPack) ⇒ Promise + * [`.packageInDistributableFormat(appOutDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+packageInDistributableFormat) + * [`.postInitApp(executableFile)`](#module_electron-builder/out/platformPackager.PlatformPackager+postInitApp) ⇒ Promise +* [electron-builder/out/packager/dirPackager](#module_electron-builder/out/packager/dirPackager) + * [`.unpackElectron(packager, out, platform, arch, electronVersion)`](#module_electron-builder/out/packager/dirPackager.unpackElectron) ⇒ Promise +* [electron-builder/out/packager/mac](#module_electron-builder/out/packager/mac) + * [`.createApp(packager, appOutDir)`](#module_electron-builder/out/packager/mac.createApp) ⇒ Promise + * [`.filterCFBundleIdentifier(identifier)`](#module_electron-builder/out/packager/mac.filterCFBundleIdentifier) ⇒ string +* [electron-builder/out/packager](#module_electron-builder/out/packager) + * [`.normalizePlatforms(rawPlatforms)`](#module_electron-builder/out/packager.normalizePlatforms) ⇒ Array +* [electron-builder/out/platformPackager](#module_electron-builder/out/platformPackager) + * [.PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) + * [`.createTargets(targets, mapper, cleanupTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+createTargets) + * [`.getDefaultIcon(ext)`](#module_electron-builder/out/platformPackager.PlatformPackager+getDefaultIcon) ⇒ Promise + * [`.dispatchArtifactCreated(file, target, safeArtifactName)`](#module_electron-builder/out/platformPackager.PlatformPackager+dispatchArtifactCreated) + * [`.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern)`](#module_electron-builder/out/platformPackager.PlatformPackager+expandArtifactNamePattern) ⇒ string + * [`.expandMacro(pattern, arch, extra)`](#module_electron-builder/out/platformPackager.PlatformPackager+expandMacro) ⇒ string + * [`.generateName(ext, arch, deployment, classifier)`](#module_electron-builder/out/platformPackager.PlatformPackager+generateName) ⇒ string + * [`.generateName2(ext, classifier, deployment)`](#module_electron-builder/out/platformPackager.PlatformPackager+generateName2) ⇒ string + * [`.getIconPath()`](#module_electron-builder/out/platformPackager.PlatformPackager+getIconPath) ⇒ Promise + * [`.getMacOsResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getMacOsResourcesDir) ⇒ string + * [`.pack(outDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+pack) ⇒ Promise + * [`.getResource(custom, names)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResource) ⇒ Promise + * [`.getResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResourcesDir) ⇒ string + * [`.getTempFile(suffix)`](#module_electron-builder/out/platformPackager.PlatformPackager+getTempFile) ⇒ Promise + * [`.computeAppOutDir(outDir, arch)`](#module_electron-builder/out/platformPackager.PlatformPackager+computeAppOutDir) ⇒ string + * [`.getCscPassword()`](#module_electron-builder/out/platformPackager.PlatformPackager+getCscPassword) ⇒ string + * [`.doGetCscPassword()`](#module_electron-builder/out/platformPackager.PlatformPackager+doGetCscPassword) ⇒ any + * [`.doPack(outDir, appOutDir, platformName, arch, platformSpecificBuildOptions, targets)`](#module_electron-builder/out/platformPackager.PlatformPackager+doPack) ⇒ Promise + * [`.packageInDistributableFormat(appOutDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+packageInDistributableFormat) + * [`.postInitApp(executableFile)`](#module_electron-builder/out/platformPackager.PlatformPackager+postInitApp) ⇒ Promise + * [`.prepareAppInfo(appInfo)`](#module_electron-builder/out/platformPackager.PlatformPackager+prepareAppInfo) ⇒ [AppInfo](#module_electron-builder/out/appInfo.AppInfo) + * [`.normalizeExt(ext)`](#module_electron-builder/out/platformPackager.normalizeExt) ⇒ string +* [electron-builder/out/publish/PublishManager](#module_electron-builder/out/publish/PublishManager) + * [.PublishManager](#module_electron-builder/out/publish/PublishManager.PublishManager) ⇐ [PublishContext](#module_electron-publish.PublishContext) + * [`.awaitTasks()`](#module_electron-builder/out/publish/PublishManager.PublishManager+awaitTasks) ⇒ Promise + * [`.cancelTasks()`](#module_electron-builder/out/publish/PublishManager.PublishManager+cancelTasks) + * [`.getOrCreatePublisher(publishConfig, buildInfo)`](#module_electron-builder/out/publish/PublishManager.PublishManager+getOrCreatePublisher) ⇒ + * [`.computeDownloadUrl(publishConfig, fileName, packager, arch)`](#module_electron-builder/out/publish/PublishManager.computeDownloadUrl) ⇒ string + * [`.createPublisher(context, version, publishConfig, options)`](#module_electron-builder/out/publish/PublishManager.createPublisher) ⇒ + * [`.getPublishConfigs(packager, targetSpecificOptions)`](#module_electron-builder/out/publish/PublishManager.getPublishConfigs) ⇒ Promise + * [`.getPublishConfigsForUpdateInfo(packager, publishConfigs)`](#module_electron-builder/out/publish/PublishManager.getPublishConfigsForUpdateInfo) ⇒ Promise +* [electron-builder/out/publish/publisher](#module_electron-builder/out/publish/publisher) + * [`.getCiTag()`](#module_electron-builder/out/publish/publisher.getCiTag) ⇒ any + * [`.getResolvedPublishConfig(packager, publishConfig, errorIfCannot)`](#module_electron-builder/out/publish/publisher.getResolvedPublishConfig) ⇒ Promise +* [electron-builder/out/readInstalled](#module_electron-builder/out/readInstalled) + * [`.Dependency`](#module_electron-builder/out/readInstalled.Dependency) + * [`.readInstalled(folder)`](#module_electron-builder/out/readInstalled.readInstalled) ⇒ Promise +* [electron-builder/out/repositoryInfo](#module_electron-builder/out/repositoryInfo) + * [`.RepositorySlug`](#module_electron-builder/out/repositoryInfo.RepositorySlug) + * [`.getRepositoryInfo(projectDir, metadata, devMetadata)`](#module_electron-builder/out/repositoryInfo.getRepositoryInfo) ⇒ Promise +* [electron-builder/out/targets/ArchiveTarget](#module_electron-builder/out/targets/ArchiveTarget) + * [.ArchiveTarget](#module_electron-builder/out/targets/ArchiveTarget.ArchiveTarget) ⇐ [Target](#module_electron-builder-core.Target) + * [`.build(appOutDir, arch)`](#module_electron-builder/out/targets/ArchiveTarget.ArchiveTarget+build) ⇒ Promise + * [`.finishBuild()`](#module_electron-builder-core.Target+finishBuild) ⇒ Promise +* [electron-builder/out/targets/LinuxTargetHelper](#module_electron-builder/out/targets/LinuxTargetHelper) + * [.LinuxTargetHelper](#module_electron-builder/out/targets/LinuxTargetHelper.LinuxTargetHelper) + * [`.computeDesktopEntry(platformSpecificBuildOptions, exec, destination, extra)`](#module_electron-builder/out/targets/LinuxTargetHelper.LinuxTargetHelper+computeDesktopEntry) ⇒ Promise + * [`.getDescription(options)`](#module_electron-builder/out/targets/LinuxTargetHelper.LinuxTargetHelper+getDescription) ⇒ string +* [electron-builder/out/targets/WebInstaller](#module_electron-builder/out/targets/WebInstaller) + * [.WebInstallerTarget](#module_electron-builder/out/targets/WebInstaller.WebInstallerTarget) ⇐ module:electron-builder/out/targets/nsis.default + * [`.configureDefines(oneClick, defines)`](#module_electron-builder/out/targets/WebInstaller.WebInstallerTarget+configureDefines) ⇒ Promise + * [`.generateGitHubInstallerName()`](#module_electron-builder/out/targets/WebInstaller.WebInstallerTarget+generateGitHubInstallerName) ⇒ string +* [electron-builder/out/targets/appImage](#module_electron-builder/out/targets/appImage) + * [.AppImageTarget](#module_electron-builder/out/targets/appImage.AppImageTarget) ⇐ [Target](#module_electron-builder-core.Target) + * [`.build(appOutDir, arch)`](#module_electron-builder/out/targets/appImage.AppImageTarget+build) ⇒ Promise + * [`.finishBuild()`](#module_electron-builder-core.Target+finishBuild) ⇒ Promise +* [electron-builder/out/targets/appx](#module_electron-builder/out/targets/appx) + * [.AppXTarget](#module_electron-builder/out/targets/appx.AppXTarget) ⇐ [Target](#module_electron-builder-core.Target) + * [`.build(appOutDir, arch)`](#module_electron-builder/out/targets/appx.AppXTarget+build) ⇒ Promise + * [`.finishBuild()`](#module_electron-builder-core.Target+finishBuild) ⇒ Promise +* [electron-builder/out/targets/archive](#module_electron-builder/out/targets/archive) + * [`.archive(compression, format, outFile, dirToArchive, withoutDir)`](#module_electron-builder/out/targets/archive.archive) ⇒ Promise + * [`.tar(compression, format, outFile, dirToArchive, isMacApp)`](#module_electron-builder/out/targets/archive.tar) ⇒ Promise +* [electron-builder/out/targets/dmg](#module_electron-builder/out/targets/dmg) + * [.DmgTarget](#module_electron-builder/out/targets/dmg.DmgTarget) ⇐ [Target](#module_electron-builder-core.Target) + * [`.build(appPath, arch)`](#module_electron-builder/out/targets/dmg.DmgTarget+build) ⇒ Promise + * [`.computeDmgOptions()`](#module_electron-builder/out/targets/dmg.DmgTarget+computeDmgOptions) ⇒ Promise + * [`.computeVolumeName(custom)`](#module_electron-builder/out/targets/dmg.DmgTarget+computeVolumeName) ⇒ string + * [`.finishBuild()`](#module_electron-builder-core.Target+finishBuild) ⇒ Promise + * [`.attachAndExecute(dmgPath, readWrite, task)`](#module_electron-builder/out/targets/dmg.attachAndExecute) ⇒ Promise +* [electron-builder/out/targets/fpm](#module_electron-builder/out/targets/fpm) + * [.FpmTarget](#module_electron-builder/out/targets/fpm.FpmTarget) ⇐ [Target](#module_electron-builder-core.Target) + * [`.build(appOutDir, arch)`](#module_electron-builder/out/targets/fpm.FpmTarget+build) ⇒ Promise + * [`.finishBuild()`](#module_electron-builder-core.Target+finishBuild) ⇒ Promise +* [electron-builder/out/targets/nsis](#module_electron-builder/out/targets/nsis) + * [.NsisTarget](#module_electron-builder/out/targets/nsis.NsisTarget) ⇐ [Target](#module_electron-builder-core.Target) + * [`.build(appOutDir, arch)`](#module_electron-builder/out/targets/nsis.NsisTarget+build) ⇒ Promise + * [`.finishBuild()`](#module_electron-builder/out/targets/nsis.NsisTarget+finishBuild) ⇒ Promise + * [`.configureDefines(oneClick, defines)`](#module_electron-builder/out/targets/nsis.NsisTarget+configureDefines) ⇒ Promise + * [`.generateGitHubInstallerName()`](#module_electron-builder/out/targets/nsis.NsisTarget+generateGitHubInstallerName) ⇒ string +* [electron-builder/out/targets/pkg](#module_electron-builder/out/targets/pkg) + * [.PkgTarget](#module_electron-builder/out/targets/pkg.PkgTarget) ⇐ [Target](#module_electron-builder-core.Target) + * [`.build(appPath, arch)`](#module_electron-builder/out/targets/pkg.PkgTarget+build) ⇒ Promise + * [`.finishBuild()`](#module_electron-builder-core.Target+finishBuild) ⇒ Promise + * [`.prepareProductBuildArgs(identity, keychain)`](#module_electron-builder/out/targets/pkg.prepareProductBuildArgs) ⇒ Array +* [electron-builder/out/targets/snap](#module_electron-builder/out/targets/snap) + * [.SnapTarget](#module_electron-builder/out/targets/snap.SnapTarget) ⇐ [Target](#module_electron-builder-core.Target) + * [`.build(appOutDir, arch)`](#module_electron-builder/out/targets/snap.SnapTarget+build) ⇒ Promise + * [`.finishBuild()`](#module_electron-builder-core.Target+finishBuild) ⇒ Promise +* [electron-builder/out/targets/targetFactory](#module_electron-builder/out/targets/targetFactory) + * [.NoOpTarget](#module_electron-builder/out/targets/targetFactory.NoOpTarget) ⇐ [Target](#module_electron-builder-core.Target) + * [`.build(appOutDir, arch)`](#module_electron-builder/out/targets/targetFactory.NoOpTarget+build) ⇒ Promise + * [`.finishBuild()`](#module_electron-builder-core.Target+finishBuild) ⇒ Promise + * [`.computeArchToTargetNamesMap(raw, options, platform)`](#module_electron-builder/out/targets/targetFactory.computeArchToTargetNamesMap) ⇒ Map + * [`.createCommonTarget(target, outDir, packager)`](#module_electron-builder/out/targets/targetFactory.createCommonTarget) ⇒ [Target](#module_electron-builder-core.Target) + * [`.createTargets(nameToTarget, rawList, outDir, packager, cleanupTasks)`](#module_electron-builder/out/targets/targetFactory.createTargets) ⇒ Array +* [electron-builder/out/util/filter](#module_electron-builder/out/util/filter) + * [`.createFilter(src, patterns, ignoreFiles, rawFilter, excludePatterns)`](#module_electron-builder/out/util/filter.createFilter) ⇒ module:electron-builder-util/out/fs.__type + * [`.hasMagic(pattern)`](#module_electron-builder/out/util/filter.hasMagic) ⇒ boolean +* [electron-builder/out/util/readPackageJson](#module_electron-builder/out/util/readPackageJson) + * [`.doLoadConfig(configFile, projectDir)`](#module_electron-builder/out/util/readPackageJson.doLoadConfig) ⇒ Promise + * [`.getElectronVersion(config, projectDir, projectMetadata)`](#module_electron-builder/out/util/readPackageJson.getElectronVersion) ⇒ Promise + * [`.loadConfig(projectDir)`](#module_electron-builder/out/util/readPackageJson.loadConfig) ⇒ Promise + * [`.readPackageJson(file)`](#module_electron-builder/out/util/readPackageJson.readPackageJson) ⇒ Promise + * [`.validateConfig(config)`](#module_electron-builder/out/util/readPackageJson.validateConfig) ⇒ Promise +* [electron-builder/out/winPackager](#module_electron-builder/out/winPackager) + * [.WinPackager](#module_electron-builder/out/winPackager.WinPackager) ⇐ [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) + * [`.createTargets(targets, mapper, cleanupTasks)`](#module_electron-builder/out/winPackager.WinPackager+createTargets) + * [`.getIconPath()`](#module_electron-builder/out/winPackager.WinPackager+getIconPath) ⇒ Promise + * [`.sign(file, logMessagePrefix)`](#module_electron-builder/out/winPackager.WinPackager+sign) ⇒ Promise + * [`.signAndEditResources(file)`](#module_electron-builder/out/winPackager.WinPackager+signAndEditResources) ⇒ Promise + * [`.doGetCscPassword()`](#module_electron-builder/out/winPackager.WinPackager+doGetCscPassword) ⇒ string + * [`.doSign(options)`](#module_electron-builder/out/winPackager.WinPackager+doSign) ⇒ Promise + * [`.postInitApp(appOutDir)`](#module_electron-builder/out/winPackager.WinPackager+postInitApp) ⇒ Promise + * [`.getDefaultIcon(ext)`](#module_electron-builder/out/platformPackager.PlatformPackager+getDefaultIcon) ⇒ Promise + * [`.dispatchArtifactCreated(file, target, safeArtifactName)`](#module_electron-builder/out/platformPackager.PlatformPackager+dispatchArtifactCreated) + * [`.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern)`](#module_electron-builder/out/platformPackager.PlatformPackager+expandArtifactNamePattern) ⇒ string + * [`.expandMacro(pattern, arch, extra)`](#module_electron-builder/out/platformPackager.PlatformPackager+expandMacro) ⇒ string + * [`.generateName(ext, arch, deployment, classifier)`](#module_electron-builder/out/platformPackager.PlatformPackager+generateName) ⇒ string + * [`.generateName2(ext, classifier, deployment)`](#module_electron-builder/out/platformPackager.PlatformPackager+generateName2) ⇒ string + * [`.getMacOsResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getMacOsResourcesDir) ⇒ string + * [`.pack(outDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+pack) ⇒ Promise + * [`.getResource(custom, names)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResource) ⇒ Promise + * [`.getResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResourcesDir) ⇒ string + * [`.getTempFile(suffix)`](#module_electron-builder/out/platformPackager.PlatformPackager+getTempFile) ⇒ Promise + * [`.computeAppOutDir(outDir, arch)`](#module_electron-builder/out/platformPackager.PlatformPackager+computeAppOutDir) ⇒ string + * [`.getCscPassword()`](#module_electron-builder/out/platformPackager.PlatformPackager+getCscPassword) ⇒ string + * [`.doPack(outDir, appOutDir, platformName, arch, platformSpecificBuildOptions, targets)`](#module_electron-builder/out/platformPackager.PlatformPackager+doPack) ⇒ Promise + * [`.packageInDistributableFormat(appOutDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+packageInDistributableFormat) + * [`.prepareAppInfo(appInfo)`](#module_electron-builder/out/platformPackager.PlatformPackager+prepareAppInfo) ⇒ [AppInfo](#module_electron-builder/out/appInfo.AppInfo) +* [electron-builder/out/windowsCodeSign](#module_electron-builder/out/windowsCodeSign) + * [`.FileCodeSigningInfo`](#module_electron-builder/out/windowsCodeSign.FileCodeSigningInfo) + * [`.SignOptions`](#module_electron-builder/out/windowsCodeSign.SignOptions) + * [`.getSignVendorPath()`](#module_electron-builder/out/windowsCodeSign.getSignVendorPath) ⇒ Promise + * [`.getToolPath()`](#module_electron-builder/out/windowsCodeSign.getToolPath) ⇒ Promise + * [`.sign(options)`](#module_electron-builder/out/windowsCodeSign.sign) ⇒ Promise +* [electron-builder/out/yarn](#module_electron-builder/out/yarn) + * [`.getGypEnv(electronVersion, platform, arch, buildFromSource)`](#module_electron-builder/out/yarn.getGypEnv) ⇒ any + * [`.installOrRebuild(config, appDir, electronVersion, platform, arch, forceInstall)`](#module_electron-builder/out/yarn.installOrRebuild) ⇒ Promise + * [`.rebuild(appDir, electronVersion, platform, arch, additionalArgs, buildFromSource)`](#module_electron-builder/out/yarn.rebuild) ⇒ Promise +* [electron-builder](#module_electron-builder) + * [`.AfterPackContext`](#module_electron-builder.AfterPackContext) + * [`.AppImageOptions`](#module_electron-builder.AppImageOptions) ⇐ [LinuxBuildOptions](#module_electron-builder.LinuxBuildOptions) + * [`.AppXOptions`](#module_electron-builder.AppXOptions) + * [`.ArtifactCreated`](#module_electron-builder.ArtifactCreated) + * [`.BuildInfo`](#module_electron-builder.BuildInfo) + * [`.BuildOptions`](#module_electron-builder.BuildOptions) ⇐ [PublishOptions](#module_electron-publish.PublishOptions) + * [`.BuildResult`](#module_electron-builder.BuildResult) + * [`.CliOptions`](#module_electron-builder.CliOptions) ⇐ [PublishOptions](#module_electron-publish.PublishOptions) + * ~~[`.Config`](#module_electron-builder.Config) ⇐ [TargetSpecificOptions](#module_electron-builder-core.TargetSpecificOptions)~~ + * [`.DebOptions`](#module_electron-builder.DebOptions) ⇐ [LinuxBuildOptions](#module_electron-builder.LinuxBuildOptions) + * [`.DmgContent`](#module_electron-builder.DmgContent) + * [`.DmgOptions`](#module_electron-builder.DmgOptions) ⇐ [TargetSpecificOptions](#module_electron-builder-core.TargetSpecificOptions) + * [`.DmgWindow`](#module_electron-builder.DmgWindow) + * [`.FileAssociation`](#module_electron-builder.FileAssociation) + * [`.LinuxBuildOptions`](#module_electron-builder.LinuxBuildOptions) ⇐ [PlatformSpecificBuildOptions](#module_electron-builder.PlatformSpecificBuildOptions) + * [`.MacOptions`](#module_electron-builder.MacOptions) ⇐ [PlatformSpecificBuildOptions](#module_electron-builder.PlatformSpecificBuildOptions) + * [`.MasBuildOptions`](#module_electron-builder.MasBuildOptions) ⇐ [MacOptions](#module_electron-builder.MacOptions) + * [`.Metadata`](#module_electron-builder.Metadata) + * [`.MetadataDirectories`](#module_electron-builder.MetadataDirectories) + * [`.NsisOptions`](#module_electron-builder.NsisOptions) + * [`.NsisWebOptions`](#module_electron-builder.NsisWebOptions) ⇐ [NsisOptions](#module_electron-builder.NsisOptions) + * ~~[`.PackagerOptions`](#module_electron-builder.PackagerOptions)~~ + * [`.PkgOptions`](#module_electron-builder.PkgOptions) ⇐ [TargetSpecificOptions](#module_electron-builder-core.TargetSpecificOptions) + * [`.PlatformSpecificBuildOptions`](#module_electron-builder.PlatformSpecificBuildOptions) ⇐ [TargetSpecificOptions](#module_electron-builder-core.TargetSpecificOptions) + * [`.Protocol`](#module_electron-builder.Protocol) + * [`.SnapOptions`](#module_electron-builder.SnapOptions) ⇐ [LinuxBuildOptions](#module_electron-builder.LinuxBuildOptions) + * [`.SourceRepositoryInfo`](#module_electron-builder.SourceRepositoryInfo) + * [`.SquirrelWindowsOptions`](#module_electron-builder.SquirrelWindowsOptions) ⇐ [WinBuildOptions](#module_electron-builder.WinBuildOptions) + * [`.WinBuildOptions`](#module_electron-builder.WinBuildOptions) ⇐ [PlatformSpecificBuildOptions](#module_electron-builder.PlatformSpecificBuildOptions) + * [.Packager](#module_electron-builder.Packager) ⇐ [BuildInfo](#module_electron-builder.BuildInfo) + * [`.build(rawOptions)`](#module_electron-builder.build) ⇒ Promise + * [`.createTargets(platforms, type, arch)`](#module_electron-builder.createTargets) ⇒ Map +* [electron-builder-core](#module_electron-builder-core) + * [`.AsarOptions`](#module_electron-builder-core.AsarOptions) + * [`.AuthorMetadata`](#module_electron-builder-core.AuthorMetadata) + * [`.BeforeBuildContext`](#module_electron-builder-core.BeforeBuildContext) + * [`.FilePattern`](#module_electron-builder-core.FilePattern) + * [`.RepositoryInfo`](#module_electron-builder-core.RepositoryInfo) + * [`.TargetConfig`](#module_electron-builder-core.TargetConfig) + * [`.TargetSpecificOptions`](#module_electron-builder-core.TargetSpecificOptions) + * [.Platform](#module_electron-builder-core.Platform) + * [`.createTarget(type, archs)`](#module_electron-builder-core.Platform+createTarget) ⇒ Map + * [`.current()`](#module_electron-builder-core.Platform+current) ⇒ [Platform](#module_electron-builder-core.Platform) + * [`.fromString(name)`](#module_electron-builder-core.Platform+fromString) ⇒ [Platform](#module_electron-builder-core.Platform) + * [`.toString()`](#module_electron-builder-core.Platform+toString) ⇒ string + * [.Target](#module_electron-builder-core.Target) + * [`.build(appOutDir, arch)`](#module_electron-builder-core.Target+build) ⇒ Promise + * [`.finishBuild()`](#module_electron-builder-core.Target+finishBuild) ⇒ Promise + * [`.archFromString(name)`](#module_electron-builder-core.archFromString) ⇒ module:electron-builder-core.Arch + * [`.getArchSuffix(arch)`](#module_electron-builder-core.getArchSuffix) ⇒ string + * [`.toLinuxArchString(arch)`](#module_electron-builder-core.toLinuxArchString) ⇒ +* [electron-publish/out/BintrayPublisher](#module_electron-publish/out/BintrayPublisher) + * [.BintrayPublisher](#module_electron-publish/out/BintrayPublisher.BintrayPublisher) ⇐ [HttpPublisher](#module_electron-publish.HttpPublisher) + * [`.deleteRelease()`](#module_electron-publish/out/BintrayPublisher.BintrayPublisher+deleteRelease) ⇒ Promise + * [`.toString()`](#module_electron-publish/out/BintrayPublisher.BintrayPublisher+toString) ⇒ string + * [`.doUpload(fileName, dataLength, requestProcessor)`](#module_electron-publish/out/BintrayPublisher.BintrayPublisher+doUpload) ⇒ Promise + * [`.upload(file, safeArtifactName)`](#module_electron-publish.HttpPublisher+upload) ⇒ Promise + * [`.uploadData(data, fileName)`](#module_electron-publish.HttpPublisher+uploadData) ⇒ Promise + * [`.createProgressBar(fileName, fileStat)`](#module_electron-publish.Publisher+createProgressBar) ⇒ + * [`.createReadStreamAndProgressBar(file, fileStat, progressBar, reject)`](#module_electron-publish.Publisher+createReadStreamAndProgressBar) ⇒ NodeJS:ReadableStream +* [electron-publish/out/gitHubPublisher](#module_electron-publish/out/gitHubPublisher) + * [`.Release`](#module_electron-publish/out/gitHubPublisher.Release) + * [.GitHubPublisher](#module_electron-publish/out/gitHubPublisher.GitHubPublisher) ⇐ [HttpPublisher](#module_electron-publish.HttpPublisher) + * [`.deleteRelease()`](#module_electron-publish/out/gitHubPublisher.GitHubPublisher+deleteRelease) ⇒ Promise + * [`.getRelease()`](#module_electron-publish/out/gitHubPublisher.GitHubPublisher+getRelease) ⇒ Promise + * [`.toString()`](#module_electron-publish/out/gitHubPublisher.GitHubPublisher+toString) ⇒ string + * [`.doUpload(fileName, dataLength, requestProcessor)`](#module_electron-publish/out/gitHubPublisher.GitHubPublisher+doUpload) ⇒ Promise + * [`.upload(file, safeArtifactName)`](#module_electron-publish.HttpPublisher+upload) ⇒ Promise + * [`.uploadData(data, fileName)`](#module_electron-publish.HttpPublisher+uploadData) ⇒ Promise + * [`.createProgressBar(fileName, fileStat)`](#module_electron-publish.Publisher+createProgressBar) ⇒ + * [`.createReadStreamAndProgressBar(file, fileStat, progressBar, reject)`](#module_electron-publish.Publisher+createReadStreamAndProgressBar) ⇒ NodeJS:ReadableStream +* [electron-publish/out/multiProgress](#module_electron-publish/out/multiProgress) + * [.MultiProgress](#module_electron-publish/out/multiProgress.MultiProgress) + * [`.createBar(format, options)`](#module_electron-publish/out/multiProgress.MultiProgress+createBar) ⇒ any + * [`.terminate()`](#module_electron-publish/out/multiProgress.MultiProgress+terminate) +* [electron-publish](#module_electron-publish) + * [`.PublishContext`](#module_electron-publish.PublishContext) + * [`.PublishOptions`](#module_electron-publish.PublishOptions) + * [.HttpPublisher](#module_electron-publish.HttpPublisher) ⇐ [Publisher](#module_electron-publish.Publisher) + * [`.upload(file, safeArtifactName)`](#module_electron-publish.HttpPublisher+upload) ⇒ Promise + * [`.uploadData(data, fileName)`](#module_electron-publish.HttpPublisher+uploadData) ⇒ Promise + * [`.doUpload(fileName, dataLength, requestProcessor, file)`](#module_electron-publish.HttpPublisher+doUpload) ⇒ Promise + * [`.toString()`](#module_electron-publish.Publisher+toString) ⇒ string + * [`.createProgressBar(fileName, fileStat)`](#module_electron-publish.Publisher+createProgressBar) ⇒ + * [`.createReadStreamAndProgressBar(file, fileStat, progressBar, reject)`](#module_electron-publish.Publisher+createReadStreamAndProgressBar) ⇒ NodeJS:ReadableStream + * [.Publisher](#module_electron-publish.Publisher) + * [`.toString()`](#module_electron-publish.Publisher+toString) ⇒ string + * [`.upload(file, safeArtifactName)`](#module_electron-publish.Publisher+upload) ⇒ Promise + * [`.createProgressBar(fileName, fileStat)`](#module_electron-publish.Publisher+createProgressBar) ⇒ + * [`.createReadStreamAndProgressBar(file, fileStat, progressBar, reject)`](#module_electron-publish.Publisher+createReadStreamAndProgressBar) ⇒ NodeJS:ReadableStream * [electron-builder-http/out/CancellationToken](#module_electron-builder-http/out/CancellationToken) + * [.CancellationError](#module_electron-builder-http/out/CancellationToken.CancellationError) ⇐ Error * [.CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) ⇐ internal:EventEmitter * [`.cancel()`](#module_electron-builder-http/out/CancellationToken.CancellationToken+cancel) * [`.createPromise(callback)`](#module_electron-builder-http/out/CancellationToken.CancellationToken+createPromise) ⇒ Promise * [`.dispose()`](#module_electron-builder-http/out/CancellationToken.CancellationToken+dispose) - * [.CancellationError](#module_electron-builder-http/out/CancellationToken.CancellationError) ⇐ Error * [electron-builder-http/out/ProgressCallbackTransform](#module_electron-builder-http/out/ProgressCallbackTransform) * [`.ProgressInfo`](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressInfo) * [.ProgressCallbackTransform](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform) ⇐ internal:Transform * [`._flush(callback)`](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform+_flush) * [`._transform(chunk, encoding, callback)`](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform+_transform) * [electron-builder-http/out/bintray](#module_electron-builder-http/out/bintray) - * [`.Version`](#module_electron-builder-http/out/bintray.Version) * [`.File`](#module_electron-builder-http/out/bintray.File) + * [`.Version`](#module_electron-builder-http/out/bintray.Version) * [.BintrayClient](#module_electron-builder-http/out/bintray.BintrayClient) * [`.createVersion(version)`](#module_electron-builder-http/out/bintray.BintrayClient+createVersion) ⇒ Promise * [`.deleteVersion(version)`](#module_electron-builder-http/out/bintray.BintrayClient+deleteVersion) ⇒ Promise @@ -100,22 +345,21 @@ * [`.getVersionFiles(version)`](#module_electron-builder-http/out/bintray.BintrayClient+getVersionFiles) ⇒ Promise * [`.bintrayRequest(path, auth, data, cancellationToken, method)`](#module_electron-builder-http/out/bintray.bintrayRequest) ⇒ Promise * [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) - * [`.PublishConfiguration`](#module_electron-builder-http/out/publishOptions.PublishConfiguration) + * [`.BintrayOptions`](#module_electron-builder-http/out/publishOptions.BintrayOptions) ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) * [`.GenericServerOptions`](#module_electron-builder-http/out/publishOptions.GenericServerOptions) ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) + * [`.GithubOptions`](#module_electron-builder-http/out/publishOptions.GithubOptions) ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) + * [`.PublishConfiguration`](#module_electron-builder-http/out/publishOptions.PublishConfiguration) * [`.S3Options`](#module_electron-builder-http/out/publishOptions.S3Options) ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) - * [`.VersionInfo`](#module_electron-builder-http/out/publishOptions.VersionInfo) * [`.UpdateInfo`](#module_electron-builder-http/out/publishOptions.UpdateInfo) ⇐ [VersionInfo](#module_electron-builder-http/out/publishOptions.VersionInfo) - * [`.GithubOptions`](#module_electron-builder-http/out/publishOptions.GithubOptions) ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) - * [`.BintrayOptions`](#module_electron-builder-http/out/publishOptions.BintrayOptions) ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) - * [`.s3Url(options)`](#module_electron-builder-http/out/publishOptions.s3Url) ⇒ string + * [`.VersionInfo`](#module_electron-builder-http/out/publishOptions.VersionInfo) * [`.githubUrl(options)`](#module_electron-builder-http/out/publishOptions.githubUrl) ⇒ string + * [`.s3Url(options)`](#module_electron-builder-http/out/publishOptions.s3Url) ⇒ string * [electron-builder-http](#module_electron-builder-http) + * [`.DownloadOptions`](#module_electron-builder-http.DownloadOptions) + * [`.onProgress(progress)`](#module_electron-builder-http.DownloadOptions+onProgress) * [`.RequestHeaders`](#module_electron-builder-http.RequestHeaders) * [`.Response`](#module_electron-builder-http.Response) ⇐ internal:EventEmitter * [`.setEncoding(encoding)`](#module_electron-builder-http.Response+setEncoding) - * [`.DownloadOptions`](#module_electron-builder-http.DownloadOptions) - * [`.onProgress(progress)`](#module_electron-builder-http.DownloadOptions+onProgress) - * [.HttpExecutorHolder](#module_electron-builder-http.HttpExecutorHolder) * [.HttpError](#module_electron-builder-http.HttpError) ⇐ Error * [.HttpExecutor](#module_electron-builder-http.HttpExecutor) * [`.download(url, destination, options)`](#module_electron-builder-http.HttpExecutor+download) ⇒ Promise @@ -123,1733 +367,6189 @@ * [`.addTimeOutHandler(request, callback)`](#module_electron-builder-http.HttpExecutor+addTimeOutHandler) * [`.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)`](#module_electron-builder-http.HttpExecutor+doApiRequest) ⇒ Promise * [`.doDownload(requestOptions, destination, redirectCount, options, callback, onCancel)`](#module_electron-builder-http.HttpExecutor+doDownload) - * [`.doRequest(options, callback)`](#module_electron-builder-http.HttpExecutor+doRequest) ⇒ + * [`.doRequest(options, callback)`](#module_electron-builder-http.HttpExecutor+doRequest) ⇒ any * [`.handleResponse(response, options, cancellationToken, resolve, reject, redirectCount, requestProcessor)`](#module_electron-builder-http.HttpExecutor+handleResponse) - * [`.download(url, destination, options)`](#module_electron-builder-http.download) ⇒ Promise - * [`.request(options, cancellationToken, data)`](#module_electron-builder-http.request) ⇒ Promise + * [.HttpExecutorHolder](#module_electron-builder-http.HttpExecutorHolder) * [`.configureRequestOptions(options, token, method)`](#module_electron-builder-http.configureRequestOptions) ⇒ module:http.RequestOptions + * [`.download(url, destination, options)`](#module_electron-builder-http.download) ⇒ Promise * [`.dumpRequestOptions(options)`](#module_electron-builder-http.dumpRequestOptions) ⇒ string + * [`.request(options, cancellationToken, data)`](#module_electron-builder-http.request) ⇒ Promise +* [electron-builder-util/out/binDownload](#module_electron-builder-util/out/binDownload) + * [`.getBin(name, dirName, url, sha2)`](#module_electron-builder-util/out/binDownload.getBin) ⇒ Promise + * [`.getBinFromBintray(name, version, sha2)`](#module_electron-builder-util/out/binDownload.getBinFromBintray) ⇒ Promise +* [electron-builder-util/out/deepAssign](#module_electron-builder-util/out/deepAssign) + * [`.deepAssign(target, objects)`](#module_electron-builder-util/out/deepAssign.deepAssign) ⇒ any +* [electron-builder-util/out/fs](#module_electron-builder-util/out/fs) + * [.FileCopier](#module_electron-builder-util/out/fs.FileCopier) + * [`.copy(src, dest, stat)`](#module_electron-builder-util/out/fs.FileCopier+copy) ⇒ Promise + * [`.copyDir(src, destination, filter, isUseHardLink)`](#module_electron-builder-util/out/fs.copyDir) ⇒ Promise + * [`.copyFile(src, dest, stats, isUseHardLink)`](#module_electron-builder-util/out/fs.copyFile) ⇒ Promise + * [`.exists(file)`](#module_electron-builder-util/out/fs.exists) ⇒ Promise + * [`.statOrNull(file)`](#module_electron-builder-util/out/fs.statOrNull) ⇒ Promise + * [`.unlinkIfExists(file)`](#module_electron-builder-util/out/fs.unlinkIfExists) ⇒ Promise + * [`.walk(initialDirPath, filter, consumer)`](#module_electron-builder-util/out/fs.walk) ⇒ Promise +* [electron-builder-util/out/log](#module_electron-builder-util/out/log) + * [`.log(message)`](#module_electron-builder-util/out/log.log) + * [`.setPrinter(value)`](#module_electron-builder-util/out/log.setPrinter) + * [`.subTask(title, promise)`](#module_electron-builder-util/out/log.subTask) ⇒ module:bluebird-lst.Bluebird + * [`.task(title, promise)`](#module_electron-builder-util/out/log.task) ⇒ module:bluebird-lst.Bluebird + * [`.warn(message)`](#module_electron-builder-util/out/log.warn) +* [electron-builder-util/out/nodeHttpExecutor](#module_electron-builder-util/out/nodeHttpExecutor) + * [.NodeHttpExecutor](#module_electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor) ⇐ [HttpExecutor](#module_electron-builder-http.HttpExecutor) + * [`.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)`](#module_electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor+doApiRequest) ⇒ Promise + * [`.download(url, destination, options)`](#module_electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor+download) ⇒ Promise + * [`.doRequest(options, callback)`](#module_electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor+doRequest) ⇒ any + * [`.request(options, cancellationToken, data)`](#module_electron-builder-http.HttpExecutor+request) ⇒ Promise + * [`.addTimeOutHandler(request, callback)`](#module_electron-builder-http.HttpExecutor+addTimeOutHandler) + * [`.doDownload(requestOptions, destination, redirectCount, options, callback, onCancel)`](#module_electron-builder-http.HttpExecutor+doDownload) + * [`.handleResponse(response, options, cancellationToken, resolve, reject, redirectCount, requestProcessor)`](#module_electron-builder-http.HttpExecutor+handleResponse) + * [`.httpExecutor`](#module_electron-builder-util/out/nodeHttpExecutor.httpExecutor) : [NodeHttpExecutor](#module_electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor) +* [electron-builder-util/out/promise](#module_electron-builder-util/out/promise) + * [.NestedError](#module_electron-builder-util/out/promise.NestedError) ⇐ Error + * [`.all(promises)`](#module_electron-builder-util/out/promise.all) ⇒ module:bluebird-lst.Bluebird + * [`.executeFinally(promise, task)`](#module_electron-builder-util/out/promise.executeFinally) ⇒ Promise + * [`.printErrorAndExit(error)`](#module_electron-builder-util/out/promise.printErrorAndExit) + * [`.throwError(errors)`](#module_electron-builder-util/out/promise.throwError) +* [electron-builder-util/out/tmp](#module_electron-builder-util/out/tmp) + * [.TmpDir](#module_electron-builder-util/out/tmp.TmpDir) + * [`.cleanup()`](#module_electron-builder-util/out/tmp.TmpDir+cleanup) ⇒ Promise + * [`.getTempFile(suffix)`](#module_electron-builder-util/out/tmp.TmpDir+getTempFile) ⇒ Promise +* [electron-builder-util](#module_electron-builder-util) + * [`.BaseExecOptions`](#module_electron-builder-util.BaseExecOptions) + * [`.ExecOptions`](#module_electron-builder-util.ExecOptions) ⇐ [BaseExecOptions](#module_electron-builder-util.BaseExecOptions) + * [.Lazy](#module_electron-builder-util.Lazy) + * [`.addValue(map, key, value)`](#module_electron-builder-util.addValue) + * [`.asArray(v)`](#module_electron-builder-util.asArray) ⇒ Array + * [`.computeDefaultAppDirectory(projectDir, userAppDir)`](#module_electron-builder-util.computeDefaultAppDirectory) ⇒ Promise + * [`.debug7zArgs(command)`](#module_electron-builder-util.debug7zArgs) ⇒ Array + * [`.doSpawn(command, args, options, pipeInput)`](#module_electron-builder-util.doSpawn) ⇒ module:child_process.ChildProcess + * [`.exec(file, args, options)`](#module_electron-builder-util.exec) ⇒ Promise + * [`.execWine(file, args, options)`](#module_electron-builder-util.execWine) ⇒ Promise + * [`.getCacheDirectory()`](#module_electron-builder-util.getCacheDirectory) ⇒ string + * [`.getPlatformIconFileName(value, isMac)`](#module_electron-builder-util.getPlatformIconFileName) ⇒ + * [`.getTempName(prefix)`](#module_electron-builder-util.getTempName) ⇒ string + * [`.handleProcess(event, childProcess, command, resolve, reject)`](#module_electron-builder-util.handleProcess) + * [`.isEmptyOrSpaces(s)`](#module_electron-builder-util.isEmptyOrSpaces) ⇒ boolean + * [`.prepareArgs(args, exePath)`](#module_electron-builder-util.prepareArgs) ⇒ Array + * [`.removePassword(input)`](#module_electron-builder-util.removePassword) ⇒ string + * [`.replaceDefault(inList, defaultList)`](#module_electron-builder-util.replaceDefault) ⇒ Array + * [`.smarten(s)`](#module_electron-builder-util.smarten) ⇒ string + * [`.spawn(command, args, options)`](#module_electron-builder-util.spawn) ⇒ Promise + * [`.use(value, task)`](#module_electron-builder-util.use) ⇒ - + -## electron-updater/out/AppUpdater +## electron-builder/out/appInfo -* [electron-updater/out/AppUpdater](#module_electron-updater/out/AppUpdater) - * [`.Logger`](#module_electron-updater/out/AppUpdater.Logger) - * [`.error(message)`](#module_electron-updater/out/AppUpdater.Logger+error) - * [`.info(message)`](#module_electron-updater/out/AppUpdater.Logger+info) - * [`.warn(message)`](#module_electron-updater/out/AppUpdater.Logger+warn) - * [.AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) ⇐ internal:EventEmitter - * [`.checkForUpdates()`](#module_electron-updater/out/AppUpdater.AppUpdater+checkForUpdates) ⇒ Promise - * [`.downloadUpdate(cancellationToken)`](#module_electron-updater/out/AppUpdater.AppUpdater+downloadUpdate) ⇒ Promise - * [`.getFeedURL()`](#module_electron-updater/out/AppUpdater.AppUpdater+getFeedURL) ⇒ - * [`.setFeedURL(options)`](#module_electron-updater/out/AppUpdater.AppUpdater+setFeedURL) - * [`.loadUpdateConfig()`](#module_electron-updater/out/AppUpdater.AppUpdater+loadUpdateConfig) ⇒ Promise - * [`.quitAndInstall()`](#module_electron-updater/out/AppUpdater.AppUpdater+quitAndInstall) - * [`.dispatchError(e)`](#module_electron-updater/out/AppUpdater.AppUpdater+dispatchError) - * [`.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)`](#module_electron-updater/out/AppUpdater.AppUpdater+doDownloadUpdate) ⇒ Promise - * [`.onUpdateAvailable(versionInfo, fileInfo)`](#module_electron-updater/out/AppUpdater.AppUpdater+onUpdateAvailable) +* [electron-builder/out/appInfo](#module_electron-builder/out/appInfo) + * [.AppInfo](#module_electron-builder/out/appInfo.AppInfo) + * [`.computePackageUrl()`](#module_electron-builder/out/appInfo.AppInfo+computePackageUrl) ⇒ Promise - - + -### `electron-updater/out/AppUpdater.Logger` -**Kind**: interface of [electron-updater/out/AppUpdater](#module_electron-updater/out/AppUpdater) +### electron-builder/out/appInfo.AppInfo +**Kind**: class of [electron-builder/out/appInfo](#module_electron-builder/out/appInfo) -* [`.Logger`](#module_electron-updater/out/AppUpdater.Logger) - * [`.error(message)`](#module_electron-updater/out/AppUpdater.Logger+error) - * [`.info(message)`](#module_electron-updater/out/AppUpdater.Logger+info) - * [`.warn(message)`](#module_electron-updater/out/AppUpdater.Logger+warn) +- + + +#### `appInfo.computePackageUrl()` ⇒ Promise +**Kind**: instance method of [AppInfo](#module_electron-builder/out/appInfo.AppInfo) - - + -#### `logger.error(message)` -**Kind**: instance method of [Logger](#module_electron-updater/out/AppUpdater.Logger) +## electron-builder/out/asar -| Param | -| --- | -| message | +* [electron-builder/out/asar](#module_electron-builder/out/asar) + * [.AsarFilesystem](#module_electron-builder/out/asar.AsarFilesystem) + * [`.getFile(p, followLinks)`](#module_electron-builder/out/asar.AsarFilesystem+getFile) ⇒ [Node](#module_electron-builder/out/asar.Node) + * [`.insertDirectory(p, unpacked)`](#module_electron-builder/out/asar.AsarFilesystem+insertDirectory) ⇒ module:electron-builder/out/asar.__type + * [`.insertFileNode(node, stat, file)`](#module_electron-builder/out/asar.AsarFilesystem+insertFileNode) + * [`.getNode(p)`](#module_electron-builder/out/asar.AsarFilesystem+getNode) ⇒ [Node](#module_electron-builder/out/asar.Node) + * [`.getOrCreateNode(p)`](#module_electron-builder/out/asar.AsarFilesystem+getOrCreateNode) ⇒ [Node](#module_electron-builder/out/asar.Node) + * [`.readFile(file)`](#module_electron-builder/out/asar.AsarFilesystem+readFile) ⇒ Promise + * [`.readJson(file)`](#module_electron-builder/out/asar.AsarFilesystem+readJson) ⇒ Promise + * [`.searchNodeFromDirectory(p)`](#module_electron-builder/out/asar.AsarFilesystem+searchNodeFromDirectory) ⇒ [Node](#module_electron-builder/out/asar.Node) + * [.Node](#module_electron-builder/out/asar.Node) + * [`.readAsar(archive)`](#module_electron-builder/out/asar.readAsar) ⇒ Promise + * [`.readAsarJson(archive, file)`](#module_electron-builder/out/asar.readAsarJson) ⇒ Promise - - + -#### `logger.info(message)` -**Kind**: instance method of [Logger](#module_electron-updater/out/AppUpdater.Logger) +### electron-builder/out/asar.AsarFilesystem +**Kind**: class of [electron-builder/out/asar](#module_electron-builder/out/asar) -| Param | -| --- | -| message | +* [.AsarFilesystem](#module_electron-builder/out/asar.AsarFilesystem) + * [`.getFile(p, followLinks)`](#module_electron-builder/out/asar.AsarFilesystem+getFile) ⇒ [Node](#module_electron-builder/out/asar.Node) + * [`.insertDirectory(p, unpacked)`](#module_electron-builder/out/asar.AsarFilesystem+insertDirectory) ⇒ module:electron-builder/out/asar.__type + * [`.insertFileNode(node, stat, file)`](#module_electron-builder/out/asar.AsarFilesystem+insertFileNode) + * [`.getNode(p)`](#module_electron-builder/out/asar.AsarFilesystem+getNode) ⇒ [Node](#module_electron-builder/out/asar.Node) + * [`.getOrCreateNode(p)`](#module_electron-builder/out/asar.AsarFilesystem+getOrCreateNode) ⇒ [Node](#module_electron-builder/out/asar.Node) + * [`.readFile(file)`](#module_electron-builder/out/asar.AsarFilesystem+readFile) ⇒ Promise + * [`.readJson(file)`](#module_electron-builder/out/asar.AsarFilesystem+readJson) ⇒ Promise + * [`.searchNodeFromDirectory(p)`](#module_electron-builder/out/asar.AsarFilesystem+searchNodeFromDirectory) ⇒ [Node](#module_electron-builder/out/asar.Node) - - + -#### `logger.warn(message)` -**Kind**: instance method of [Logger](#module_electron-updater/out/AppUpdater.Logger) +#### `asarFilesystem.getFile(p, followLinks)` ⇒ [Node](#module_electron-builder/out/asar.Node) +**Kind**: instance method of [AsarFilesystem](#module_electron-builder/out/asar.AsarFilesystem) -| Param | -| --- | -| message | +| Param | Type | +| --- | --- | +| p | string | +| followLinks | boolean | - - + -### electron-updater/out/AppUpdater.AppUpdater ⇐ internal:EventEmitter -**Kind**: class of [electron-updater/out/AppUpdater](#module_electron-updater/out/AppUpdater) -**Extends**: internal:EventEmitter +#### `asarFilesystem.insertDirectory(p, unpacked)` ⇒ module:electron-builder/out/asar.__type +**Kind**: instance method of [AsarFilesystem](#module_electron-builder/out/asar.AsarFilesystem) -* [.AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) ⇐ internal:EventEmitter - * [`.checkForUpdates()`](#module_electron-updater/out/AppUpdater.AppUpdater+checkForUpdates) ⇒ Promise - * [`.downloadUpdate(cancellationToken)`](#module_electron-updater/out/AppUpdater.AppUpdater+downloadUpdate) ⇒ Promise - * [`.getFeedURL()`](#module_electron-updater/out/AppUpdater.AppUpdater+getFeedURL) ⇒ - * [`.setFeedURL(options)`](#module_electron-updater/out/AppUpdater.AppUpdater+setFeedURL) - * [`.loadUpdateConfig()`](#module_electron-updater/out/AppUpdater.AppUpdater+loadUpdateConfig) ⇒ Promise - * [`.quitAndInstall()`](#module_electron-updater/out/AppUpdater.AppUpdater+quitAndInstall) - * [`.dispatchError(e)`](#module_electron-updater/out/AppUpdater.AppUpdater+dispatchError) - * [`.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)`](#module_electron-updater/out/AppUpdater.AppUpdater+doDownloadUpdate) ⇒ Promise - * [`.onUpdateAvailable(versionInfo, fileInfo)`](#module_electron-updater/out/AppUpdater.AppUpdater+onUpdateAvailable) +| Param | Type | +| --- | --- | +| p | string | +| unpacked | boolean | - - + -#### `appUpdater.checkForUpdates()` ⇒ Promise -**Kind**: instance method of [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) +#### `asarFilesystem.insertFileNode(node, stat, file)` +**Kind**: instance method of [AsarFilesystem](#module_electron-builder/out/asar.AsarFilesystem) -- +| Param | Type | +| --- | --- | +| node | [Node](#module_electron-builder/out/asar.Node) | +| stat | module:fs.Stats | +| file | string | - -#### `appUpdater.downloadUpdate(cancellationToken)` ⇒ Promise -Start downloading update manually. You can use this method if `autoDownload` option is set to `false`. +- + + -**Kind**: instance method of [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) -**Returns**: Promise - Path to downloaded file. +#### `asarFilesystem.getNode(p)` ⇒ [Node](#module_electron-builder/out/asar.Node) +**Kind**: instance method of [AsarFilesystem](#module_electron-builder/out/asar.AsarFilesystem) | Param | Type | | --- | --- | -| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | +| p | string | - - + + +#### `asarFilesystem.getOrCreateNode(p)` ⇒ [Node](#module_electron-builder/out/asar.Node) +**Kind**: instance method of [AsarFilesystem](#module_electron-builder/out/asar.AsarFilesystem) + +| Param | Type | +| --- | --- | +| p | string | -#### `appUpdater.getFeedURL()` ⇒ -**Kind**: instance method of [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) - - + -#### `appUpdater.setFeedURL(options)` -Configure update provider. If value is `string`, [GenericServerOptions](#module_electron-builder-http/out/publishOptions.GenericServerOptions) will be set with value as `url`. +#### `asarFilesystem.readFile(file)` ⇒ Promise +**Kind**: instance method of [AsarFilesystem](#module_electron-builder/out/asar.AsarFilesystem) -**Kind**: instance method of [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) +| Param | Type | +| --- | --- | +| file | string | -| Param | Type | Description | -| --- | --- | --- | -| options | [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) | [GenericServerOptions](#module_electron-builder-http/out/publishOptions.GenericServerOptions) | [S3Options](#module_electron-builder-http/out/publishOptions.S3Options) | [BintrayOptions](#module_electron-builder-http/out/publishOptions.BintrayOptions) | [GithubOptions](#module_electron-builder-http/out/publishOptions.GithubOptions) | string | If you want to override configuration in the `app-update.yml`. | + +- + + + +#### `asarFilesystem.readJson(file)` ⇒ Promise +**Kind**: instance method of [AsarFilesystem](#module_electron-builder/out/asar.AsarFilesystem) + +| Param | Type | +| --- | --- | +| file | string | - - + + +#### `asarFilesystem.searchNodeFromDirectory(p)` ⇒ [Node](#module_electron-builder/out/asar.Node) +**Kind**: instance method of [AsarFilesystem](#module_electron-builder/out/asar.AsarFilesystem) + +| Param | Type | +| --- | --- | +| p | string | -#### `appUpdater.loadUpdateConfig()` ⇒ Promise -**Kind**: instance method of [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) - - + -#### `appUpdater.quitAndInstall()` -**Kind**: instance method of [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) +### electron-builder/out/asar.Node +**Kind**: class of [electron-builder/out/asar](#module_electron-builder/out/asar) - - + -#### `appUpdater.dispatchError(e)` -**Kind**: instance method of [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) -**Access**: protected +### `electron-builder/out/asar.readAsar(archive)` ⇒ Promise +**Kind**: method of [electron-builder/out/asar](#module_electron-builder/out/asar) | Param | Type | | --- | --- | -| e | Error | +| archive | string | - - + -#### `appUpdater.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)` ⇒ Promise -**Kind**: instance method of [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) -**Access**: protected +### `electron-builder/out/asar.readAsarJson(archive, file)` ⇒ Promise +**Kind**: method of [electron-builder/out/asar](#module_electron-builder/out/asar) | Param | Type | | --- | --- | -| versionInfo | [VersionInfo](#module_electron-builder-http/out/publishOptions.VersionInfo) | -| fileInfo | [FileInfo](#module_electron-updater/out/api.FileInfo) | -| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | +| archive | string | +| file | string | - - + -#### `appUpdater.onUpdateAvailable(versionInfo, fileInfo)` -**Kind**: instance method of [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) -**Access**: protected +## electron-builder/out/asarUtil -| Param | Type | -| --- | --- | -| versionInfo | [VersionInfo](#module_electron-builder-http/out/publishOptions.VersionInfo) | -| fileInfo | [FileInfo](#module_electron-updater/out/api.FileInfo) | +* [electron-builder/out/asarUtil](#module_electron-builder/out/asarUtil) + * [`.checkFileInArchive(asarFile, relativeFile, messagePrefix)`](#module_electron-builder/out/asarUtil.checkFileInArchive) ⇒ Promise + * [`.createAsarArchive(src, resourcesPath, options, filter, unpackPattern)`](#module_electron-builder/out/asarUtil.createAsarArchive) ⇒ Promise - - + -## electron-updater/out/BintrayProvider +### `electron-builder/out/asarUtil.checkFileInArchive(asarFile, relativeFile, messagePrefix)` ⇒ Promise +**Kind**: method of [electron-builder/out/asarUtil](#module_electron-builder/out/asarUtil) -* [electron-updater/out/BintrayProvider](#module_electron-updater/out/BintrayProvider) - * [.BintrayProvider](#module_electron-updater/out/BintrayProvider.BintrayProvider) ⇐ [Provider](#module_electron-updater/out/api.Provider) - * [`.getLatestVersion()`](#module_electron-updater/out/BintrayProvider.BintrayProvider+getLatestVersion) ⇒ Promise - * [`.getUpdateFile(versionInfo)`](#module_electron-updater/out/BintrayProvider.BintrayProvider+getUpdateFile) ⇒ Promise - * [`.setRequestHeaders(value)`](#module_electron-updater/out/api.Provider+setRequestHeaders) +| Param | Type | +| --- | --- | +| asarFile | string | +| relativeFile | string | +| messagePrefix | string | - - + -### electron-updater/out/BintrayProvider.BintrayProvider ⇐ [Provider](#module_electron-updater/out/api.Provider) -**Kind**: class of [electron-updater/out/BintrayProvider](#module_electron-updater/out/BintrayProvider) -**Extends**: [Provider](#module_electron-updater/out/api.Provider) +### `electron-builder/out/asarUtil.createAsarArchive(src, resourcesPath, options, filter, unpackPattern)` ⇒ Promise +**Kind**: method of [electron-builder/out/asarUtil](#module_electron-builder/out/asarUtil) -* [.BintrayProvider](#module_electron-updater/out/BintrayProvider.BintrayProvider) ⇐ [Provider](#module_electron-updater/out/api.Provider) - * [`.getLatestVersion()`](#module_electron-updater/out/BintrayProvider.BintrayProvider+getLatestVersion) ⇒ Promise - * [`.getUpdateFile(versionInfo)`](#module_electron-updater/out/BintrayProvider.BintrayProvider+getUpdateFile) ⇒ Promise - * [`.setRequestHeaders(value)`](#module_electron-updater/out/api.Provider+setRequestHeaders) +| Param | Type | +| --- | --- | +| src | string | +| resourcesPath | string | +| options | [AsarOptions](#module_electron-builder-core.AsarOptions) | +| filter | module:electron-builder-util/out/fs.__type | +| unpackPattern | module:electron-builder-util/out/fs.__type | null | - - + -#### `bintrayProvider.getLatestVersion()` ⇒ Promise -**Kind**: instance method of [BintrayProvider](#module_electron-updater/out/BintrayProvider.BintrayProvider) -**Overrides**: [getLatestVersion](#module_electron-updater/out/api.Provider+getLatestVersion) +## electron-builder/out/builder - - + -#### `bintrayProvider.getUpdateFile(versionInfo)` ⇒ Promise -**Kind**: instance method of [BintrayProvider](#module_electron-updater/out/BintrayProvider.BintrayProvider) -**Overrides**: [getUpdateFile](#module_electron-updater/out/api.Provider+getUpdateFile) +### `electron-builder/out/builder.normalizeOptions(args)` ⇒ module:electron-builder/out/builder.BuildOptions +**Kind**: method of [electron-builder/out/builder](#module_electron-builder/out/builder) | Param | Type | | --- | --- | -| versionInfo | [VersionInfo](#module_electron-builder-http/out/publishOptions.VersionInfo) | +| args | [CliOptions](#module_electron-builder.CliOptions) | - - + -#### `bintrayProvider.setRequestHeaders(value)` -**Kind**: instance method of [BintrayProvider](#module_electron-updater/out/BintrayProvider.BintrayProvider) +## electron-builder/out/cli/cliOptions -| Param | Type | -| --- | --- | -| value | [RequestHeaders](#module_electron-builder-http.RequestHeaders) | null | +- + + +### `electron-builder/out/cli/cliOptions.createYargs()` ⇒ any +**Kind**: method of [electron-builder/out/cli/cliOptions](#module_electron-builder/out/cli/cliOptions) - - + -## electron-updater/out/GenericProvider +## electron-builder/out/codeSign -* [electron-updater/out/GenericProvider](#module_electron-updater/out/GenericProvider) - * [.GenericProvider](#module_electron-updater/out/GenericProvider.GenericProvider) ⇐ [Provider](#module_electron-updater/out/api.Provider) - * [`.getLatestVersion()`](#module_electron-updater/out/GenericProvider.GenericProvider+getLatestVersion) ⇒ Promise - * [`.getUpdateFile(versionInfo)`](#module_electron-updater/out/GenericProvider.GenericProvider+getUpdateFile) ⇒ Promise - * [`.setRequestHeaders(value)`](#module_electron-updater/out/api.Provider+setRequestHeaders) - * [`.validateUpdateInfo(info)`](#module_electron-updater/out/GenericProvider.validateUpdateInfo) +* [electron-builder/out/codeSign](#module_electron-builder/out/codeSign) + * [`.CodeSigningInfo`](#module_electron-builder/out/codeSign.CodeSigningInfo) + * [`.findIdentityRawResult`](#module_electron-builder/out/codeSign.findIdentityRawResult) : Promise | null + * [`.createKeychain(tmpDir, cscLink, cscKeyPassword, cscILink, cscIKeyPassword)`](#module_electron-builder/out/codeSign.createKeychain) ⇒ Promise + * [`.downloadCertificate(urlOrBase64, tmpDir)`](#module_electron-builder/out/codeSign.downloadCertificate) ⇒ Promise + * [`.findIdentity(certType, qualifier, keychain)`](#module_electron-builder/out/codeSign.findIdentity) ⇒ Promise + * [`.sign(path, name, keychain)`](#module_electron-builder/out/codeSign.sign) ⇒ Promise - - + + +### `electron-builder/out/codeSign.CodeSigningInfo` +**Kind**: interface of [electron-builder/out/codeSign](#module_electron-builder/out/codeSign) +**Properties** + +| Name | Type | +| --- | --- | +| keychainName | string | null | -### electron-updater/out/GenericProvider.GenericProvider ⇐ [Provider](#module_electron-updater/out/api.Provider) -**Kind**: class of [electron-updater/out/GenericProvider](#module_electron-updater/out/GenericProvider) -**Extends**: [Provider](#module_electron-updater/out/api.Provider) -* [.GenericProvider](#module_electron-updater/out/GenericProvider.GenericProvider) ⇐ [Provider](#module_electron-updater/out/api.Provider) - * [`.getLatestVersion()`](#module_electron-updater/out/GenericProvider.GenericProvider+getLatestVersion) ⇒ Promise - * [`.getUpdateFile(versionInfo)`](#module_electron-updater/out/GenericProvider.GenericProvider+getUpdateFile) ⇒ Promise - * [`.setRequestHeaders(value)`](#module_electron-updater/out/api.Provider+setRequestHeaders) +- + + +### `electron-builder/out/codeSign.findIdentityRawResult` : Promise | null +**Kind**: property of [electron-builder/out/codeSign](#module_electron-builder/out/codeSign) - - + + +### `electron-builder/out/codeSign.createKeychain(tmpDir, cscLink, cscKeyPassword, cscILink, cscIKeyPassword)` ⇒ Promise +**Kind**: method of [electron-builder/out/codeSign](#module_electron-builder/out/codeSign) + +| Param | Type | +| --- | --- | +| tmpDir | [TmpDir](#module_electron-builder-util/out/tmp.TmpDir) | +| cscLink | string | +| cscKeyPassword | string | +| cscILink | string | null | +| cscIKeyPassword | string | null | -#### `genericProvider.getLatestVersion()` ⇒ Promise -**Kind**: instance method of [GenericProvider](#module_electron-updater/out/GenericProvider.GenericProvider) -**Overrides**: [getLatestVersion](#module_electron-updater/out/api.Provider+getLatestVersion) - - + -#### `genericProvider.getUpdateFile(versionInfo)` ⇒ Promise -**Kind**: instance method of [GenericProvider](#module_electron-updater/out/GenericProvider.GenericProvider) -**Overrides**: [getUpdateFile](#module_electron-updater/out/api.Provider+getUpdateFile) +### `electron-builder/out/codeSign.downloadCertificate(urlOrBase64, tmpDir)` ⇒ Promise +**Kind**: method of [electron-builder/out/codeSign](#module_electron-builder/out/codeSign) | Param | Type | | --- | --- | -| versionInfo | [UpdateInfo](#module_electron-builder-http/out/publishOptions.UpdateInfo) | +| urlOrBase64 | string | +| tmpDir | [TmpDir](#module_electron-builder-util/out/tmp.TmpDir) | - - + -#### `genericProvider.setRequestHeaders(value)` -**Kind**: instance method of [GenericProvider](#module_electron-updater/out/GenericProvider.GenericProvider) +### `electron-builder/out/codeSign.findIdentity(certType, qualifier, keychain)` ⇒ Promise +**Kind**: method of [electron-builder/out/codeSign](#module_electron-builder/out/codeSign) | Param | Type | | --- | --- | -| value | [RequestHeaders](#module_electron-builder-http.RequestHeaders) | null | +| certType | "Developer ID Application" | "Developer ID Installer" | "3rd Party Mac Developer Application" | "3rd Party Mac Developer Installer" | "Mac Developer" | +| qualifier | string | null | +| keychain | string | null | - - + -### `electron-updater/out/GenericProvider.validateUpdateInfo(info)` -**Kind**: method of [electron-updater/out/GenericProvider](#module_electron-updater/out/GenericProvider) +### `electron-builder/out/codeSign.sign(path, name, keychain)` ⇒ Promise +**Kind**: method of [electron-builder/out/codeSign](#module_electron-builder/out/codeSign) | Param | Type | | --- | --- | -| info | [UpdateInfo](#module_electron-builder-http/out/publishOptions.UpdateInfo) | +| path | string | +| name | string | +| keychain | string | - - + -## electron-updater/out/GitHubProvider +## electron-builder/out/fileMatcher -* [electron-updater/out/GitHubProvider](#module_electron-updater/out/GitHubProvider) - * [.GitHubProvider](#module_electron-updater/out/GitHubProvider.GitHubProvider) ⇐ [Provider](#module_electron-updater/out/api.Provider) - * [`.getLatestVersion()`](#module_electron-updater/out/GitHubProvider.GitHubProvider+getLatestVersion) ⇒ Promise - * [`.getUpdateFile(versionInfo)`](#module_electron-updater/out/GitHubProvider.GitHubProvider+getUpdateFile) ⇒ Promise - * [`.setRequestHeaders(value)`](#module_electron-updater/out/api.Provider+setRequestHeaders) +* [electron-builder/out/fileMatcher](#module_electron-builder/out/fileMatcher) + * [.FileMatcher](#module_electron-builder/out/fileMatcher.FileMatcher) + * [`.addAllPattern()`](#module_electron-builder/out/fileMatcher.FileMatcher+addAllPattern) + * [`.addPattern(pattern)`](#module_electron-builder/out/fileMatcher.FileMatcher+addPattern) + * [`.computeParsedPatterns(result, fromDir)`](#module_electron-builder/out/fileMatcher.FileMatcher+computeParsedPatterns) + * [`.containsOnlyIgnore()`](#module_electron-builder/out/fileMatcher.FileMatcher+containsOnlyIgnore) ⇒ boolean + * [`.createFilter(ignoreFiles, rawFilter, excludePatterns)`](#module_electron-builder/out/fileMatcher.FileMatcher+createFilter) ⇒ module:electron-builder-util/out/fs.__type + * [`.isEmpty()`](#module_electron-builder/out/fileMatcher.FileMatcher+isEmpty) ⇒ boolean + * [`.copyFiles(patterns)`](#module_electron-builder/out/fileMatcher.copyFiles) ⇒ Promise - - + -### electron-updater/out/GitHubProvider.GitHubProvider ⇐ [Provider](#module_electron-updater/out/api.Provider) -**Kind**: class of [electron-updater/out/GitHubProvider](#module_electron-updater/out/GitHubProvider) -**Extends**: [Provider](#module_electron-updater/out/api.Provider) +### electron-builder/out/fileMatcher.FileMatcher +**Kind**: class of [electron-builder/out/fileMatcher](#module_electron-builder/out/fileMatcher) -* [.GitHubProvider](#module_electron-updater/out/GitHubProvider.GitHubProvider) ⇐ [Provider](#module_electron-updater/out/api.Provider) - * [`.getLatestVersion()`](#module_electron-updater/out/GitHubProvider.GitHubProvider+getLatestVersion) ⇒ Promise - * [`.getUpdateFile(versionInfo)`](#module_electron-updater/out/GitHubProvider.GitHubProvider+getUpdateFile) ⇒ Promise - * [`.setRequestHeaders(value)`](#module_electron-updater/out/api.Provider+setRequestHeaders) +* [.FileMatcher](#module_electron-builder/out/fileMatcher.FileMatcher) + * [`.addAllPattern()`](#module_electron-builder/out/fileMatcher.FileMatcher+addAllPattern) + * [`.addPattern(pattern)`](#module_electron-builder/out/fileMatcher.FileMatcher+addPattern) + * [`.computeParsedPatterns(result, fromDir)`](#module_electron-builder/out/fileMatcher.FileMatcher+computeParsedPatterns) + * [`.containsOnlyIgnore()`](#module_electron-builder/out/fileMatcher.FileMatcher+containsOnlyIgnore) ⇒ boolean + * [`.createFilter(ignoreFiles, rawFilter, excludePatterns)`](#module_electron-builder/out/fileMatcher.FileMatcher+createFilter) ⇒ module:electron-builder-util/out/fs.__type + * [`.isEmpty()`](#module_electron-builder/out/fileMatcher.FileMatcher+isEmpty) ⇒ boolean - - + -#### `gitHubProvider.getLatestVersion()` ⇒ Promise -**Kind**: instance method of [GitHubProvider](#module_electron-updater/out/GitHubProvider.GitHubProvider) -**Overrides**: [getLatestVersion](#module_electron-updater/out/api.Provider+getLatestVersion) +#### `fileMatcher.addAllPattern()` +**Kind**: instance method of [FileMatcher](#module_electron-builder/out/fileMatcher.FileMatcher) - - + -#### `gitHubProvider.getUpdateFile(versionInfo)` ⇒ Promise -**Kind**: instance method of [GitHubProvider](#module_electron-updater/out/GitHubProvider.GitHubProvider) -**Overrides**: [getUpdateFile](#module_electron-updater/out/api.Provider+getUpdateFile) +#### `fileMatcher.addPattern(pattern)` +**Kind**: instance method of [FileMatcher](#module_electron-builder/out/fileMatcher.FileMatcher) | Param | Type | | --- | --- | -| versionInfo | [UpdateInfo](#module_electron-builder-http/out/publishOptions.UpdateInfo) | +| pattern | string | - - + -#### `gitHubProvider.setRequestHeaders(value)` -**Kind**: instance method of [GitHubProvider](#module_electron-updater/out/GitHubProvider.GitHubProvider) +#### `fileMatcher.computeParsedPatterns(result, fromDir)` +**Kind**: instance method of [FileMatcher](#module_electron-builder/out/fileMatcher.FileMatcher) | Param | Type | | --- | --- | -| value | [RequestHeaders](#module_electron-builder-http.RequestHeaders) | null | +| result | Array | +| fromDir | string | - - - -## electron-updater/out/MacUpdater - -* [electron-updater/out/MacUpdater](#module_electron-updater/out/MacUpdater) - * [.MacUpdater](#module_electron-updater/out/MacUpdater.MacUpdater) ⇐ [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) - * [`.quitAndInstall()`](#module_electron-updater/out/MacUpdater.MacUpdater+quitAndInstall) - * [`.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)`](#module_electron-updater/out/MacUpdater.MacUpdater+doDownloadUpdate) ⇒ module:bluebird-lst.Bluebird - * [`.onUpdateAvailable(versionInfo, fileInfo)`](#module_electron-updater/out/MacUpdater.MacUpdater+onUpdateAvailable) - * [`.checkForUpdates()`](#module_electron-updater/out/AppUpdater.AppUpdater+checkForUpdates) ⇒ Promise - * [`.downloadUpdate(cancellationToken)`](#module_electron-updater/out/AppUpdater.AppUpdater+downloadUpdate) ⇒ Promise - * [`.getFeedURL()`](#module_electron-updater/out/AppUpdater.AppUpdater+getFeedURL) ⇒ - * [`.setFeedURL(options)`](#module_electron-updater/out/AppUpdater.AppUpdater+setFeedURL) - * [`.loadUpdateConfig()`](#module_electron-updater/out/AppUpdater.AppUpdater+loadUpdateConfig) ⇒ Promise - * [`.dispatchError(e)`](#module_electron-updater/out/AppUpdater.AppUpdater+dispatchError) + +#### `fileMatcher.containsOnlyIgnore()` ⇒ boolean +**Kind**: instance method of [FileMatcher](#module_electron-builder/out/fileMatcher.FileMatcher) - - + -### electron-updater/out/MacUpdater.MacUpdater ⇐ [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) -**Kind**: class of [electron-updater/out/MacUpdater](#module_electron-updater/out/MacUpdater) -**Extends**: [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) +#### `fileMatcher.createFilter(ignoreFiles, rawFilter, excludePatterns)` ⇒ module:electron-builder-util/out/fs.__type +**Kind**: instance method of [FileMatcher](#module_electron-builder/out/fileMatcher.FileMatcher) -* [.MacUpdater](#module_electron-updater/out/MacUpdater.MacUpdater) ⇐ [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) - * [`.quitAndInstall()`](#module_electron-updater/out/MacUpdater.MacUpdater+quitAndInstall) - * [`.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)`](#module_electron-updater/out/MacUpdater.MacUpdater+doDownloadUpdate) ⇒ module:bluebird-lst.Bluebird - * [`.onUpdateAvailable(versionInfo, fileInfo)`](#module_electron-updater/out/MacUpdater.MacUpdater+onUpdateAvailable) - * [`.checkForUpdates()`](#module_electron-updater/out/AppUpdater.AppUpdater+checkForUpdates) ⇒ Promise - * [`.downloadUpdate(cancellationToken)`](#module_electron-updater/out/AppUpdater.AppUpdater+downloadUpdate) ⇒ Promise - * [`.getFeedURL()`](#module_electron-updater/out/AppUpdater.AppUpdater+getFeedURL) ⇒ - * [`.setFeedURL(options)`](#module_electron-updater/out/AppUpdater.AppUpdater+setFeedURL) - * [`.loadUpdateConfig()`](#module_electron-updater/out/AppUpdater.AppUpdater+loadUpdateConfig) ⇒ Promise - * [`.dispatchError(e)`](#module_electron-updater/out/AppUpdater.AppUpdater+dispatchError) +| Param | Type | +| --- | --- | +| ignoreFiles | Set | +| rawFilter | callback | +| excludePatterns | Array | undefined | null | - - + -#### `macUpdater.quitAndInstall()` -**Kind**: instance method of [MacUpdater](#module_electron-updater/out/MacUpdater.MacUpdater) -**Overrides**: [quitAndInstall](#module_electron-updater/out/AppUpdater.AppUpdater+quitAndInstall) +#### `fileMatcher.isEmpty()` ⇒ boolean +**Kind**: instance method of [FileMatcher](#module_electron-builder/out/fileMatcher.FileMatcher) - - + -#### `macUpdater.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)` ⇒ module:bluebird-lst.Bluebird -**Kind**: instance method of [MacUpdater](#module_electron-updater/out/MacUpdater.MacUpdater) -**Overrides**: [doDownloadUpdate](#module_electron-updater/out/AppUpdater.AppUpdater+doDownloadUpdate) -**Access**: protected +### `electron-builder/out/fileMatcher.copyFiles(patterns)` ⇒ Promise +**Kind**: method of [electron-builder/out/fileMatcher](#module_electron-builder/out/fileMatcher) | Param | Type | | --- | --- | -| versionInfo | [VersionInfo](#module_electron-builder-http/out/publishOptions.VersionInfo) | -| fileInfo | [FileInfo](#module_electron-updater/out/api.FileInfo) | -| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | +| patterns | Array | null | - - + -#### `macUpdater.onUpdateAvailable(versionInfo, fileInfo)` -**Kind**: instance method of [MacUpdater](#module_electron-updater/out/MacUpdater.MacUpdater) -**Overrides**: [onUpdateAvailable](#module_electron-updater/out/AppUpdater.AppUpdater+onUpdateAvailable) -**Access**: protected +## electron-builder/out/linuxPackager -| Param | Type | -| --- | --- | -| versionInfo | [VersionInfo](#module_electron-builder-http/out/publishOptions.VersionInfo) | -| fileInfo | [FileInfo](#module_electron-updater/out/api.FileInfo) | +* [electron-builder/out/linuxPackager](#module_electron-builder/out/linuxPackager) + * [.LinuxPackager](#module_electron-builder/out/linuxPackager.LinuxPackager) ⇐ [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) + * [`.createTargets(targets, mapper, cleanupTasks)`](#module_electron-builder/out/linuxPackager.LinuxPackager+createTargets) + * [`.postInitApp(appOutDir)`](#module_electron-builder/out/linuxPackager.LinuxPackager+postInitApp) ⇒ Promise + * [`.getDefaultIcon(ext)`](#module_electron-builder/out/platformPackager.PlatformPackager+getDefaultIcon) ⇒ Promise + * [`.dispatchArtifactCreated(file, target, safeArtifactName)`](#module_electron-builder/out/platformPackager.PlatformPackager+dispatchArtifactCreated) + * [`.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern)`](#module_electron-builder/out/platformPackager.PlatformPackager+expandArtifactNamePattern) ⇒ string + * [`.expandMacro(pattern, arch, extra)`](#module_electron-builder/out/platformPackager.PlatformPackager+expandMacro) ⇒ string + * [`.generateName(ext, arch, deployment, classifier)`](#module_electron-builder/out/platformPackager.PlatformPackager+generateName) ⇒ string + * [`.generateName2(ext, classifier, deployment)`](#module_electron-builder/out/platformPackager.PlatformPackager+generateName2) ⇒ string + * [`.getIconPath()`](#module_electron-builder/out/platformPackager.PlatformPackager+getIconPath) ⇒ Promise + * [`.getMacOsResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getMacOsResourcesDir) ⇒ string + * [`.pack(outDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+pack) ⇒ Promise + * [`.getResource(custom, names)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResource) ⇒ Promise + * [`.getResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResourcesDir) ⇒ string + * [`.getTempFile(suffix)`](#module_electron-builder/out/platformPackager.PlatformPackager+getTempFile) ⇒ Promise + * [`.computeAppOutDir(outDir, arch)`](#module_electron-builder/out/platformPackager.PlatformPackager+computeAppOutDir) ⇒ string + * [`.getCscPassword()`](#module_electron-builder/out/platformPackager.PlatformPackager+getCscPassword) ⇒ string + * [`.doGetCscPassword()`](#module_electron-builder/out/platformPackager.PlatformPackager+doGetCscPassword) ⇒ any + * [`.doPack(outDir, appOutDir, platformName, arch, platformSpecificBuildOptions, targets)`](#module_electron-builder/out/platformPackager.PlatformPackager+doPack) ⇒ Promise + * [`.packageInDistributableFormat(appOutDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+packageInDistributableFormat) + * [`.prepareAppInfo(appInfo)`](#module_electron-builder/out/platformPackager.PlatformPackager+prepareAppInfo) ⇒ [AppInfo](#module_electron-builder/out/appInfo.AppInfo) - - + -#### `macUpdater.checkForUpdates()` ⇒ Promise -**Kind**: instance method of [MacUpdater](#module_electron-updater/out/MacUpdater.MacUpdater) +### electron-builder/out/linuxPackager.LinuxPackager ⇐ [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) +**Kind**: class of [electron-builder/out/linuxPackager](#module_electron-builder/out/linuxPackager) +**Extends**: [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) -- +* [.LinuxPackager](#module_electron-builder/out/linuxPackager.LinuxPackager) ⇐ [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) + * [`.createTargets(targets, mapper, cleanupTasks)`](#module_electron-builder/out/linuxPackager.LinuxPackager+createTargets) + * [`.postInitApp(appOutDir)`](#module_electron-builder/out/linuxPackager.LinuxPackager+postInitApp) ⇒ Promise + * [`.getDefaultIcon(ext)`](#module_electron-builder/out/platformPackager.PlatformPackager+getDefaultIcon) ⇒ Promise + * [`.dispatchArtifactCreated(file, target, safeArtifactName)`](#module_electron-builder/out/platformPackager.PlatformPackager+dispatchArtifactCreated) + * [`.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern)`](#module_electron-builder/out/platformPackager.PlatformPackager+expandArtifactNamePattern) ⇒ string + * [`.expandMacro(pattern, arch, extra)`](#module_electron-builder/out/platformPackager.PlatformPackager+expandMacro) ⇒ string + * [`.generateName(ext, arch, deployment, classifier)`](#module_electron-builder/out/platformPackager.PlatformPackager+generateName) ⇒ string + * [`.generateName2(ext, classifier, deployment)`](#module_electron-builder/out/platformPackager.PlatformPackager+generateName2) ⇒ string + * [`.getIconPath()`](#module_electron-builder/out/platformPackager.PlatformPackager+getIconPath) ⇒ Promise + * [`.getMacOsResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getMacOsResourcesDir) ⇒ string + * [`.pack(outDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+pack) ⇒ Promise + * [`.getResource(custom, names)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResource) ⇒ Promise + * [`.getResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResourcesDir) ⇒ string + * [`.getTempFile(suffix)`](#module_electron-builder/out/platformPackager.PlatformPackager+getTempFile) ⇒ Promise + * [`.computeAppOutDir(outDir, arch)`](#module_electron-builder/out/platformPackager.PlatformPackager+computeAppOutDir) ⇒ string + * [`.getCscPassword()`](#module_electron-builder/out/platformPackager.PlatformPackager+getCscPassword) ⇒ string + * [`.doGetCscPassword()`](#module_electron-builder/out/platformPackager.PlatformPackager+doGetCscPassword) ⇒ any + * [`.doPack(outDir, appOutDir, platformName, arch, platformSpecificBuildOptions, targets)`](#module_electron-builder/out/platformPackager.PlatformPackager+doPack) ⇒ Promise + * [`.packageInDistributableFormat(appOutDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+packageInDistributableFormat) + * [`.prepareAppInfo(appInfo)`](#module_electron-builder/out/platformPackager.PlatformPackager+prepareAppInfo) ⇒ [AppInfo](#module_electron-builder/out/appInfo.AppInfo) - -#### `macUpdater.downloadUpdate(cancellationToken)` ⇒ Promise -Start downloading update manually. You can use this method if `autoDownload` option is set to `false`. +- + + -**Kind**: instance method of [MacUpdater](#module_electron-updater/out/MacUpdater.MacUpdater) -**Returns**: Promise - Path to downloaded file. +#### `linuxPackager.createTargets(targets, mapper, cleanupTasks)` +**Kind**: instance method of [LinuxPackager](#module_electron-builder/out/linuxPackager.LinuxPackager) +**Overrides**: [createTargets](#module_electron-builder/out/platformPackager.PlatformPackager+createTargets) | Param | Type | | --- | --- | -| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | +| targets | Array | +| mapper | callback | +| cleanupTasks | Array | - - - -#### `macUpdater.getFeedURL()` ⇒ -**Kind**: instance method of [MacUpdater](#module_electron-updater/out/MacUpdater.MacUpdater) + -- - - +#### `linuxPackager.postInitApp(appOutDir)` ⇒ Promise +**Kind**: instance method of [LinuxPackager](#module_electron-builder/out/linuxPackager.LinuxPackager) +**Overrides**: [postInitApp](#module_electron-builder/out/platformPackager.PlatformPackager+postInitApp) +**Access**: protected -#### `macUpdater.setFeedURL(options)` -Configure update provider. If value is `string`, [GenericServerOptions](#module_electron-builder-http/out/publishOptions.GenericServerOptions) will be set with value as `url`. +| Param | Type | +| --- | --- | +| appOutDir | string | -**Kind**: instance method of [MacUpdater](#module_electron-updater/out/MacUpdater.MacUpdater) -| Param | Type | Description | -| --- | --- | --- | -| options | [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) | [GenericServerOptions](#module_electron-builder-http/out/publishOptions.GenericServerOptions) | [S3Options](#module_electron-builder-http/out/publishOptions.S3Options) | [BintrayOptions](#module_electron-builder-http/out/publishOptions.BintrayOptions) | [GithubOptions](#module_electron-builder-http/out/publishOptions.GithubOptions) | string | If you want to override configuration in the `app-update.yml`. | +- + -- +#### `linuxPackager.getDefaultIcon(ext)` ⇒ Promise +**Kind**: instance method of [LinuxPackager](#module_electron-builder/out/linuxPackager.LinuxPackager) - +| Param | Type | +| --- | --- | +| ext | string | -#### `macUpdater.loadUpdateConfig()` ⇒ Promise -**Kind**: instance method of [MacUpdater](#module_electron-updater/out/MacUpdater.MacUpdater) - - + -#### `macUpdater.dispatchError(e)` -**Kind**: instance method of [MacUpdater](#module_electron-updater/out/MacUpdater.MacUpdater) -**Access**: protected +#### `linuxPackager.dispatchArtifactCreated(file, target, safeArtifactName)` +**Kind**: instance method of [LinuxPackager](#module_electron-builder/out/linuxPackager.LinuxPackager) | Param | Type | | --- | --- | -| e | Error | +| file | string | +| target | [Target](#module_electron-builder-core.Target) | null | +| safeArtifactName | string | - - + -## electron-updater/out/NsisUpdater +#### `linuxPackager.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern)` ⇒ string +**Kind**: instance method of [LinuxPackager](#module_electron-builder/out/linuxPackager.LinuxPackager) -* [electron-updater/out/NsisUpdater](#module_electron-updater/out/NsisUpdater) - * [.NsisUpdater](#module_electron-updater/out/NsisUpdater.NsisUpdater) ⇐ [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) - * [`.quitAndInstall()`](#module_electron-updater/out/NsisUpdater.NsisUpdater+quitAndInstall) - * [`.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)`](#module_electron-updater/out/NsisUpdater.NsisUpdater+doDownloadUpdate) ⇒ Promise - * [`.checkForUpdates()`](#module_electron-updater/out/AppUpdater.AppUpdater+checkForUpdates) ⇒ Promise - * [`.downloadUpdate(cancellationToken)`](#module_electron-updater/out/AppUpdater.AppUpdater+downloadUpdate) ⇒ Promise - * [`.getFeedURL()`](#module_electron-updater/out/AppUpdater.AppUpdater+getFeedURL) ⇒ - * [`.setFeedURL(options)`](#module_electron-updater/out/AppUpdater.AppUpdater+setFeedURL) - * [`.loadUpdateConfig()`](#module_electron-updater/out/AppUpdater.AppUpdater+loadUpdateConfig) ⇒ Promise - * [`.dispatchError(e)`](#module_electron-updater/out/AppUpdater.AppUpdater+dispatchError) - * [`.onUpdateAvailable(versionInfo, fileInfo)`](#module_electron-updater/out/AppUpdater.AppUpdater+onUpdateAvailable) +| Param | Type | +| --- | --- | +| targetSpecificOptions | [TargetSpecificOptions](#module_electron-builder-core.TargetSpecificOptions) | undefined | null | +| ext | string | +| arch | "0" | "1" | "2" | null | +| defaultPattern | string | - - + -### electron-updater/out/NsisUpdater.NsisUpdater ⇐ [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) -**Kind**: class of [electron-updater/out/NsisUpdater](#module_electron-updater/out/NsisUpdater) -**Extends**: [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) +#### `linuxPackager.expandMacro(pattern, arch, extra)` ⇒ string +**Kind**: instance method of [LinuxPackager](#module_electron-builder/out/linuxPackager.LinuxPackager) -* [.NsisUpdater](#module_electron-updater/out/NsisUpdater.NsisUpdater) ⇐ [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) - * [`.quitAndInstall()`](#module_electron-updater/out/NsisUpdater.NsisUpdater+quitAndInstall) - * [`.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)`](#module_electron-updater/out/NsisUpdater.NsisUpdater+doDownloadUpdate) ⇒ Promise - * [`.checkForUpdates()`](#module_electron-updater/out/AppUpdater.AppUpdater+checkForUpdates) ⇒ Promise - * [`.downloadUpdate(cancellationToken)`](#module_electron-updater/out/AppUpdater.AppUpdater+downloadUpdate) ⇒ Promise - * [`.getFeedURL()`](#module_electron-updater/out/AppUpdater.AppUpdater+getFeedURL) ⇒ - * [`.setFeedURL(options)`](#module_electron-updater/out/AppUpdater.AppUpdater+setFeedURL) - * [`.loadUpdateConfig()`](#module_electron-updater/out/AppUpdater.AppUpdater+loadUpdateConfig) ⇒ Promise - * [`.dispatchError(e)`](#module_electron-updater/out/AppUpdater.AppUpdater+dispatchError) - * [`.onUpdateAvailable(versionInfo, fileInfo)`](#module_electron-updater/out/AppUpdater.AppUpdater+onUpdateAvailable) +| Param | Type | +| --- | --- | +| pattern | string | +| arch | "0" | "1" | "2" | undefined | null | +| extra | any | - - + -#### `nsisUpdater.quitAndInstall()` -**Kind**: instance method of [NsisUpdater](#module_electron-updater/out/NsisUpdater.NsisUpdater) -**Overrides**: [quitAndInstall](#module_electron-updater/out/AppUpdater.AppUpdater+quitAndInstall) +#### `linuxPackager.generateName(ext, arch, deployment, classifier)` ⇒ string +**Kind**: instance method of [LinuxPackager](#module_electron-builder/out/linuxPackager.LinuxPackager) -- +| Param | Type | +| --- | --- | +| ext | string | null | +| arch | "0" | "1" | "2" | +| deployment | boolean | +| classifier | string | null | - -#### `nsisUpdater.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)` ⇒ Promise -Start downloading update manually. You can use this method if `autoDownload` option is set to `false`. +- -**Kind**: instance method of [NsisUpdater](#module_electron-updater/out/NsisUpdater.NsisUpdater) -**Overrides**: [doDownloadUpdate](#module_electron-updater/out/AppUpdater.AppUpdater+doDownloadUpdate) -**Returns**: Promise - Path to downloaded file. -**Access**: protected + + +#### `linuxPackager.generateName2(ext, classifier, deployment)` ⇒ string +**Kind**: instance method of [LinuxPackager](#module_electron-builder/out/linuxPackager.LinuxPackager) | Param | Type | | --- | --- | -| versionInfo | [VersionInfo](#module_electron-builder-http/out/publishOptions.VersionInfo) | -| fileInfo | [FileInfo](#module_electron-updater/out/api.FileInfo) | -| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | +| ext | string | null | +| classifier | string | undefined | null | +| deployment | boolean | - - + -#### `nsisUpdater.checkForUpdates()` ⇒ Promise -**Kind**: instance method of [NsisUpdater](#module_electron-updater/out/NsisUpdater.NsisUpdater) +#### `linuxPackager.getIconPath()` ⇒ Promise +**Kind**: instance method of [LinuxPackager](#module_electron-builder/out/linuxPackager.LinuxPackager) - - + -#### `nsisUpdater.downloadUpdate(cancellationToken)` ⇒ Promise -Start downloading update manually. You can use this method if `autoDownload` option is set to `false`. - -**Kind**: instance method of [NsisUpdater](#module_electron-updater/out/NsisUpdater.NsisUpdater) -**Returns**: Promise - Path to downloaded file. +#### `linuxPackager.getMacOsResourcesDir(appOutDir)` ⇒ string +**Kind**: instance method of [LinuxPackager](#module_electron-builder/out/linuxPackager.LinuxPackager) | Param | Type | | --- | --- | -| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | +| appOutDir | string | - - + -#### `nsisUpdater.getFeedURL()` ⇒ -**Kind**: instance method of [NsisUpdater](#module_electron-updater/out/NsisUpdater.NsisUpdater) +#### `linuxPackager.pack(outDir, arch, targets, postAsyncTasks)` ⇒ Promise +**Kind**: instance method of [LinuxPackager](#module_electron-builder/out/linuxPackager.LinuxPackager) + +| Param | Type | +| --- | --- | +| outDir | string | +| arch | "0" | "1" | "2" | +| targets | Array | +| postAsyncTasks | Array | -- - +- -#### `nsisUpdater.setFeedURL(options)` -Configure update provider. If value is `string`, [GenericServerOptions](#module_electron-builder-http/out/publishOptions.GenericServerOptions) will be set with value as `url`. + -**Kind**: instance method of [NsisUpdater](#module_electron-updater/out/NsisUpdater.NsisUpdater) +#### `linuxPackager.getResource(custom, names)` ⇒ Promise +**Kind**: instance method of [LinuxPackager](#module_electron-builder/out/linuxPackager.LinuxPackager) -| Param | Type | Description | -| --- | --- | --- | -| options | [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) | [GenericServerOptions](#module_electron-builder-http/out/publishOptions.GenericServerOptions) | [S3Options](#module_electron-builder-http/out/publishOptions.S3Options) | [BintrayOptions](#module_electron-builder-http/out/publishOptions.BintrayOptions) | [GithubOptions](#module_electron-builder-http/out/publishOptions.GithubOptions) | string | If you want to override configuration in the `app-update.yml`. | +| Param | Type | +| --- | --- | +| custom | string | undefined | null | +| names | Array | - - + + +#### `linuxPackager.getResourcesDir(appOutDir)` ⇒ string +**Kind**: instance method of [LinuxPackager](#module_electron-builder/out/linuxPackager.LinuxPackager) + +| Param | Type | +| --- | --- | +| appOutDir | string | -#### `nsisUpdater.loadUpdateConfig()` ⇒ Promise -**Kind**: instance method of [NsisUpdater](#module_electron-updater/out/NsisUpdater.NsisUpdater) - - + -#### `nsisUpdater.dispatchError(e)` -**Kind**: instance method of [NsisUpdater](#module_electron-updater/out/NsisUpdater.NsisUpdater) -**Access**: protected +#### `linuxPackager.getTempFile(suffix)` ⇒ Promise +**Kind**: instance method of [LinuxPackager](#module_electron-builder/out/linuxPackager.LinuxPackager) | Param | Type | | --- | --- | -| e | Error | +| suffix | string | - - + -#### `nsisUpdater.onUpdateAvailable(versionInfo, fileInfo)` -**Kind**: instance method of [NsisUpdater](#module_electron-updater/out/NsisUpdater.NsisUpdater) +#### `linuxPackager.computeAppOutDir(outDir, arch)` ⇒ string +**Kind**: instance method of [LinuxPackager](#module_electron-builder/out/linuxPackager.LinuxPackager) **Access**: protected | Param | Type | | --- | --- | -| versionInfo | [VersionInfo](#module_electron-builder-http/out/publishOptions.VersionInfo) | -| fileInfo | [FileInfo](#module_electron-updater/out/api.FileInfo) | +| outDir | string | +| arch | "0" | "1" | "2" | - - + + +#### `linuxPackager.getCscPassword()` ⇒ string +**Kind**: instance method of [LinuxPackager](#module_electron-builder/out/linuxPackager.LinuxPackager) +**Access**: protected -## electron-updater/out/api +- -* [electron-updater/out/api](#module_electron-updater/out/api) - * [`.FileInfo`](#module_electron-updater/out/api.FileInfo) - * [`.UpdateCheckResult`](#module_electron-updater/out/api.UpdateCheckResult) - * [.Provider](#module_electron-updater/out/api.Provider) - * [`.getLatestVersion()`](#module_electron-updater/out/api.Provider+getLatestVersion) ⇒ Promise - * [`.setRequestHeaders(value)`](#module_electron-updater/out/api.Provider+setRequestHeaders) - * [`.getUpdateFile(versionInfo)`](#module_electron-updater/out/api.Provider+getUpdateFile) ⇒ Promise - * [.UpdaterSignal](#module_electron-updater/out/api.UpdaterSignal) - * [`.progress(handler)`](#module_electron-updater/out/api.UpdaterSignal+progress) - * [`.updateCancelled(handler)`](#module_electron-updater/out/api.UpdaterSignal+updateCancelled) - * [`.updateDownloaded(handler)`](#module_electron-updater/out/api.UpdaterSignal+updateDownloaded) - * [`.getDefaultChannelName()`](#module_electron-updater/out/api.getDefaultChannelName) ⇒ string - * [`.getCustomChannelName(channel)`](#module_electron-updater/out/api.getCustomChannelName) ⇒ string - * [`.getCurrentPlatform()`](#module_electron-updater/out/api.getCurrentPlatform) ⇒ - * [`.getChannelFilename(channel)`](#module_electron-updater/out/api.getChannelFilename) ⇒ string + +#### `linuxPackager.doGetCscPassword()` ⇒ any +**Kind**: instance method of [LinuxPackager](#module_electron-builder/out/linuxPackager.LinuxPackager) +**Access**: protected - - + -### `electron-updater/out/api.FileInfo` -**Kind**: interface of [electron-updater/out/api](#module_electron-updater/out/api) -**Properties** +#### `linuxPackager.doPack(outDir, appOutDir, platformName, arch, platformSpecificBuildOptions, targets)` ⇒ Promise +**Kind**: instance method of [LinuxPackager](#module_electron-builder/out/linuxPackager.LinuxPackager) +**Access**: protected -| Name | Type | +| Param | Type | | --- | --- | -| name | string | -| url | string | -| sha2 | string | +| outDir | string | +| appOutDir | string | +| platformName | string | +| arch | "0" | "1" | "2" | +| platformSpecificBuildOptions | module:electron-builder/out/platformPackager.DC | +| targets | Array | - - + -### `electron-updater/out/api.UpdateCheckResult` -**Kind**: interface of [electron-updater/out/api](#module_electron-updater/out/api) -**Properties** +#### `linuxPackager.packageInDistributableFormat(appOutDir, arch, targets, postAsyncTasks)` +**Kind**: instance method of [LinuxPackager](#module_electron-builder/out/linuxPackager.LinuxPackager) +**Access**: protected -| Name | Type | +| Param | Type | | --- | --- | -| versionInfo | [VersionInfo](#module_electron-builder-http/out/publishOptions.VersionInfo) | -| fileInfo | [FileInfo](#module_electron-updater/out/api.FileInfo) | -| downloadPromise | Promise | null | -| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | +| appOutDir | string | +| arch | "0" | "1" | "2" | +| targets | Array | +| postAsyncTasks | Array | - - + + +#### `linuxPackager.prepareAppInfo(appInfo)` ⇒ [AppInfo](#module_electron-builder/out/appInfo.AppInfo) +**Kind**: instance method of [LinuxPackager](#module_electron-builder/out/linuxPackager.LinuxPackager) +**Access**: protected -### electron-updater/out/api.Provider -**Kind**: class of [electron-updater/out/api](#module_electron-updater/out/api) +| Param | Type | +| --- | --- | +| appInfo | [AppInfo](#module_electron-builder/out/appInfo.AppInfo) | + + +- + + + +## electron-builder/out/macPackager + +* [electron-builder/out/macPackager](#module_electron-builder/out/macPackager) + * [.MacPackager](#module_electron-builder/out/macPackager.MacPackager) ⇐ [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) + * [`.createTargets(targets, mapper, cleanupTasks)`](#module_electron-builder/out/macPackager.MacPackager+createTargets) + * [`.getIconPath()`](#module_electron-builder/out/macPackager.MacPackager+getIconPath) ⇒ Promise + * [`.pack(outDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/macPackager.MacPackager+pack) ⇒ Promise + * [`.doFlat(appPath, outFile, identity, keychain)`](#module_electron-builder/out/macPackager.MacPackager+doFlat) ⇒ Promise + * [`.doSign(opts)`](#module_electron-builder/out/macPackager.MacPackager+doSign) ⇒ Promise + * [`.prepareAppInfo(appInfo)`](#module_electron-builder/out/macPackager.MacPackager+prepareAppInfo) ⇒ [AppInfo](#module_electron-builder/out/appInfo.AppInfo) + * [`.getDefaultIcon(ext)`](#module_electron-builder/out/platformPackager.PlatformPackager+getDefaultIcon) ⇒ Promise + * [`.dispatchArtifactCreated(file, target, safeArtifactName)`](#module_electron-builder/out/platformPackager.PlatformPackager+dispatchArtifactCreated) + * [`.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern)`](#module_electron-builder/out/platformPackager.PlatformPackager+expandArtifactNamePattern) ⇒ string + * [`.expandMacro(pattern, arch, extra)`](#module_electron-builder/out/platformPackager.PlatformPackager+expandMacro) ⇒ string + * [`.generateName(ext, arch, deployment, classifier)`](#module_electron-builder/out/platformPackager.PlatformPackager+generateName) ⇒ string + * [`.generateName2(ext, classifier, deployment)`](#module_electron-builder/out/platformPackager.PlatformPackager+generateName2) ⇒ string + * [`.getMacOsResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getMacOsResourcesDir) ⇒ string + * [`.getResource(custom, names)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResource) ⇒ Promise + * [`.getResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResourcesDir) ⇒ string + * [`.getTempFile(suffix)`](#module_electron-builder/out/platformPackager.PlatformPackager+getTempFile) ⇒ Promise + * [`.computeAppOutDir(outDir, arch)`](#module_electron-builder/out/platformPackager.PlatformPackager+computeAppOutDir) ⇒ string + * [`.getCscPassword()`](#module_electron-builder/out/platformPackager.PlatformPackager+getCscPassword) ⇒ string + * [`.doGetCscPassword()`](#module_electron-builder/out/platformPackager.PlatformPackager+doGetCscPassword) ⇒ any + * [`.doPack(outDir, appOutDir, platformName, arch, platformSpecificBuildOptions, targets)`](#module_electron-builder/out/platformPackager.PlatformPackager+doPack) ⇒ Promise + * [`.packageInDistributableFormat(appOutDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+packageInDistributableFormat) + * [`.postInitApp(executableFile)`](#module_electron-builder/out/platformPackager.PlatformPackager+postInitApp) ⇒ Promise + + +- + + + +### electron-builder/out/macPackager.MacPackager ⇐ [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) +**Kind**: class of [electron-builder/out/macPackager](#module_electron-builder/out/macPackager) +**Extends**: [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) + +* [.MacPackager](#module_electron-builder/out/macPackager.MacPackager) ⇐ [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) + * [`.createTargets(targets, mapper, cleanupTasks)`](#module_electron-builder/out/macPackager.MacPackager+createTargets) + * [`.getIconPath()`](#module_electron-builder/out/macPackager.MacPackager+getIconPath) ⇒ Promise + * [`.pack(outDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/macPackager.MacPackager+pack) ⇒ Promise + * [`.doFlat(appPath, outFile, identity, keychain)`](#module_electron-builder/out/macPackager.MacPackager+doFlat) ⇒ Promise + * [`.doSign(opts)`](#module_electron-builder/out/macPackager.MacPackager+doSign) ⇒ Promise + * [`.prepareAppInfo(appInfo)`](#module_electron-builder/out/macPackager.MacPackager+prepareAppInfo) ⇒ [AppInfo](#module_electron-builder/out/appInfo.AppInfo) + * [`.getDefaultIcon(ext)`](#module_electron-builder/out/platformPackager.PlatformPackager+getDefaultIcon) ⇒ Promise + * [`.dispatchArtifactCreated(file, target, safeArtifactName)`](#module_electron-builder/out/platformPackager.PlatformPackager+dispatchArtifactCreated) + * [`.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern)`](#module_electron-builder/out/platformPackager.PlatformPackager+expandArtifactNamePattern) ⇒ string + * [`.expandMacro(pattern, arch, extra)`](#module_electron-builder/out/platformPackager.PlatformPackager+expandMacro) ⇒ string + * [`.generateName(ext, arch, deployment, classifier)`](#module_electron-builder/out/platformPackager.PlatformPackager+generateName) ⇒ string + * [`.generateName2(ext, classifier, deployment)`](#module_electron-builder/out/platformPackager.PlatformPackager+generateName2) ⇒ string + * [`.getMacOsResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getMacOsResourcesDir) ⇒ string + * [`.getResource(custom, names)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResource) ⇒ Promise + * [`.getResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResourcesDir) ⇒ string + * [`.getTempFile(suffix)`](#module_electron-builder/out/platformPackager.PlatformPackager+getTempFile) ⇒ Promise + * [`.computeAppOutDir(outDir, arch)`](#module_electron-builder/out/platformPackager.PlatformPackager+computeAppOutDir) ⇒ string + * [`.getCscPassword()`](#module_electron-builder/out/platformPackager.PlatformPackager+getCscPassword) ⇒ string + * [`.doGetCscPassword()`](#module_electron-builder/out/platformPackager.PlatformPackager+doGetCscPassword) ⇒ any + * [`.doPack(outDir, appOutDir, platformName, arch, platformSpecificBuildOptions, targets)`](#module_electron-builder/out/platformPackager.PlatformPackager+doPack) ⇒ Promise + * [`.packageInDistributableFormat(appOutDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+packageInDistributableFormat) + * [`.postInitApp(executableFile)`](#module_electron-builder/out/platformPackager.PlatformPackager+postInitApp) ⇒ Promise + + +- + + + +#### `macPackager.createTargets(targets, mapper, cleanupTasks)` +**Kind**: instance method of [MacPackager](#module_electron-builder/out/macPackager.MacPackager) +**Overrides**: [createTargets](#module_electron-builder/out/platformPackager.PlatformPackager+createTargets) -* [.Provider](#module_electron-updater/out/api.Provider) - * [`.getLatestVersion()`](#module_electron-updater/out/api.Provider+getLatestVersion) ⇒ Promise - * [`.setRequestHeaders(value)`](#module_electron-updater/out/api.Provider+setRequestHeaders) - * [`.getUpdateFile(versionInfo)`](#module_electron-updater/out/api.Provider+getUpdateFile) ⇒ Promise +| Param | Type | +| --- | --- | +| targets | Array | +| mapper | callback | +| cleanupTasks | Array | - - + -#### `provider.getLatestVersion()` ⇒ Promise -**Kind**: instance method of [Provider](#module_electron-updater/out/api.Provider) +#### `macPackager.getIconPath()` ⇒ Promise +**Kind**: instance method of [MacPackager](#module_electron-builder/out/macPackager.MacPackager) +**Overrides**: [getIconPath](#module_electron-builder/out/platformPackager.PlatformPackager+getIconPath) - - + -#### `provider.setRequestHeaders(value)` -**Kind**: instance method of [Provider](#module_electron-updater/out/api.Provider) +#### `macPackager.pack(outDir, arch, targets, postAsyncTasks)` ⇒ Promise +**Kind**: instance method of [MacPackager](#module_electron-builder/out/macPackager.MacPackager) +**Overrides**: [pack](#module_electron-builder/out/platformPackager.PlatformPackager+pack) | Param | Type | | --- | --- | -| value | [RequestHeaders](#module_electron-builder-http.RequestHeaders) | null | +| outDir | string | +| arch | "0" | "1" | "2" | +| targets | Array | +| postAsyncTasks | Array | - - + -#### `provider.getUpdateFile(versionInfo)` ⇒ Promise -**Kind**: instance method of [Provider](#module_electron-updater/out/api.Provider) +#### `macPackager.doFlat(appPath, outFile, identity, keychain)` ⇒ Promise +**Kind**: instance method of [MacPackager](#module_electron-builder/out/macPackager.MacPackager) +**Access**: protected | Param | Type | | --- | --- | -| versionInfo | module:electron-updater/out/api.T | +| appPath | string | +| outFile | string | +| identity | string | +| keychain | string | undefined | null | - - + -### electron-updater/out/api.UpdaterSignal -**Kind**: class of [electron-updater/out/api](#module_electron-updater/out/api) +#### `macPackager.doSign(opts)` ⇒ Promise +**Kind**: instance method of [MacPackager](#module_electron-builder/out/macPackager.MacPackager) +**Access**: protected -* [.UpdaterSignal](#module_electron-updater/out/api.UpdaterSignal) - * [`.progress(handler)`](#module_electron-updater/out/api.UpdaterSignal+progress) - * [`.updateCancelled(handler)`](#module_electron-updater/out/api.UpdaterSignal+updateCancelled) - * [`.updateDownloaded(handler)`](#module_electron-updater/out/api.UpdaterSignal+updateDownloaded) +| Param | Type | +| --- | --- | +| opts | module:electron-macos-sign.SignOptions | - - + -#### `updaterSignal.progress(handler)` -**Kind**: instance method of [UpdaterSignal](#module_electron-updater/out/api.UpdaterSignal) +#### `macPackager.prepareAppInfo(appInfo)` ⇒ [AppInfo](#module_electron-builder/out/appInfo.AppInfo) +**Kind**: instance method of [MacPackager](#module_electron-builder/out/macPackager.MacPackager) +**Overrides**: [prepareAppInfo](#module_electron-builder/out/platformPackager.PlatformPackager+prepareAppInfo) +**Access**: protected | Param | Type | | --- | --- | -| handler | callback | +| appInfo | [AppInfo](#module_electron-builder/out/appInfo.AppInfo) | - - + -#### `updaterSignal.updateCancelled(handler)` -**Kind**: instance method of [UpdaterSignal](#module_electron-updater/out/api.UpdaterSignal) +#### `macPackager.getDefaultIcon(ext)` ⇒ Promise +**Kind**: instance method of [MacPackager](#module_electron-builder/out/macPackager.MacPackager) | Param | Type | | --- | --- | -| handler | callback | +| ext | string | - - + -#### `updaterSignal.updateDownloaded(handler)` -**Kind**: instance method of [UpdaterSignal](#module_electron-updater/out/api.UpdaterSignal) +#### `macPackager.dispatchArtifactCreated(file, target, safeArtifactName)` +**Kind**: instance method of [MacPackager](#module_electron-builder/out/macPackager.MacPackager) | Param | Type | | --- | --- | -| handler | callback | +| file | string | +| target | [Target](#module_electron-builder-core.Target) | null | +| safeArtifactName | string | - - + + +#### `macPackager.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern)` ⇒ string +**Kind**: instance method of [MacPackager](#module_electron-builder/out/macPackager.MacPackager) + +| Param | Type | +| --- | --- | +| targetSpecificOptions | [TargetSpecificOptions](#module_electron-builder-core.TargetSpecificOptions) | undefined | null | +| ext | string | +| arch | "0" | "1" | "2" | null | +| defaultPattern | string | -### `electron-updater/out/api.getDefaultChannelName()` ⇒ string -**Kind**: method of [electron-updater/out/api](#module_electron-updater/out/api) - - + -### `electron-updater/out/api.getCustomChannelName(channel)` ⇒ string -**Kind**: method of [electron-updater/out/api](#module_electron-updater/out/api) +#### `macPackager.expandMacro(pattern, arch, extra)` ⇒ string +**Kind**: instance method of [MacPackager](#module_electron-builder/out/macPackager.MacPackager) | Param | Type | | --- | --- | -| channel | string | +| pattern | string | +| arch | "0" | "1" | "2" | undefined | null | +| extra | any | - - + + +#### `macPackager.generateName(ext, arch, deployment, classifier)` ⇒ string +**Kind**: instance method of [MacPackager](#module_electron-builder/out/macPackager.MacPackager) + +| Param | Type | +| --- | --- | +| ext | string | null | +| arch | "0" | "1" | "2" | +| deployment | boolean | +| classifier | string | null | -### `electron-updater/out/api.getCurrentPlatform()` ⇒ -**Kind**: method of [electron-updater/out/api](#module_electron-updater/out/api) - - + -### `electron-updater/out/api.getChannelFilename(channel)` ⇒ string -**Kind**: method of [electron-updater/out/api](#module_electron-updater/out/api) +#### `macPackager.generateName2(ext, classifier, deployment)` ⇒ string +**Kind**: instance method of [MacPackager](#module_electron-builder/out/macPackager.MacPackager) | Param | Type | | --- | --- | -| channel | string | +| ext | string | null | +| classifier | string | undefined | null | +| deployment | boolean | - - + -## electron-updater/out/electronHttpExecutor +#### `macPackager.getMacOsResourcesDir(appOutDir)` ⇒ string +**Kind**: instance method of [MacPackager](#module_electron-builder/out/macPackager.MacPackager) -* [electron-updater/out/electronHttpExecutor](#module_electron-updater/out/electronHttpExecutor) - * [.ElectronHttpExecutor](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor) ⇐ [HttpExecutor](#module_electron-builder-http.HttpExecutor) - * [`.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+doApiRequest) ⇒ Promise - * [`.download(url, destination, options)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+download) ⇒ Promise - * [`.doRequest(options, callback)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+doRequest) ⇒ - * [`.request(options, cancellationToken, data)`](#module_electron-builder-http.HttpExecutor+request) ⇒ Promise - * [`.addTimeOutHandler(request, callback)`](#module_electron-builder-http.HttpExecutor+addTimeOutHandler) - * [`.doDownload(requestOptions, destination, redirectCount, options, callback, onCancel)`](#module_electron-builder-http.HttpExecutor+doDownload) - * [`.handleResponse(response, options, cancellationToken, resolve, reject, redirectCount, requestProcessor)`](#module_electron-builder-http.HttpExecutor+handleResponse) +| Param | Type | +| --- | --- | +| appOutDir | string | - - + -### electron-updater/out/electronHttpExecutor.ElectronHttpExecutor ⇐ [HttpExecutor](#module_electron-builder-http.HttpExecutor) -**Kind**: class of [electron-updater/out/electronHttpExecutor](#module_electron-updater/out/electronHttpExecutor) -**Extends**: [HttpExecutor](#module_electron-builder-http.HttpExecutor) +#### `macPackager.getResource(custom, names)` ⇒ Promise +**Kind**: instance method of [MacPackager](#module_electron-builder/out/macPackager.MacPackager) -* [.ElectronHttpExecutor](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor) ⇐ [HttpExecutor](#module_electron-builder-http.HttpExecutor) - * [`.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+doApiRequest) ⇒ Promise - * [`.download(url, destination, options)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+download) ⇒ Promise - * [`.doRequest(options, callback)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+doRequest) ⇒ - * [`.request(options, cancellationToken, data)`](#module_electron-builder-http.HttpExecutor+request) ⇒ Promise - * [`.addTimeOutHandler(request, callback)`](#module_electron-builder-http.HttpExecutor+addTimeOutHandler) - * [`.doDownload(requestOptions, destination, redirectCount, options, callback, onCancel)`](#module_electron-builder-http.HttpExecutor+doDownload) - * [`.handleResponse(response, options, cancellationToken, resolve, reject, redirectCount, requestProcessor)`](#module_electron-builder-http.HttpExecutor+handleResponse) +| Param | Type | +| --- | --- | +| custom | string | undefined | null | +| names | Array | - - + -#### `electronHttpExecutor.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)` ⇒ Promise -**Kind**: instance method of [ElectronHttpExecutor](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor) -**Overrides**: [doApiRequest](#module_electron-builder-http.HttpExecutor+doApiRequest) +#### `macPackager.getResourcesDir(appOutDir)` ⇒ string +**Kind**: instance method of [MacPackager](#module_electron-builder/out/macPackager.MacPackager) | Param | Type | | --- | --- | -| options | Electron:RequestOptions | -| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | -| requestProcessor | callback | -| redirectCount | number | +| appOutDir | string | - - + -#### `electronHttpExecutor.download(url, destination, options)` ⇒ Promise -**Kind**: instance method of [ElectronHttpExecutor](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor) -**Overrides**: [download](#module_electron-builder-http.HttpExecutor+download) +#### `macPackager.getTempFile(suffix)` ⇒ Promise +**Kind**: instance method of [MacPackager](#module_electron-builder/out/macPackager.MacPackager) | Param | Type | | --- | --- | -| url | string | -| destination | string | -| options | [DownloadOptions](#module_electron-builder-http.DownloadOptions) | +| suffix | string | - - + -#### `electronHttpExecutor.doRequest(options, callback)` ⇒ -**Kind**: instance method of [ElectronHttpExecutor](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor) -**Overrides**: [doRequest](#module_electron-builder-http.HttpExecutor+doRequest) +#### `macPackager.computeAppOutDir(outDir, arch)` ⇒ string +**Kind**: instance method of [MacPackager](#module_electron-builder/out/macPackager.MacPackager) **Access**: protected | Param | Type | | --- | --- | -| options | | -| callback | callback | +| outDir | string | +| arch | "0" | "1" | "2" | - - + -#### `electronHttpExecutor.request(options, cancellationToken, data)` ⇒ Promise -**Kind**: instance method of [ElectronHttpExecutor](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor) +#### `macPackager.getCscPassword()` ⇒ string +**Kind**: instance method of [MacPackager](#module_electron-builder/out/macPackager.MacPackager) +**Access**: protected -| Param | Type | -| --- | --- | -| options | module:http.RequestOptions | -| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | -| data | module:electron-builder-http.__type | null | +- + + +#### `macPackager.doGetCscPassword()` ⇒ any +**Kind**: instance method of [MacPackager](#module_electron-builder/out/macPackager.MacPackager) +**Access**: protected - - + -#### `electronHttpExecutor.addTimeOutHandler(request, callback)` -**Kind**: instance method of [ElectronHttpExecutor](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor) +#### `macPackager.doPack(outDir, appOutDir, platformName, arch, platformSpecificBuildOptions, targets)` ⇒ Promise +**Kind**: instance method of [MacPackager](#module_electron-builder/out/macPackager.MacPackager) **Access**: protected | Param | Type | | --- | --- | -| request | | -| callback | callback | +| outDir | string | +| appOutDir | string | +| platformName | string | +| arch | "0" | "1" | "2" | +| platformSpecificBuildOptions | module:electron-builder/out/platformPackager.DC | +| targets | Array | - - + -#### `electronHttpExecutor.doDownload(requestOptions, destination, redirectCount, options, callback, onCancel)` -**Kind**: instance method of [ElectronHttpExecutor](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor) +#### `macPackager.packageInDistributableFormat(appOutDir, arch, targets, postAsyncTasks)` +**Kind**: instance method of [MacPackager](#module_electron-builder/out/macPackager.MacPackager) **Access**: protected | Param | Type | | --- | --- | -| requestOptions | | -| destination | string | -| redirectCount | number | -| options | [DownloadOptions](#module_electron-builder-http.DownloadOptions) | -| callback | callback | -| onCancel | callback | +| appOutDir | string | +| arch | "0" | "1" | "2" | +| targets | Array | +| postAsyncTasks | Array | - - + -#### `electronHttpExecutor.handleResponse(response, options, cancellationToken, resolve, reject, redirectCount, requestProcessor)` -**Kind**: instance method of [ElectronHttpExecutor](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor) +#### `macPackager.postInitApp(executableFile)` ⇒ Promise +**Kind**: instance method of [MacPackager](#module_electron-builder/out/macPackager.MacPackager) **Access**: protected | Param | Type | | --- | --- | -| response | [Response](#module_electron-builder-http.Response) | -| options | module:http.RequestOptions | -| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | -| resolve | callback | -| reject | callback | -| redirectCount | number | -| requestProcessor | callback | +| executableFile | string | - - + -## electron-updater +## electron-builder/out/packager/dirPackager - - + + +### `electron-builder/out/packager/dirPackager.unpackElectron(packager, out, platform, arch, electronVersion)` ⇒ Promise +**Kind**: method of [electron-builder/out/packager/dirPackager](#module_electron-builder/out/packager/dirPackager) + +| Param | Type | +| --- | --- | +| packager | [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) | +| out | string | +| platform | string | +| arch | string | +| electronVersion | string | -### `electron-updater.autoUpdater` : [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) -**Kind**: constant of [electron-updater](#module_electron-updater) - - + -## electron-builder-http/out/CancellationToken +## electron-builder/out/packager/mac -* [electron-builder-http/out/CancellationToken](#module_electron-builder-http/out/CancellationToken) - * [.CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) ⇐ internal:EventEmitter - * [`.cancel()`](#module_electron-builder-http/out/CancellationToken.CancellationToken+cancel) - * [`.createPromise(callback)`](#module_electron-builder-http/out/CancellationToken.CancellationToken+createPromise) ⇒ Promise - * [`.dispose()`](#module_electron-builder-http/out/CancellationToken.CancellationToken+dispose) - * [.CancellationError](#module_electron-builder-http/out/CancellationToken.CancellationError) ⇐ Error +* [electron-builder/out/packager/mac](#module_electron-builder/out/packager/mac) + * [`.createApp(packager, appOutDir)`](#module_electron-builder/out/packager/mac.createApp) ⇒ Promise + * [`.filterCFBundleIdentifier(identifier)`](#module_electron-builder/out/packager/mac.filterCFBundleIdentifier) ⇒ string - - + -### electron-builder-http/out/CancellationToken.CancellationToken ⇐ internal:EventEmitter -**Kind**: class of [electron-builder-http/out/CancellationToken](#module_electron-builder-http/out/CancellationToken) -**Extends**: internal:EventEmitter +### `electron-builder/out/packager/mac.createApp(packager, appOutDir)` ⇒ Promise +**Kind**: method of [electron-builder/out/packager/mac](#module_electron-builder/out/packager/mac) -* [.CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) ⇐ internal:EventEmitter - * [`.cancel()`](#module_electron-builder-http/out/CancellationToken.CancellationToken+cancel) - * [`.createPromise(callback)`](#module_electron-builder-http/out/CancellationToken.CancellationToken+createPromise) ⇒ Promise - * [`.dispose()`](#module_electron-builder-http/out/CancellationToken.CancellationToken+dispose) +| Param | Type | +| --- | --- | +| packager | [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) | +| appOutDir | string | - - + + +### `electron-builder/out/packager/mac.filterCFBundleIdentifier(identifier)` ⇒ string +**Kind**: method of [electron-builder/out/packager/mac](#module_electron-builder/out/packager/mac) + +| Param | Type | +| --- | --- | +| identifier | string | -#### `cancellationToken.cancel()` -**Kind**: instance method of [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) - - + -#### `cancellationToken.createPromise(callback)` ⇒ Promise +## electron-builder/out/packager + +- + + + +### `electron-builder/out/packager.normalizePlatforms(rawPlatforms)` ⇒ Array +**Kind**: method of [electron-builder/out/packager](#module_electron-builder/out/packager) + +| Param | Type | +| --- | --- | +| rawPlatforms | Array | string | [Platform](#module_electron-builder-core.Platform) | undefined | null | + + +- + + + +## electron-builder/out/platformPackager + +* [electron-builder/out/platformPackager](#module_electron-builder/out/platformPackager) + * [.PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) + * [`.createTargets(targets, mapper, cleanupTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+createTargets) + * [`.getDefaultIcon(ext)`](#module_electron-builder/out/platformPackager.PlatformPackager+getDefaultIcon) ⇒ Promise + * [`.dispatchArtifactCreated(file, target, safeArtifactName)`](#module_electron-builder/out/platformPackager.PlatformPackager+dispatchArtifactCreated) + * [`.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern)`](#module_electron-builder/out/platformPackager.PlatformPackager+expandArtifactNamePattern) ⇒ string + * [`.expandMacro(pattern, arch, extra)`](#module_electron-builder/out/platformPackager.PlatformPackager+expandMacro) ⇒ string + * [`.generateName(ext, arch, deployment, classifier)`](#module_electron-builder/out/platformPackager.PlatformPackager+generateName) ⇒ string + * [`.generateName2(ext, classifier, deployment)`](#module_electron-builder/out/platformPackager.PlatformPackager+generateName2) ⇒ string + * [`.getIconPath()`](#module_electron-builder/out/platformPackager.PlatformPackager+getIconPath) ⇒ Promise + * [`.getMacOsResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getMacOsResourcesDir) ⇒ string + * [`.pack(outDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+pack) ⇒ Promise + * [`.getResource(custom, names)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResource) ⇒ Promise + * [`.getResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResourcesDir) ⇒ string + * [`.getTempFile(suffix)`](#module_electron-builder/out/platformPackager.PlatformPackager+getTempFile) ⇒ Promise + * [`.computeAppOutDir(outDir, arch)`](#module_electron-builder/out/platformPackager.PlatformPackager+computeAppOutDir) ⇒ string + * [`.getCscPassword()`](#module_electron-builder/out/platformPackager.PlatformPackager+getCscPassword) ⇒ string + * [`.doGetCscPassword()`](#module_electron-builder/out/platformPackager.PlatformPackager+doGetCscPassword) ⇒ any + * [`.doPack(outDir, appOutDir, platformName, arch, platformSpecificBuildOptions, targets)`](#module_electron-builder/out/platformPackager.PlatformPackager+doPack) ⇒ Promise + * [`.packageInDistributableFormat(appOutDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+packageInDistributableFormat) + * [`.postInitApp(executableFile)`](#module_electron-builder/out/platformPackager.PlatformPackager+postInitApp) ⇒ Promise + * [`.prepareAppInfo(appInfo)`](#module_electron-builder/out/platformPackager.PlatformPackager+prepareAppInfo) ⇒ [AppInfo](#module_electron-builder/out/appInfo.AppInfo) + * [`.normalizeExt(ext)`](#module_electron-builder/out/platformPackager.normalizeExt) ⇒ string + + +- + + + +### electron-builder/out/platformPackager.PlatformPackager +**Kind**: class of [electron-builder/out/platformPackager](#module_electron-builder/out/platformPackager) + +* [.PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) + * [`.createTargets(targets, mapper, cleanupTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+createTargets) + * [`.getDefaultIcon(ext)`](#module_electron-builder/out/platformPackager.PlatformPackager+getDefaultIcon) ⇒ Promise + * [`.dispatchArtifactCreated(file, target, safeArtifactName)`](#module_electron-builder/out/platformPackager.PlatformPackager+dispatchArtifactCreated) + * [`.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern)`](#module_electron-builder/out/platformPackager.PlatformPackager+expandArtifactNamePattern) ⇒ string + * [`.expandMacro(pattern, arch, extra)`](#module_electron-builder/out/platformPackager.PlatformPackager+expandMacro) ⇒ string + * [`.generateName(ext, arch, deployment, classifier)`](#module_electron-builder/out/platformPackager.PlatformPackager+generateName) ⇒ string + * [`.generateName2(ext, classifier, deployment)`](#module_electron-builder/out/platformPackager.PlatformPackager+generateName2) ⇒ string + * [`.getIconPath()`](#module_electron-builder/out/platformPackager.PlatformPackager+getIconPath) ⇒ Promise + * [`.getMacOsResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getMacOsResourcesDir) ⇒ string + * [`.pack(outDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+pack) ⇒ Promise + * [`.getResource(custom, names)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResource) ⇒ Promise + * [`.getResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResourcesDir) ⇒ string + * [`.getTempFile(suffix)`](#module_electron-builder/out/platformPackager.PlatformPackager+getTempFile) ⇒ Promise + * [`.computeAppOutDir(outDir, arch)`](#module_electron-builder/out/platformPackager.PlatformPackager+computeAppOutDir) ⇒ string + * [`.getCscPassword()`](#module_electron-builder/out/platformPackager.PlatformPackager+getCscPassword) ⇒ string + * [`.doGetCscPassword()`](#module_electron-builder/out/platformPackager.PlatformPackager+doGetCscPassword) ⇒ any + * [`.doPack(outDir, appOutDir, platformName, arch, platformSpecificBuildOptions, targets)`](#module_electron-builder/out/platformPackager.PlatformPackager+doPack) ⇒ Promise + * [`.packageInDistributableFormat(appOutDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+packageInDistributableFormat) + * [`.postInitApp(executableFile)`](#module_electron-builder/out/platformPackager.PlatformPackager+postInitApp) ⇒ Promise + * [`.prepareAppInfo(appInfo)`](#module_electron-builder/out/platformPackager.PlatformPackager+prepareAppInfo) ⇒ [AppInfo](#module_electron-builder/out/appInfo.AppInfo) + + +- + + + +#### `platformPackager.createTargets(targets, mapper, cleanupTasks)` +**Kind**: instance method of [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) + +| Param | Type | +| --- | --- | +| targets | Array | +| mapper | callback | +| cleanupTasks | Array | + + +- + + + +#### `platformPackager.getDefaultIcon(ext)` ⇒ Promise +**Kind**: instance method of [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) + +| Param | Type | +| --- | --- | +| ext | string | + + +- + + + +#### `platformPackager.dispatchArtifactCreated(file, target, safeArtifactName)` +**Kind**: instance method of [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) + +| Param | Type | +| --- | --- | +| file | string | +| target | [Target](#module_electron-builder-core.Target) | null | +| safeArtifactName | string | + + +- + + + +#### `platformPackager.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern)` ⇒ string +**Kind**: instance method of [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) + +| Param | Type | +| --- | --- | +| targetSpecificOptions | [TargetSpecificOptions](#module_electron-builder-core.TargetSpecificOptions) | undefined | null | +| ext | string | +| arch | "0" | "1" | "2" | null | +| defaultPattern | string | + + +- + + + +#### `platformPackager.expandMacro(pattern, arch, extra)` ⇒ string +**Kind**: instance method of [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) + +| Param | Type | +| --- | --- | +| pattern | string | +| arch | "0" | "1" | "2" | undefined | null | +| extra | any | + + +- + + + +#### `platformPackager.generateName(ext, arch, deployment, classifier)` ⇒ string +**Kind**: instance method of [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) + +| Param | Type | +| --- | --- | +| ext | string | null | +| arch | "0" | "1" | "2" | +| deployment | boolean | +| classifier | string | null | + + +- + + + +#### `platformPackager.generateName2(ext, classifier, deployment)` ⇒ string +**Kind**: instance method of [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) + +| Param | Type | +| --- | --- | +| ext | string | null | +| classifier | string | undefined | null | +| deployment | boolean | + + +- + + + +#### `platformPackager.getIconPath()` ⇒ Promise +**Kind**: instance method of [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) + +- + + + +#### `platformPackager.getMacOsResourcesDir(appOutDir)` ⇒ string +**Kind**: instance method of [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) + +| Param | Type | +| --- | --- | +| appOutDir | string | + + +- + + + +#### `platformPackager.pack(outDir, arch, targets, postAsyncTasks)` ⇒ Promise +**Kind**: instance method of [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) + +| Param | Type | +| --- | --- | +| outDir | string | +| arch | "0" | "1" | "2" | +| targets | Array | +| postAsyncTasks | Array | + + +- + + + +#### `platformPackager.getResource(custom, names)` ⇒ Promise +**Kind**: instance method of [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) + +| Param | Type | +| --- | --- | +| custom | string | undefined | null | +| names | Array | + + +- + + + +#### `platformPackager.getResourcesDir(appOutDir)` ⇒ string +**Kind**: instance method of [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) + +| Param | Type | +| --- | --- | +| appOutDir | string | + + +- + + + +#### `platformPackager.getTempFile(suffix)` ⇒ Promise +**Kind**: instance method of [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) + +| Param | Type | +| --- | --- | +| suffix | string | + + +- + + + +#### `platformPackager.computeAppOutDir(outDir, arch)` ⇒ string +**Kind**: instance method of [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) +**Access**: protected + +| Param | Type | +| --- | --- | +| outDir | string | +| arch | "0" | "1" | "2" | + + +- + + + +#### `platformPackager.getCscPassword()` ⇒ string +**Kind**: instance method of [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) +**Access**: protected + +- + + + +#### `platformPackager.doGetCscPassword()` ⇒ any +**Kind**: instance method of [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) +**Access**: protected + +- + + + +#### `platformPackager.doPack(outDir, appOutDir, platformName, arch, platformSpecificBuildOptions, targets)` ⇒ Promise +**Kind**: instance method of [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) +**Access**: protected + +| Param | Type | +| --- | --- | +| outDir | string | +| appOutDir | string | +| platformName | string | +| arch | "0" | "1" | "2" | +| platformSpecificBuildOptions | module:electron-builder/out/platformPackager.DC | +| targets | Array | + + +- + + + +#### `platformPackager.packageInDistributableFormat(appOutDir, arch, targets, postAsyncTasks)` +**Kind**: instance method of [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) +**Access**: protected + +| Param | Type | +| --- | --- | +| appOutDir | string | +| arch | "0" | "1" | "2" | +| targets | Array | +| postAsyncTasks | Array | + + +- + + + +#### `platformPackager.postInitApp(executableFile)` ⇒ Promise +**Kind**: instance method of [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) +**Access**: protected + +| Param | Type | +| --- | --- | +| executableFile | string | + + +- + + + +#### `platformPackager.prepareAppInfo(appInfo)` ⇒ [AppInfo](#module_electron-builder/out/appInfo.AppInfo) +**Kind**: instance method of [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) +**Access**: protected + +| Param | Type | +| --- | --- | +| appInfo | [AppInfo](#module_electron-builder/out/appInfo.AppInfo) | + + +- + + + +### `electron-builder/out/platformPackager.normalizeExt(ext)` ⇒ string +**Kind**: method of [electron-builder/out/platformPackager](#module_electron-builder/out/platformPackager) + +| Param | Type | +| --- | --- | +| ext | string | + + +- + + + +## electron-builder/out/publish/PublishManager + +* [electron-builder/out/publish/PublishManager](#module_electron-builder/out/publish/PublishManager) + * [.PublishManager](#module_electron-builder/out/publish/PublishManager.PublishManager) ⇐ [PublishContext](#module_electron-publish.PublishContext) + * [`.awaitTasks()`](#module_electron-builder/out/publish/PublishManager.PublishManager+awaitTasks) ⇒ Promise + * [`.cancelTasks()`](#module_electron-builder/out/publish/PublishManager.PublishManager+cancelTasks) + * [`.getOrCreatePublisher(publishConfig, buildInfo)`](#module_electron-builder/out/publish/PublishManager.PublishManager+getOrCreatePublisher) ⇒ + * [`.computeDownloadUrl(publishConfig, fileName, packager, arch)`](#module_electron-builder/out/publish/PublishManager.computeDownloadUrl) ⇒ string + * [`.createPublisher(context, version, publishConfig, options)`](#module_electron-builder/out/publish/PublishManager.createPublisher) ⇒ + * [`.getPublishConfigs(packager, targetSpecificOptions)`](#module_electron-builder/out/publish/PublishManager.getPublishConfigs) ⇒ Promise + * [`.getPublishConfigsForUpdateInfo(packager, publishConfigs)`](#module_electron-builder/out/publish/PublishManager.getPublishConfigsForUpdateInfo) ⇒ Promise + + +- + + + +### electron-builder/out/publish/PublishManager.PublishManager ⇐ [PublishContext](#module_electron-publish.PublishContext) +**Kind**: class of [electron-builder/out/publish/PublishManager](#module_electron-builder/out/publish/PublishManager) +**Extends**: [PublishContext](#module_electron-publish.PublishContext) + +* [.PublishManager](#module_electron-builder/out/publish/PublishManager.PublishManager) ⇐ [PublishContext](#module_electron-publish.PublishContext) + * [`.awaitTasks()`](#module_electron-builder/out/publish/PublishManager.PublishManager+awaitTasks) ⇒ Promise + * [`.cancelTasks()`](#module_electron-builder/out/publish/PublishManager.PublishManager+cancelTasks) + * [`.getOrCreatePublisher(publishConfig, buildInfo)`](#module_electron-builder/out/publish/PublishManager.PublishManager+getOrCreatePublisher) ⇒ + + +- + + + +#### `publishManager.awaitTasks()` ⇒ Promise +**Kind**: instance method of [PublishManager](#module_electron-builder/out/publish/PublishManager.PublishManager) + +- + + + +#### `publishManager.cancelTasks()` +**Kind**: instance method of [PublishManager](#module_electron-builder/out/publish/PublishManager.PublishManager) + +- + + + +#### `publishManager.getOrCreatePublisher(publishConfig, buildInfo)` ⇒ +**Kind**: instance method of [PublishManager](#module_electron-builder/out/publish/PublishManager.PublishManager) + +| Param | Type | +| --- | --- | +| publishConfig | [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) | +| buildInfo | [BuildInfo](#module_electron-builder.BuildInfo) | + + +- + + + +### `electron-builder/out/publish/PublishManager.computeDownloadUrl(publishConfig, fileName, packager, arch)` ⇒ string +**Kind**: method of [electron-builder/out/publish/PublishManager](#module_electron-builder/out/publish/PublishManager) + +| Param | Type | +| --- | --- | +| publishConfig | [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) | +| fileName | string | null | +| packager | [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) | +| arch | "0" | "1" | "2" | null | + + +- + + + +### `electron-builder/out/publish/PublishManager.createPublisher(context, version, publishConfig, options)` ⇒ +**Kind**: method of [electron-builder/out/publish/PublishManager](#module_electron-builder/out/publish/PublishManager) + +| Param | Type | +| --- | --- | +| context | [PublishContext](#module_electron-publish.PublishContext) | +| version | string | +| publishConfig | [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) | +| options | [PublishOptions](#module_electron-publish.PublishOptions) | + + +- + + + +### `electron-builder/out/publish/PublishManager.getPublishConfigs(packager, targetSpecificOptions)` ⇒ Promise +**Kind**: method of [electron-builder/out/publish/PublishManager](#module_electron-builder/out/publish/PublishManager) + +| Param | Type | +| --- | --- | +| packager | [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) | +| targetSpecificOptions | [PlatformSpecificBuildOptions](#module_electron-builder.PlatformSpecificBuildOptions) | null | undefined | + + +- + + + +### `electron-builder/out/publish/PublishManager.getPublishConfigsForUpdateInfo(packager, publishConfigs)` ⇒ Promise +**Kind**: method of [electron-builder/out/publish/PublishManager](#module_electron-builder/out/publish/PublishManager) + +| Param | Type | +| --- | --- | +| packager | [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) | +| publishConfigs | Array | null | + + +- + + + +## electron-builder/out/publish/publisher + +* [electron-builder/out/publish/publisher](#module_electron-builder/out/publish/publisher) + * [`.getCiTag()`](#module_electron-builder/out/publish/publisher.getCiTag) ⇒ any + * [`.getResolvedPublishConfig(packager, publishConfig, errorIfCannot)`](#module_electron-builder/out/publish/publisher.getResolvedPublishConfig) ⇒ Promise + + +- + + + +### `electron-builder/out/publish/publisher.getCiTag()` ⇒ any +**Kind**: method of [electron-builder/out/publish/publisher](#module_electron-builder/out/publish/publisher) + +- + + + +### `electron-builder/out/publish/publisher.getResolvedPublishConfig(packager, publishConfig, errorIfCannot)` ⇒ Promise +**Kind**: method of [electron-builder/out/publish/publisher](#module_electron-builder/out/publish/publisher) + +| Param | Type | +| --- | --- | +| packager | [BuildInfo](#module_electron-builder.BuildInfo) | +| publishConfig | [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) | +| errorIfCannot | boolean | + + +- + + + +## electron-builder/out/readInstalled + +* [electron-builder/out/readInstalled](#module_electron-builder/out/readInstalled) + * [`.Dependency`](#module_electron-builder/out/readInstalled.Dependency) + * [`.readInstalled(folder)`](#module_electron-builder/out/readInstalled.readInstalled) ⇒ Promise + + +- + + + +### `electron-builder/out/readInstalled.Dependency` +**Kind**: interface of [electron-builder/out/readInstalled](#module_electron-builder/out/readInstalled) +**Properties** + +| Name | Type | +| --- | --- | +| name | string | +| path | string | +| extraneous | boolean | +| optional | boolean | +| dependencies | module:electron-builder/out/readInstalled.__type | + + +- + + + +### `electron-builder/out/readInstalled.readInstalled(folder)` ⇒ Promise +**Kind**: method of [electron-builder/out/readInstalled](#module_electron-builder/out/readInstalled) + +| Param | Type | +| --- | --- | +| folder | string | + + +- + + + +## electron-builder/out/repositoryInfo + +* [electron-builder/out/repositoryInfo](#module_electron-builder/out/repositoryInfo) + * [`.RepositorySlug`](#module_electron-builder/out/repositoryInfo.RepositorySlug) + * [`.getRepositoryInfo(projectDir, metadata, devMetadata)`](#module_electron-builder/out/repositoryInfo.getRepositoryInfo) ⇒ Promise + + +- + + + +### `electron-builder/out/repositoryInfo.RepositorySlug` +**Kind**: interface of [electron-builder/out/repositoryInfo](#module_electron-builder/out/repositoryInfo) +**Properties** + +| Name | Type | +| --- | --- | +| user | string | +| project | string | + + +- + + + +### `electron-builder/out/repositoryInfo.getRepositoryInfo(projectDir, metadata, devMetadata)` ⇒ Promise +**Kind**: method of [electron-builder/out/repositoryInfo](#module_electron-builder/out/repositoryInfo) + +| Param | Type | +| --- | --- | +| projectDir | string | +| metadata | [Metadata](#module_electron-builder.Metadata) | +| devMetadata | [Metadata](#module_electron-builder.Metadata) | + + +- + + + +## electron-builder/out/targets/ArchiveTarget + +* [electron-builder/out/targets/ArchiveTarget](#module_electron-builder/out/targets/ArchiveTarget) + * [.ArchiveTarget](#module_electron-builder/out/targets/ArchiveTarget.ArchiveTarget) ⇐ [Target](#module_electron-builder-core.Target) + * [`.build(appOutDir, arch)`](#module_electron-builder/out/targets/ArchiveTarget.ArchiveTarget+build) ⇒ Promise + * [`.finishBuild()`](#module_electron-builder-core.Target+finishBuild) ⇒ Promise + + +- + + + +### electron-builder/out/targets/ArchiveTarget.ArchiveTarget ⇐ [Target](#module_electron-builder-core.Target) +**Kind**: class of [electron-builder/out/targets/ArchiveTarget](#module_electron-builder/out/targets/ArchiveTarget) +**Extends**: [Target](#module_electron-builder-core.Target) + +* [.ArchiveTarget](#module_electron-builder/out/targets/ArchiveTarget.ArchiveTarget) ⇐ [Target](#module_electron-builder-core.Target) + * [`.build(appOutDir, arch)`](#module_electron-builder/out/targets/ArchiveTarget.ArchiveTarget+build) ⇒ Promise + * [`.finishBuild()`](#module_electron-builder-core.Target+finishBuild) ⇒ Promise + + +- + + + +#### `archiveTarget.build(appOutDir, arch)` ⇒ Promise +**Kind**: instance method of [ArchiveTarget](#module_electron-builder/out/targets/ArchiveTarget.ArchiveTarget) +**Overrides**: [build](#module_electron-builder-core.Target+build) + +| Param | Type | +| --- | --- | +| appOutDir | string | +| arch | "0" | "1" | "2" | + + +- + + + +#### `archiveTarget.finishBuild()` ⇒ Promise +**Kind**: instance method of [ArchiveTarget](#module_electron-builder/out/targets/ArchiveTarget.ArchiveTarget) + +- + + + +## electron-builder/out/targets/LinuxTargetHelper + +* [electron-builder/out/targets/LinuxTargetHelper](#module_electron-builder/out/targets/LinuxTargetHelper) + * [.LinuxTargetHelper](#module_electron-builder/out/targets/LinuxTargetHelper.LinuxTargetHelper) + * [`.computeDesktopEntry(platformSpecificBuildOptions, exec, destination, extra)`](#module_electron-builder/out/targets/LinuxTargetHelper.LinuxTargetHelper+computeDesktopEntry) ⇒ Promise + * [`.getDescription(options)`](#module_electron-builder/out/targets/LinuxTargetHelper.LinuxTargetHelper+getDescription) ⇒ string + + +- + + + +### electron-builder/out/targets/LinuxTargetHelper.LinuxTargetHelper +**Kind**: class of [electron-builder/out/targets/LinuxTargetHelper](#module_electron-builder/out/targets/LinuxTargetHelper) + +* [.LinuxTargetHelper](#module_electron-builder/out/targets/LinuxTargetHelper.LinuxTargetHelper) + * [`.computeDesktopEntry(platformSpecificBuildOptions, exec, destination, extra)`](#module_electron-builder/out/targets/LinuxTargetHelper.LinuxTargetHelper+computeDesktopEntry) ⇒ Promise + * [`.getDescription(options)`](#module_electron-builder/out/targets/LinuxTargetHelper.LinuxTargetHelper+getDescription) ⇒ string + + +- + + + +#### `linuxTargetHelper.computeDesktopEntry(platformSpecificBuildOptions, exec, destination, extra)` ⇒ Promise +**Kind**: instance method of [LinuxTargetHelper](#module_electron-builder/out/targets/LinuxTargetHelper.LinuxTargetHelper) + +| Param | Type | +| --- | --- | +| platformSpecificBuildOptions | [LinuxBuildOptions](#module_electron-builder.LinuxBuildOptions) | +| exec | string | +| destination | string | null | +| extra | module:electron-builder/out/targets/LinuxTargetHelper.__type | + + +- + + + +#### `linuxTargetHelper.getDescription(options)` ⇒ string +**Kind**: instance method of [LinuxTargetHelper](#module_electron-builder/out/targets/LinuxTargetHelper.LinuxTargetHelper) + +| Param | Type | +| --- | --- | +| options | [LinuxBuildOptions](#module_electron-builder.LinuxBuildOptions) | + + +- + + + +## electron-builder/out/targets/WebInstaller + +* [electron-builder/out/targets/WebInstaller](#module_electron-builder/out/targets/WebInstaller) + * [.WebInstallerTarget](#module_electron-builder/out/targets/WebInstaller.WebInstallerTarget) ⇐ module:electron-builder/out/targets/nsis.default + * [`.configureDefines(oneClick, defines)`](#module_electron-builder/out/targets/WebInstaller.WebInstallerTarget+configureDefines) ⇒ Promise + * [`.generateGitHubInstallerName()`](#module_electron-builder/out/targets/WebInstaller.WebInstallerTarget+generateGitHubInstallerName) ⇒ string + + +- + + + +### electron-builder/out/targets/WebInstaller.WebInstallerTarget ⇐ module:electron-builder/out/targets/nsis.default +**Kind**: class of [electron-builder/out/targets/WebInstaller](#module_electron-builder/out/targets/WebInstaller) +**Extends**: module:electron-builder/out/targets/nsis.default + +* [.WebInstallerTarget](#module_electron-builder/out/targets/WebInstaller.WebInstallerTarget) ⇐ module:electron-builder/out/targets/nsis.default + * [`.configureDefines(oneClick, defines)`](#module_electron-builder/out/targets/WebInstaller.WebInstallerTarget+configureDefines) ⇒ Promise + * [`.generateGitHubInstallerName()`](#module_electron-builder/out/targets/WebInstaller.WebInstallerTarget+generateGitHubInstallerName) ⇒ string + + +- + + + +#### `webInstallerTarget.configureDefines(oneClick, defines)` ⇒ Promise +**Kind**: instance method of [WebInstallerTarget](#module_electron-builder/out/targets/WebInstaller.WebInstallerTarget) +**Access**: protected + +| Param | Type | +| --- | --- | +| oneClick | boolean | +| defines | any | + + +- + + + +#### `webInstallerTarget.generateGitHubInstallerName()` ⇒ string +**Kind**: instance method of [WebInstallerTarget](#module_electron-builder/out/targets/WebInstaller.WebInstallerTarget) +**Access**: protected + +- + + + +## electron-builder/out/targets/appImage + +* [electron-builder/out/targets/appImage](#module_electron-builder/out/targets/appImage) + * [.AppImageTarget](#module_electron-builder/out/targets/appImage.AppImageTarget) ⇐ [Target](#module_electron-builder-core.Target) + * [`.build(appOutDir, arch)`](#module_electron-builder/out/targets/appImage.AppImageTarget+build) ⇒ Promise + * [`.finishBuild()`](#module_electron-builder-core.Target+finishBuild) ⇒ Promise + + +- + + + +### electron-builder/out/targets/appImage.AppImageTarget ⇐ [Target](#module_electron-builder-core.Target) +**Kind**: class of [electron-builder/out/targets/appImage](#module_electron-builder/out/targets/appImage) +**Extends**: [Target](#module_electron-builder-core.Target) + +* [.AppImageTarget](#module_electron-builder/out/targets/appImage.AppImageTarget) ⇐ [Target](#module_electron-builder-core.Target) + * [`.build(appOutDir, arch)`](#module_electron-builder/out/targets/appImage.AppImageTarget+build) ⇒ Promise + * [`.finishBuild()`](#module_electron-builder-core.Target+finishBuild) ⇒ Promise + + +- + + + +#### `appImageTarget.build(appOutDir, arch)` ⇒ Promise +**Kind**: instance method of [AppImageTarget](#module_electron-builder/out/targets/appImage.AppImageTarget) +**Overrides**: [build](#module_electron-builder-core.Target+build) + +| Param | Type | +| --- | --- | +| appOutDir | string | +| arch | "0" | "1" | "2" | + + +- + + + +#### `appImageTarget.finishBuild()` ⇒ Promise +**Kind**: instance method of [AppImageTarget](#module_electron-builder/out/targets/appImage.AppImageTarget) + +- + + + +## electron-builder/out/targets/appx + +* [electron-builder/out/targets/appx](#module_electron-builder/out/targets/appx) + * [.AppXTarget](#module_electron-builder/out/targets/appx.AppXTarget) ⇐ [Target](#module_electron-builder-core.Target) + * [`.build(appOutDir, arch)`](#module_electron-builder/out/targets/appx.AppXTarget+build) ⇒ Promise + * [`.finishBuild()`](#module_electron-builder-core.Target+finishBuild) ⇒ Promise + + +- + + + +### electron-builder/out/targets/appx.AppXTarget ⇐ [Target](#module_electron-builder-core.Target) +**Kind**: class of [electron-builder/out/targets/appx](#module_electron-builder/out/targets/appx) +**Extends**: [Target](#module_electron-builder-core.Target) + +* [.AppXTarget](#module_electron-builder/out/targets/appx.AppXTarget) ⇐ [Target](#module_electron-builder-core.Target) + * [`.build(appOutDir, arch)`](#module_electron-builder/out/targets/appx.AppXTarget+build) ⇒ Promise + * [`.finishBuild()`](#module_electron-builder-core.Target+finishBuild) ⇒ Promise + + +- + + + +#### `appXTarget.build(appOutDir, arch)` ⇒ Promise +**Kind**: instance method of [AppXTarget](#module_electron-builder/out/targets/appx.AppXTarget) +**Overrides**: [build](#module_electron-builder-core.Target+build) + +| Param | Type | +| --- | --- | +| appOutDir | string | +| arch | "0" | "1" | "2" | + + +- + + + +#### `appXTarget.finishBuild()` ⇒ Promise +**Kind**: instance method of [AppXTarget](#module_electron-builder/out/targets/appx.AppXTarget) + +- + + + +## electron-builder/out/targets/archive + +* [electron-builder/out/targets/archive](#module_electron-builder/out/targets/archive) + * [`.archive(compression, format, outFile, dirToArchive, withoutDir)`](#module_electron-builder/out/targets/archive.archive) ⇒ Promise + * [`.tar(compression, format, outFile, dirToArchive, isMacApp)`](#module_electron-builder/out/targets/archive.tar) ⇒ Promise + + +- + + + +### `electron-builder/out/targets/archive.archive(compression, format, outFile, dirToArchive, withoutDir)` ⇒ Promise +**Kind**: method of [electron-builder/out/targets/archive](#module_electron-builder/out/targets/archive) + +| Param | Type | +| --- | --- | +| compression | "store" | "normal" | "maximum" | undefined | null | +| format | string | +| outFile | string | +| dirToArchive | string | +| withoutDir | boolean | + + +- + + + +### `electron-builder/out/targets/archive.tar(compression, format, outFile, dirToArchive, isMacApp)` ⇒ Promise +**Kind**: method of [electron-builder/out/targets/archive](#module_electron-builder/out/targets/archive) + +| Param | Type | +| --- | --- | +| compression | "store" | "normal" | "maximum" | undefined | null | +| format | string | +| outFile | string | +| dirToArchive | string | +| isMacApp | boolean | + + +- + + + +## electron-builder/out/targets/dmg + +* [electron-builder/out/targets/dmg](#module_electron-builder/out/targets/dmg) + * [.DmgTarget](#module_electron-builder/out/targets/dmg.DmgTarget) ⇐ [Target](#module_electron-builder-core.Target) + * [`.build(appPath, arch)`](#module_electron-builder/out/targets/dmg.DmgTarget+build) ⇒ Promise + * [`.computeDmgOptions()`](#module_electron-builder/out/targets/dmg.DmgTarget+computeDmgOptions) ⇒ Promise + * [`.computeVolumeName(custom)`](#module_electron-builder/out/targets/dmg.DmgTarget+computeVolumeName) ⇒ string + * [`.finishBuild()`](#module_electron-builder-core.Target+finishBuild) ⇒ Promise + * [`.attachAndExecute(dmgPath, readWrite, task)`](#module_electron-builder/out/targets/dmg.attachAndExecute) ⇒ Promise + + +- + + + +### electron-builder/out/targets/dmg.DmgTarget ⇐ [Target](#module_electron-builder-core.Target) +**Kind**: class of [electron-builder/out/targets/dmg](#module_electron-builder/out/targets/dmg) +**Extends**: [Target](#module_electron-builder-core.Target) + +* [.DmgTarget](#module_electron-builder/out/targets/dmg.DmgTarget) ⇐ [Target](#module_electron-builder-core.Target) + * [`.build(appPath, arch)`](#module_electron-builder/out/targets/dmg.DmgTarget+build) ⇒ Promise + * [`.computeDmgOptions()`](#module_electron-builder/out/targets/dmg.DmgTarget+computeDmgOptions) ⇒ Promise + * [`.computeVolumeName(custom)`](#module_electron-builder/out/targets/dmg.DmgTarget+computeVolumeName) ⇒ string + * [`.finishBuild()`](#module_electron-builder-core.Target+finishBuild) ⇒ Promise + + +- + + + +#### `dmgTarget.build(appPath, arch)` ⇒ Promise +**Kind**: instance method of [DmgTarget](#module_electron-builder/out/targets/dmg.DmgTarget) +**Overrides**: [build](#module_electron-builder-core.Target+build) + +| Param | Type | +| --- | --- | +| appPath | string | +| arch | "0" | "1" | "2" | + + +- + + + +#### `dmgTarget.computeDmgOptions()` ⇒ Promise +**Kind**: instance method of [DmgTarget](#module_electron-builder/out/targets/dmg.DmgTarget) + +- + + + +#### `dmgTarget.computeVolumeName(custom)` ⇒ string +**Kind**: instance method of [DmgTarget](#module_electron-builder/out/targets/dmg.DmgTarget) + +| Param | Type | +| --- | --- | +| custom | string | null | + + +- + + + +#### `dmgTarget.finishBuild()` ⇒ Promise +**Kind**: instance method of [DmgTarget](#module_electron-builder/out/targets/dmg.DmgTarget) + +- + + + +### `electron-builder/out/targets/dmg.attachAndExecute(dmgPath, readWrite, task)` ⇒ Promise +**Kind**: method of [electron-builder/out/targets/dmg](#module_electron-builder/out/targets/dmg) + +| Param | Type | +| --- | --- | +| dmgPath | string | +| readWrite | boolean | +| task | callback | + + +- + + + +## electron-builder/out/targets/fpm + +* [electron-builder/out/targets/fpm](#module_electron-builder/out/targets/fpm) + * [.FpmTarget](#module_electron-builder/out/targets/fpm.FpmTarget) ⇐ [Target](#module_electron-builder-core.Target) + * [`.build(appOutDir, arch)`](#module_electron-builder/out/targets/fpm.FpmTarget+build) ⇒ Promise + * [`.finishBuild()`](#module_electron-builder-core.Target+finishBuild) ⇒ Promise + + +- + + + +### electron-builder/out/targets/fpm.FpmTarget ⇐ [Target](#module_electron-builder-core.Target) +**Kind**: class of [electron-builder/out/targets/fpm](#module_electron-builder/out/targets/fpm) +**Extends**: [Target](#module_electron-builder-core.Target) + +* [.FpmTarget](#module_electron-builder/out/targets/fpm.FpmTarget) ⇐ [Target](#module_electron-builder-core.Target) + * [`.build(appOutDir, arch)`](#module_electron-builder/out/targets/fpm.FpmTarget+build) ⇒ Promise + * [`.finishBuild()`](#module_electron-builder-core.Target+finishBuild) ⇒ Promise + + +- + + + +#### `fpmTarget.build(appOutDir, arch)` ⇒ Promise +**Kind**: instance method of [FpmTarget](#module_electron-builder/out/targets/fpm.FpmTarget) +**Overrides**: [build](#module_electron-builder-core.Target+build) + +| Param | Type | +| --- | --- | +| appOutDir | string | +| arch | "0" | "1" | "2" | + + +- + + + +#### `fpmTarget.finishBuild()` ⇒ Promise +**Kind**: instance method of [FpmTarget](#module_electron-builder/out/targets/fpm.FpmTarget) + +- + + + +## electron-builder/out/targets/nsis + +* [electron-builder/out/targets/nsis](#module_electron-builder/out/targets/nsis) + * [.NsisTarget](#module_electron-builder/out/targets/nsis.NsisTarget) ⇐ [Target](#module_electron-builder-core.Target) + * [`.build(appOutDir, arch)`](#module_electron-builder/out/targets/nsis.NsisTarget+build) ⇒ Promise + * [`.finishBuild()`](#module_electron-builder/out/targets/nsis.NsisTarget+finishBuild) ⇒ Promise + * [`.configureDefines(oneClick, defines)`](#module_electron-builder/out/targets/nsis.NsisTarget+configureDefines) ⇒ Promise + * [`.generateGitHubInstallerName()`](#module_electron-builder/out/targets/nsis.NsisTarget+generateGitHubInstallerName) ⇒ string + + +- + + + +### electron-builder/out/targets/nsis.NsisTarget ⇐ [Target](#module_electron-builder-core.Target) +**Kind**: class of [electron-builder/out/targets/nsis](#module_electron-builder/out/targets/nsis) +**Extends**: [Target](#module_electron-builder-core.Target) + +* [.NsisTarget](#module_electron-builder/out/targets/nsis.NsisTarget) ⇐ [Target](#module_electron-builder-core.Target) + * [`.build(appOutDir, arch)`](#module_electron-builder/out/targets/nsis.NsisTarget+build) ⇒ Promise + * [`.finishBuild()`](#module_electron-builder/out/targets/nsis.NsisTarget+finishBuild) ⇒ Promise + * [`.configureDefines(oneClick, defines)`](#module_electron-builder/out/targets/nsis.NsisTarget+configureDefines) ⇒ Promise + * [`.generateGitHubInstallerName()`](#module_electron-builder/out/targets/nsis.NsisTarget+generateGitHubInstallerName) ⇒ string + + +- + + + +#### `nsisTarget.build(appOutDir, arch)` ⇒ Promise +**Kind**: instance method of [NsisTarget](#module_electron-builder/out/targets/nsis.NsisTarget) +**Overrides**: [build](#module_electron-builder-core.Target+build) + +| Param | Type | +| --- | --- | +| appOutDir | string | +| arch | "0" | "1" | "2" | + + +- + + + +#### `nsisTarget.finishBuild()` ⇒ Promise +**Kind**: instance method of [NsisTarget](#module_electron-builder/out/targets/nsis.NsisTarget) +**Overrides**: [finishBuild](#module_electron-builder-core.Target+finishBuild) + +- + + + +#### `nsisTarget.configureDefines(oneClick, defines)` ⇒ Promise +**Kind**: instance method of [NsisTarget](#module_electron-builder/out/targets/nsis.NsisTarget) +**Access**: protected + +| Param | Type | +| --- | --- | +| oneClick | boolean | +| defines | any | + + +- + + + +#### `nsisTarget.generateGitHubInstallerName()` ⇒ string +**Kind**: instance method of [NsisTarget](#module_electron-builder/out/targets/nsis.NsisTarget) +**Access**: protected + +- + + + +## electron-builder/out/targets/pkg + +* [electron-builder/out/targets/pkg](#module_electron-builder/out/targets/pkg) + * [.PkgTarget](#module_electron-builder/out/targets/pkg.PkgTarget) ⇐ [Target](#module_electron-builder-core.Target) + * [`.build(appPath, arch)`](#module_electron-builder/out/targets/pkg.PkgTarget+build) ⇒ Promise + * [`.finishBuild()`](#module_electron-builder-core.Target+finishBuild) ⇒ Promise + * [`.prepareProductBuildArgs(identity, keychain)`](#module_electron-builder/out/targets/pkg.prepareProductBuildArgs) ⇒ Array + + +- + + + +### electron-builder/out/targets/pkg.PkgTarget ⇐ [Target](#module_electron-builder-core.Target) +**Kind**: class of [electron-builder/out/targets/pkg](#module_electron-builder/out/targets/pkg) +**Extends**: [Target](#module_electron-builder-core.Target) + +* [.PkgTarget](#module_electron-builder/out/targets/pkg.PkgTarget) ⇐ [Target](#module_electron-builder-core.Target) + * [`.build(appPath, arch)`](#module_electron-builder/out/targets/pkg.PkgTarget+build) ⇒ Promise + * [`.finishBuild()`](#module_electron-builder-core.Target+finishBuild) ⇒ Promise + + +- + + + +#### `pkgTarget.build(appPath, arch)` ⇒ Promise +**Kind**: instance method of [PkgTarget](#module_electron-builder/out/targets/pkg.PkgTarget) +**Overrides**: [build](#module_electron-builder-core.Target+build) + +| Param | Type | +| --- | --- | +| appPath | string | +| arch | "0" | "1" | "2" | + + +- + + + +#### `pkgTarget.finishBuild()` ⇒ Promise +**Kind**: instance method of [PkgTarget](#module_electron-builder/out/targets/pkg.PkgTarget) + +- + + + +### `electron-builder/out/targets/pkg.prepareProductBuildArgs(identity, keychain)` ⇒ Array +**Kind**: method of [electron-builder/out/targets/pkg](#module_electron-builder/out/targets/pkg) + +| Param | Type | +| --- | --- | +| identity | string | undefined | null | +| keychain | string | undefined | null | + + +- + + + +## electron-builder/out/targets/snap + +* [electron-builder/out/targets/snap](#module_electron-builder/out/targets/snap) + * [.SnapTarget](#module_electron-builder/out/targets/snap.SnapTarget) ⇐ [Target](#module_electron-builder-core.Target) + * [`.build(appOutDir, arch)`](#module_electron-builder/out/targets/snap.SnapTarget+build) ⇒ Promise + * [`.finishBuild()`](#module_electron-builder-core.Target+finishBuild) ⇒ Promise + + +- + + + +### electron-builder/out/targets/snap.SnapTarget ⇐ [Target](#module_electron-builder-core.Target) +**Kind**: class of [electron-builder/out/targets/snap](#module_electron-builder/out/targets/snap) +**Extends**: [Target](#module_electron-builder-core.Target) + +* [.SnapTarget](#module_electron-builder/out/targets/snap.SnapTarget) ⇐ [Target](#module_electron-builder-core.Target) + * [`.build(appOutDir, arch)`](#module_electron-builder/out/targets/snap.SnapTarget+build) ⇒ Promise + * [`.finishBuild()`](#module_electron-builder-core.Target+finishBuild) ⇒ Promise + + +- + + + +#### `snapTarget.build(appOutDir, arch)` ⇒ Promise +**Kind**: instance method of [SnapTarget](#module_electron-builder/out/targets/snap.SnapTarget) +**Overrides**: [build](#module_electron-builder-core.Target+build) + +| Param | Type | +| --- | --- | +| appOutDir | string | +| arch | "0" | "1" | "2" | + + +- + + + +#### `snapTarget.finishBuild()` ⇒ Promise +**Kind**: instance method of [SnapTarget](#module_electron-builder/out/targets/snap.SnapTarget) + +- + + + +## electron-builder/out/targets/targetFactory + +* [electron-builder/out/targets/targetFactory](#module_electron-builder/out/targets/targetFactory) + * [.NoOpTarget](#module_electron-builder/out/targets/targetFactory.NoOpTarget) ⇐ [Target](#module_electron-builder-core.Target) + * [`.build(appOutDir, arch)`](#module_electron-builder/out/targets/targetFactory.NoOpTarget+build) ⇒ Promise + * [`.finishBuild()`](#module_electron-builder-core.Target+finishBuild) ⇒ Promise + * [`.computeArchToTargetNamesMap(raw, options, platform)`](#module_electron-builder/out/targets/targetFactory.computeArchToTargetNamesMap) ⇒ Map + * [`.createCommonTarget(target, outDir, packager)`](#module_electron-builder/out/targets/targetFactory.createCommonTarget) ⇒ [Target](#module_electron-builder-core.Target) + * [`.createTargets(nameToTarget, rawList, outDir, packager, cleanupTasks)`](#module_electron-builder/out/targets/targetFactory.createTargets) ⇒ Array + + +- + + + +### electron-builder/out/targets/targetFactory.NoOpTarget ⇐ [Target](#module_electron-builder-core.Target) +**Kind**: class of [electron-builder/out/targets/targetFactory](#module_electron-builder/out/targets/targetFactory) +**Extends**: [Target](#module_electron-builder-core.Target) + +* [.NoOpTarget](#module_electron-builder/out/targets/targetFactory.NoOpTarget) ⇐ [Target](#module_electron-builder-core.Target) + * [`.build(appOutDir, arch)`](#module_electron-builder/out/targets/targetFactory.NoOpTarget+build) ⇒ Promise + * [`.finishBuild()`](#module_electron-builder-core.Target+finishBuild) ⇒ Promise + + +- + + + +#### `noOpTarget.build(appOutDir, arch)` ⇒ Promise +**Kind**: instance method of [NoOpTarget](#module_electron-builder/out/targets/targetFactory.NoOpTarget) +**Overrides**: [build](#module_electron-builder-core.Target+build) + +| Param | Type | +| --- | --- | +| appOutDir | string | +| arch | "0" | "1" | "2" | + + +- + + + +#### `noOpTarget.finishBuild()` ⇒ Promise +**Kind**: instance method of [NoOpTarget](#module_electron-builder/out/targets/targetFactory.NoOpTarget) + +- + + + +### `electron-builder/out/targets/targetFactory.computeArchToTargetNamesMap(raw, options, platform)` ⇒ Map +**Kind**: method of [electron-builder/out/targets/targetFactory](#module_electron-builder/out/targets/targetFactory) + +| Param | Type | +| --- | --- | +| raw | Map | +| options | [PlatformSpecificBuildOptions](#module_electron-builder.PlatformSpecificBuildOptions) | +| platform | [Platform](#module_electron-builder-core.Platform) | + + +- + + + +### `electron-builder/out/targets/targetFactory.createCommonTarget(target, outDir, packager)` ⇒ [Target](#module_electron-builder-core.Target) +**Kind**: method of [electron-builder/out/targets/targetFactory](#module_electron-builder/out/targets/targetFactory) + +| Param | Type | +| --- | --- | +| target | string | +| outDir | string | +| packager | [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) | + + +- + + + +### `electron-builder/out/targets/targetFactory.createTargets(nameToTarget, rawList, outDir, packager, cleanupTasks)` ⇒ Array +**Kind**: method of [electron-builder/out/targets/targetFactory](#module_electron-builder/out/targets/targetFactory) + +| Param | Type | +| --- | --- | +| nameToTarget | Map | +| rawList | Array | +| outDir | string | +| packager | [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) | +| cleanupTasks | Array | + + +- + + + +## electron-builder/out/util/filter + +* [electron-builder/out/util/filter](#module_electron-builder/out/util/filter) + * [`.createFilter(src, patterns, ignoreFiles, rawFilter, excludePatterns)`](#module_electron-builder/out/util/filter.createFilter) ⇒ module:electron-builder-util/out/fs.__type + * [`.hasMagic(pattern)`](#module_electron-builder/out/util/filter.hasMagic) ⇒ boolean + + +- + + + +### `electron-builder/out/util/filter.createFilter(src, patterns, ignoreFiles, rawFilter, excludePatterns)` ⇒ module:electron-builder-util/out/fs.__type +**Kind**: method of [electron-builder/out/util/filter](#module_electron-builder/out/util/filter) + +| Param | Type | +| --- | --- | +| src | string | +| patterns | Array | +| ignoreFiles | Set | +| rawFilter | callback | +| excludePatterns | Array | null | + + +- + + + +### `electron-builder/out/util/filter.hasMagic(pattern)` ⇒ boolean +**Kind**: method of [electron-builder/out/util/filter](#module_electron-builder/out/util/filter) + +| Param | Type | +| --- | --- | +| pattern | minimatch:Minimatch | + + +- + + + +## electron-builder/out/util/readPackageJson + +* [electron-builder/out/util/readPackageJson](#module_electron-builder/out/util/readPackageJson) + * [`.doLoadConfig(configFile, projectDir)`](#module_electron-builder/out/util/readPackageJson.doLoadConfig) ⇒ Promise + * [`.getElectronVersion(config, projectDir, projectMetadata)`](#module_electron-builder/out/util/readPackageJson.getElectronVersion) ⇒ Promise + * [`.loadConfig(projectDir)`](#module_electron-builder/out/util/readPackageJson.loadConfig) ⇒ Promise + * [`.readPackageJson(file)`](#module_electron-builder/out/util/readPackageJson.readPackageJson) ⇒ Promise + * [`.validateConfig(config)`](#module_electron-builder/out/util/readPackageJson.validateConfig) ⇒ Promise + + +- + + + +### `electron-builder/out/util/readPackageJson.doLoadConfig(configFile, projectDir)` ⇒ Promise +**Kind**: method of [electron-builder/out/util/readPackageJson](#module_electron-builder/out/util/readPackageJson) + +| Param | Type | +| --- | --- | +| configFile | string | +| projectDir | string | + + +- + + + +### `electron-builder/out/util/readPackageJson.getElectronVersion(config, projectDir, projectMetadata)` ⇒ Promise +**Kind**: method of [electron-builder/out/util/readPackageJson](#module_electron-builder/out/util/readPackageJson) + +| Param | Type | +| --- | --- | +| config | [Config](#module_electron-builder.Config) | null | undefined | +| projectDir | string | +| projectMetadata | any | null | + + +- + + + +### `electron-builder/out/util/readPackageJson.loadConfig(projectDir)` ⇒ Promise +**Kind**: method of [electron-builder/out/util/readPackageJson](#module_electron-builder/out/util/readPackageJson) + +| Param | Type | +| --- | --- | +| projectDir | string | + + +- + + + +### `electron-builder/out/util/readPackageJson.readPackageJson(file)` ⇒ Promise +**Kind**: method of [electron-builder/out/util/readPackageJson](#module_electron-builder/out/util/readPackageJson) + +| Param | Type | +| --- | --- | +| file | string | + + +- + + + +### `electron-builder/out/util/readPackageJson.validateConfig(config)` ⇒ Promise +**Kind**: method of [electron-builder/out/util/readPackageJson](#module_electron-builder/out/util/readPackageJson) + +| Param | Type | +| --- | --- | +| config | [Config](#module_electron-builder.Config) | + + +- + + + +## electron-builder/out/winPackager + +* [electron-builder/out/winPackager](#module_electron-builder/out/winPackager) + * [.WinPackager](#module_electron-builder/out/winPackager.WinPackager) ⇐ [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) + * [`.createTargets(targets, mapper, cleanupTasks)`](#module_electron-builder/out/winPackager.WinPackager+createTargets) + * [`.getIconPath()`](#module_electron-builder/out/winPackager.WinPackager+getIconPath) ⇒ Promise + * [`.sign(file, logMessagePrefix)`](#module_electron-builder/out/winPackager.WinPackager+sign) ⇒ Promise + * [`.signAndEditResources(file)`](#module_electron-builder/out/winPackager.WinPackager+signAndEditResources) ⇒ Promise + * [`.doGetCscPassword()`](#module_electron-builder/out/winPackager.WinPackager+doGetCscPassword) ⇒ string + * [`.doSign(options)`](#module_electron-builder/out/winPackager.WinPackager+doSign) ⇒ Promise + * [`.postInitApp(appOutDir)`](#module_electron-builder/out/winPackager.WinPackager+postInitApp) ⇒ Promise + * [`.getDefaultIcon(ext)`](#module_electron-builder/out/platformPackager.PlatformPackager+getDefaultIcon) ⇒ Promise + * [`.dispatchArtifactCreated(file, target, safeArtifactName)`](#module_electron-builder/out/platformPackager.PlatformPackager+dispatchArtifactCreated) + * [`.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern)`](#module_electron-builder/out/platformPackager.PlatformPackager+expandArtifactNamePattern) ⇒ string + * [`.expandMacro(pattern, arch, extra)`](#module_electron-builder/out/platformPackager.PlatformPackager+expandMacro) ⇒ string + * [`.generateName(ext, arch, deployment, classifier)`](#module_electron-builder/out/platformPackager.PlatformPackager+generateName) ⇒ string + * [`.generateName2(ext, classifier, deployment)`](#module_electron-builder/out/platformPackager.PlatformPackager+generateName2) ⇒ string + * [`.getMacOsResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getMacOsResourcesDir) ⇒ string + * [`.pack(outDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+pack) ⇒ Promise + * [`.getResource(custom, names)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResource) ⇒ Promise + * [`.getResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResourcesDir) ⇒ string + * [`.getTempFile(suffix)`](#module_electron-builder/out/platformPackager.PlatformPackager+getTempFile) ⇒ Promise + * [`.computeAppOutDir(outDir, arch)`](#module_electron-builder/out/platformPackager.PlatformPackager+computeAppOutDir) ⇒ string + * [`.getCscPassword()`](#module_electron-builder/out/platformPackager.PlatformPackager+getCscPassword) ⇒ string + * [`.doPack(outDir, appOutDir, platformName, arch, platformSpecificBuildOptions, targets)`](#module_electron-builder/out/platformPackager.PlatformPackager+doPack) ⇒ Promise + * [`.packageInDistributableFormat(appOutDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+packageInDistributableFormat) + * [`.prepareAppInfo(appInfo)`](#module_electron-builder/out/platformPackager.PlatformPackager+prepareAppInfo) ⇒ [AppInfo](#module_electron-builder/out/appInfo.AppInfo) + + +- + + + +### electron-builder/out/winPackager.WinPackager ⇐ [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) +**Kind**: class of [electron-builder/out/winPackager](#module_electron-builder/out/winPackager) +**Extends**: [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) + +* [.WinPackager](#module_electron-builder/out/winPackager.WinPackager) ⇐ [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) + * [`.createTargets(targets, mapper, cleanupTasks)`](#module_electron-builder/out/winPackager.WinPackager+createTargets) + * [`.getIconPath()`](#module_electron-builder/out/winPackager.WinPackager+getIconPath) ⇒ Promise + * [`.sign(file, logMessagePrefix)`](#module_electron-builder/out/winPackager.WinPackager+sign) ⇒ Promise + * [`.signAndEditResources(file)`](#module_electron-builder/out/winPackager.WinPackager+signAndEditResources) ⇒ Promise + * [`.doGetCscPassword()`](#module_electron-builder/out/winPackager.WinPackager+doGetCscPassword) ⇒ string + * [`.doSign(options)`](#module_electron-builder/out/winPackager.WinPackager+doSign) ⇒ Promise + * [`.postInitApp(appOutDir)`](#module_electron-builder/out/winPackager.WinPackager+postInitApp) ⇒ Promise + * [`.getDefaultIcon(ext)`](#module_electron-builder/out/platformPackager.PlatformPackager+getDefaultIcon) ⇒ Promise + * [`.dispatchArtifactCreated(file, target, safeArtifactName)`](#module_electron-builder/out/platformPackager.PlatformPackager+dispatchArtifactCreated) + * [`.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern)`](#module_electron-builder/out/platformPackager.PlatformPackager+expandArtifactNamePattern) ⇒ string + * [`.expandMacro(pattern, arch, extra)`](#module_electron-builder/out/platformPackager.PlatformPackager+expandMacro) ⇒ string + * [`.generateName(ext, arch, deployment, classifier)`](#module_electron-builder/out/platformPackager.PlatformPackager+generateName) ⇒ string + * [`.generateName2(ext, classifier, deployment)`](#module_electron-builder/out/platformPackager.PlatformPackager+generateName2) ⇒ string + * [`.getMacOsResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getMacOsResourcesDir) ⇒ string + * [`.pack(outDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+pack) ⇒ Promise + * [`.getResource(custom, names)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResource) ⇒ Promise + * [`.getResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResourcesDir) ⇒ string + * [`.getTempFile(suffix)`](#module_electron-builder/out/platformPackager.PlatformPackager+getTempFile) ⇒ Promise + * [`.computeAppOutDir(outDir, arch)`](#module_electron-builder/out/platformPackager.PlatformPackager+computeAppOutDir) ⇒ string + * [`.getCscPassword()`](#module_electron-builder/out/platformPackager.PlatformPackager+getCscPassword) ⇒ string + * [`.doPack(outDir, appOutDir, platformName, arch, platformSpecificBuildOptions, targets)`](#module_electron-builder/out/platformPackager.PlatformPackager+doPack) ⇒ Promise + * [`.packageInDistributableFormat(appOutDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+packageInDistributableFormat) + * [`.prepareAppInfo(appInfo)`](#module_electron-builder/out/platformPackager.PlatformPackager+prepareAppInfo) ⇒ [AppInfo](#module_electron-builder/out/appInfo.AppInfo) + + +- + + + +#### `winPackager.createTargets(targets, mapper, cleanupTasks)` +**Kind**: instance method of [WinPackager](#module_electron-builder/out/winPackager.WinPackager) +**Overrides**: [createTargets](#module_electron-builder/out/platformPackager.PlatformPackager+createTargets) + +| Param | Type | +| --- | --- | +| targets | Array | +| mapper | callback | +| cleanupTasks | Array | + + +- + + + +#### `winPackager.getIconPath()` ⇒ Promise +**Kind**: instance method of [WinPackager](#module_electron-builder/out/winPackager.WinPackager) +**Overrides**: [getIconPath](#module_electron-builder/out/platformPackager.PlatformPackager+getIconPath) + +- + + + +#### `winPackager.sign(file, logMessagePrefix)` ⇒ Promise +**Kind**: instance method of [WinPackager](#module_electron-builder/out/winPackager.WinPackager) + +| Param | Type | +| --- | --- | +| file | string | +| logMessagePrefix | string | + + +- + + + +#### `winPackager.signAndEditResources(file)` ⇒ Promise +**Kind**: instance method of [WinPackager](#module_electron-builder/out/winPackager.WinPackager) + +| Param | Type | +| --- | --- | +| file | string | + + +- + + + +#### `winPackager.doGetCscPassword()` ⇒ string +**Kind**: instance method of [WinPackager](#module_electron-builder/out/winPackager.WinPackager) +**Overrides**: [doGetCscPassword](#module_electron-builder/out/platformPackager.PlatformPackager+doGetCscPassword) +**Access**: protected + +- + + + +#### `winPackager.doSign(options)` ⇒ Promise +**Kind**: instance method of [WinPackager](#module_electron-builder/out/winPackager.WinPackager) +**Access**: protected + +| Param | Type | +| --- | --- | +| options | [SignOptions](#module_electron-builder/out/windowsCodeSign.SignOptions) | + + +- + + + +#### `winPackager.postInitApp(appOutDir)` ⇒ Promise +**Kind**: instance method of [WinPackager](#module_electron-builder/out/winPackager.WinPackager) +**Overrides**: [postInitApp](#module_electron-builder/out/platformPackager.PlatformPackager+postInitApp) +**Access**: protected + +| Param | Type | +| --- | --- | +| appOutDir | string | + + +- + + + +#### `winPackager.getDefaultIcon(ext)` ⇒ Promise +**Kind**: instance method of [WinPackager](#module_electron-builder/out/winPackager.WinPackager) + +| Param | Type | +| --- | --- | +| ext | string | + + +- + + + +#### `winPackager.dispatchArtifactCreated(file, target, safeArtifactName)` +**Kind**: instance method of [WinPackager](#module_electron-builder/out/winPackager.WinPackager) + +| Param | Type | +| --- | --- | +| file | string | +| target | [Target](#module_electron-builder-core.Target) | null | +| safeArtifactName | string | + + +- + + + +#### `winPackager.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern)` ⇒ string +**Kind**: instance method of [WinPackager](#module_electron-builder/out/winPackager.WinPackager) + +| Param | Type | +| --- | --- | +| targetSpecificOptions | [TargetSpecificOptions](#module_electron-builder-core.TargetSpecificOptions) | undefined | null | +| ext | string | +| arch | "0" | "1" | "2" | null | +| defaultPattern | string | + + +- + + + +#### `winPackager.expandMacro(pattern, arch, extra)` ⇒ string +**Kind**: instance method of [WinPackager](#module_electron-builder/out/winPackager.WinPackager) + +| Param | Type | +| --- | --- | +| pattern | string | +| arch | "0" | "1" | "2" | undefined | null | +| extra | any | + + +- + + + +#### `winPackager.generateName(ext, arch, deployment, classifier)` ⇒ string +**Kind**: instance method of [WinPackager](#module_electron-builder/out/winPackager.WinPackager) + +| Param | Type | +| --- | --- | +| ext | string | null | +| arch | "0" | "1" | "2" | +| deployment | boolean | +| classifier | string | null | + + +- + + + +#### `winPackager.generateName2(ext, classifier, deployment)` ⇒ string +**Kind**: instance method of [WinPackager](#module_electron-builder/out/winPackager.WinPackager) + +| Param | Type | +| --- | --- | +| ext | string | null | +| classifier | string | undefined | null | +| deployment | boolean | + + +- + + + +#### `winPackager.getMacOsResourcesDir(appOutDir)` ⇒ string +**Kind**: instance method of [WinPackager](#module_electron-builder/out/winPackager.WinPackager) + +| Param | Type | +| --- | --- | +| appOutDir | string | + + +- + + + +#### `winPackager.pack(outDir, arch, targets, postAsyncTasks)` ⇒ Promise +**Kind**: instance method of [WinPackager](#module_electron-builder/out/winPackager.WinPackager) + +| Param | Type | +| --- | --- | +| outDir | string | +| arch | "0" | "1" | "2" | +| targets | Array | +| postAsyncTasks | Array | + + +- + + + +#### `winPackager.getResource(custom, names)` ⇒ Promise +**Kind**: instance method of [WinPackager](#module_electron-builder/out/winPackager.WinPackager) + +| Param | Type | +| --- | --- | +| custom | string | undefined | null | +| names | Array | + + +- + + + +#### `winPackager.getResourcesDir(appOutDir)` ⇒ string +**Kind**: instance method of [WinPackager](#module_electron-builder/out/winPackager.WinPackager) + +| Param | Type | +| --- | --- | +| appOutDir | string | + + +- + + + +#### `winPackager.getTempFile(suffix)` ⇒ Promise +**Kind**: instance method of [WinPackager](#module_electron-builder/out/winPackager.WinPackager) + +| Param | Type | +| --- | --- | +| suffix | string | + + +- + + + +#### `winPackager.computeAppOutDir(outDir, arch)` ⇒ string +**Kind**: instance method of [WinPackager](#module_electron-builder/out/winPackager.WinPackager) +**Access**: protected + +| Param | Type | +| --- | --- | +| outDir | string | +| arch | "0" | "1" | "2" | + + +- + + + +#### `winPackager.getCscPassword()` ⇒ string +**Kind**: instance method of [WinPackager](#module_electron-builder/out/winPackager.WinPackager) +**Access**: protected + +- + + + +#### `winPackager.doPack(outDir, appOutDir, platformName, arch, platformSpecificBuildOptions, targets)` ⇒ Promise +**Kind**: instance method of [WinPackager](#module_electron-builder/out/winPackager.WinPackager) +**Access**: protected + +| Param | Type | +| --- | --- | +| outDir | string | +| appOutDir | string | +| platformName | string | +| arch | "0" | "1" | "2" | +| platformSpecificBuildOptions | module:electron-builder/out/platformPackager.DC | +| targets | Array | + + +- + + + +#### `winPackager.packageInDistributableFormat(appOutDir, arch, targets, postAsyncTasks)` +**Kind**: instance method of [WinPackager](#module_electron-builder/out/winPackager.WinPackager) +**Access**: protected + +| Param | Type | +| --- | --- | +| appOutDir | string | +| arch | "0" | "1" | "2" | +| targets | Array | +| postAsyncTasks | Array | + + +- + + + +#### `winPackager.prepareAppInfo(appInfo)` ⇒ [AppInfo](#module_electron-builder/out/appInfo.AppInfo) +**Kind**: instance method of [WinPackager](#module_electron-builder/out/winPackager.WinPackager) +**Access**: protected + +| Param | Type | +| --- | --- | +| appInfo | [AppInfo](#module_electron-builder/out/appInfo.AppInfo) | + + +- + + + +## electron-builder/out/windowsCodeSign + +* [electron-builder/out/windowsCodeSign](#module_electron-builder/out/windowsCodeSign) + * [`.FileCodeSigningInfo`](#module_electron-builder/out/windowsCodeSign.FileCodeSigningInfo) + * [`.SignOptions`](#module_electron-builder/out/windowsCodeSign.SignOptions) + * [`.getSignVendorPath()`](#module_electron-builder/out/windowsCodeSign.getSignVendorPath) ⇒ Promise + * [`.getToolPath()`](#module_electron-builder/out/windowsCodeSign.getToolPath) ⇒ Promise + * [`.sign(options)`](#module_electron-builder/out/windowsCodeSign.sign) ⇒ Promise + + +- + + + +### `electron-builder/out/windowsCodeSign.FileCodeSigningInfo` +**Kind**: interface of [electron-builder/out/windowsCodeSign](#module_electron-builder/out/windowsCodeSign) +**Properties** + +| Name | Type | +| --- | --- | +| file | string | null | +| password | string | null | +| subjectName | string | null | +| certificateSha1 | string | null | + + +- + + + +### `electron-builder/out/windowsCodeSign.SignOptions` +**Kind**: interface of [electron-builder/out/windowsCodeSign](#module_electron-builder/out/windowsCodeSign) +**Properties** + +| Name | Type | +| --- | --- | +| path | string | +| cert | string | null | +| name | string | null | +| password | string | null | +| site | string | null | +| options | [WinBuildOptions](#module_electron-builder.WinBuildOptions) | + + +- + + + +### `electron-builder/out/windowsCodeSign.getSignVendorPath()` ⇒ Promise +**Kind**: method of [electron-builder/out/windowsCodeSign](#module_electron-builder/out/windowsCodeSign) + +- + + + +### `electron-builder/out/windowsCodeSign.getToolPath()` ⇒ Promise +**Kind**: method of [electron-builder/out/windowsCodeSign](#module_electron-builder/out/windowsCodeSign) + +- + + + +### `electron-builder/out/windowsCodeSign.sign(options)` ⇒ Promise +**Kind**: method of [electron-builder/out/windowsCodeSign](#module_electron-builder/out/windowsCodeSign) + +| Param | Type | +| --- | --- | +| options | [SignOptions](#module_electron-builder/out/windowsCodeSign.SignOptions) | + + +- + + + +## electron-builder/out/yarn + +* [electron-builder/out/yarn](#module_electron-builder/out/yarn) + * [`.getGypEnv(electronVersion, platform, arch, buildFromSource)`](#module_electron-builder/out/yarn.getGypEnv) ⇒ any + * [`.installOrRebuild(config, appDir, electronVersion, platform, arch, forceInstall)`](#module_electron-builder/out/yarn.installOrRebuild) ⇒ Promise + * [`.rebuild(appDir, electronVersion, platform, arch, additionalArgs, buildFromSource)`](#module_electron-builder/out/yarn.rebuild) ⇒ Promise + + +- + + + +### `electron-builder/out/yarn.getGypEnv(electronVersion, platform, arch, buildFromSource)` ⇒ any +**Kind**: method of [electron-builder/out/yarn](#module_electron-builder/out/yarn) + +| Param | Type | +| --- | --- | +| electronVersion | string | +| platform | string | +| arch | string | +| buildFromSource | boolean | + + +- + + + +### `electron-builder/out/yarn.installOrRebuild(config, appDir, electronVersion, platform, arch, forceInstall)` ⇒ Promise +**Kind**: method of [electron-builder/out/yarn](#module_electron-builder/out/yarn) + +| Param | Type | +| --- | --- | +| config | [Config](#module_electron-builder.Config) | +| appDir | string | +| electronVersion | string | +| platform | string | +| arch | string | +| forceInstall | boolean | + + +- + + + +### `electron-builder/out/yarn.rebuild(appDir, electronVersion, platform, arch, additionalArgs, buildFromSource)` ⇒ Promise +**Kind**: method of [electron-builder/out/yarn](#module_electron-builder/out/yarn) + +| Param | Type | +| --- | --- | +| appDir | string | +| electronVersion | string | +| platform | string | +| arch | string | +| additionalArgs | Array | +| buildFromSource | boolean | + + +- + + + +## electron-builder + +* [electron-builder](#module_electron-builder) + * [`.AfterPackContext`](#module_electron-builder.AfterPackContext) + * [`.AppImageOptions`](#module_electron-builder.AppImageOptions) ⇐ [LinuxBuildOptions](#module_electron-builder.LinuxBuildOptions) + * [`.AppXOptions`](#module_electron-builder.AppXOptions) + * [`.ArtifactCreated`](#module_electron-builder.ArtifactCreated) + * [`.BuildInfo`](#module_electron-builder.BuildInfo) + * [`.BuildOptions`](#module_electron-builder.BuildOptions) ⇐ [PublishOptions](#module_electron-publish.PublishOptions) + * [`.BuildResult`](#module_electron-builder.BuildResult) + * [`.CliOptions`](#module_electron-builder.CliOptions) ⇐ [PublishOptions](#module_electron-publish.PublishOptions) + * ~~[`.Config`](#module_electron-builder.Config) ⇐ [TargetSpecificOptions](#module_electron-builder-core.TargetSpecificOptions)~~ + * [`.DebOptions`](#module_electron-builder.DebOptions) ⇐ [LinuxBuildOptions](#module_electron-builder.LinuxBuildOptions) + * [`.DmgContent`](#module_electron-builder.DmgContent) + * [`.DmgOptions`](#module_electron-builder.DmgOptions) ⇐ [TargetSpecificOptions](#module_electron-builder-core.TargetSpecificOptions) + * [`.DmgWindow`](#module_electron-builder.DmgWindow) + * [`.FileAssociation`](#module_electron-builder.FileAssociation) + * [`.LinuxBuildOptions`](#module_electron-builder.LinuxBuildOptions) ⇐ [PlatformSpecificBuildOptions](#module_electron-builder.PlatformSpecificBuildOptions) + * [`.MacOptions`](#module_electron-builder.MacOptions) ⇐ [PlatformSpecificBuildOptions](#module_electron-builder.PlatformSpecificBuildOptions) + * [`.MasBuildOptions`](#module_electron-builder.MasBuildOptions) ⇐ [MacOptions](#module_electron-builder.MacOptions) + * [`.Metadata`](#module_electron-builder.Metadata) + * [`.MetadataDirectories`](#module_electron-builder.MetadataDirectories) + * [`.NsisOptions`](#module_electron-builder.NsisOptions) + * [`.NsisWebOptions`](#module_electron-builder.NsisWebOptions) ⇐ [NsisOptions](#module_electron-builder.NsisOptions) + * ~~[`.PackagerOptions`](#module_electron-builder.PackagerOptions)~~ + * [`.PkgOptions`](#module_electron-builder.PkgOptions) ⇐ [TargetSpecificOptions](#module_electron-builder-core.TargetSpecificOptions) + * [`.PlatformSpecificBuildOptions`](#module_electron-builder.PlatformSpecificBuildOptions) ⇐ [TargetSpecificOptions](#module_electron-builder-core.TargetSpecificOptions) + * [`.Protocol`](#module_electron-builder.Protocol) + * [`.SnapOptions`](#module_electron-builder.SnapOptions) ⇐ [LinuxBuildOptions](#module_electron-builder.LinuxBuildOptions) + * [`.SourceRepositoryInfo`](#module_electron-builder.SourceRepositoryInfo) + * [`.SquirrelWindowsOptions`](#module_electron-builder.SquirrelWindowsOptions) ⇐ [WinBuildOptions](#module_electron-builder.WinBuildOptions) + * [`.WinBuildOptions`](#module_electron-builder.WinBuildOptions) ⇐ [PlatformSpecificBuildOptions](#module_electron-builder.PlatformSpecificBuildOptions) + * [.Packager](#module_electron-builder.Packager) ⇐ [BuildInfo](#module_electron-builder.BuildInfo) + * [`.build(rawOptions)`](#module_electron-builder.build) ⇒ Promise + * [`.createTargets(platforms, type, arch)`](#module_electron-builder.createTargets) ⇒ Map + + +- + + + +### `electron-builder.AfterPackContext` +**Kind**: interface of [electron-builder](#module_electron-builder) +**Properties** + +| Name | Type | +| --- | --- | +| appOutDir | string | +| packager | [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) | +| electronPlatformName | string | +| arch | "0" | "1" | "2" | +| targets | Array | + + +- + + + +### `electron-builder.AppImageOptions` ⇐ [LinuxBuildOptions](#module_electron-builder.LinuxBuildOptions) +### `appImage` [AppImage](http://appimage.org) Specific Options + +**Kind**: interface of [electron-builder](#module_electron-builder) +**Extends**: [LinuxBuildOptions](#module_electron-builder.LinuxBuildOptions) + +- + + + +### `electron-builder.AppXOptions` +### `appx` + +Please see [Windows AppX docs](https://msdn.microsoft.com/en-us/library/windows/apps/br211453.aspx). + +**Kind**: interface of [electron-builder](#module_electron-builder) +**Properties** + +| Name | Type | Description | +| --- | --- | --- | +| backgroundColor | string | null | The background color of the app tile. Please see [Visual Elements](https://msdn.microsoft.com/en-us/library/windows/apps/br211471.aspx). | +| makeappxArgs | Array | null | | +| publisher | string | null | Describes the publisher information in a form `CN=your name exactly as in your cert`. The Publisher attribute must match the publisher subject information of the certificate used to sign a package. By default will be extracted from code sign certificate. | +| displayName | string | null | A friendly name that can be displayed to users. Corresponds to [Properties.DisplayName](https://msdn.microsoft.com/en-us/library/windows/apps/br211432.aspx). | +| publisherDisplayName | string | null | A friendly name for the publisher that can be displayed to users. Corresponds to [Properties.PublisherDisplayName](https://msdn.microsoft.com/en-us/library/windows/apps/br211460.aspx). | +| identityName | string | null | Describes the contents of the package. The Name attribute is case-sensitive. Corresponds to [Identity.Name](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx). | + + +- + + + +### `electron-builder.ArtifactCreated` +**Kind**: interface of [electron-builder](#module_electron-builder) +**Properties** + +| Name | Type | +| --- | --- | +| packager | [PlatformPackager](#module_electron-builder/out/platformPackager.PlatformPackager) | +| target | [Target](#module_electron-builder-core.Target) | null | +| file | string | +| data | Buffer | +| safeArtifactName | string | +| publishConfig | [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) | + + +- + + + +### `electron-builder.BuildInfo` +**Kind**: interface of [electron-builder](#module_electron-builder) +**Properties** + +| Name | Type | +| --- | --- | +| options | [PackagerOptions](#module_electron-builder.PackagerOptions) | +| metadata | [Metadata](#module_electron-builder.Metadata) | +| config | [Config](#module_electron-builder.Config) | +| projectDir | string | +| appDir | string | +| electronVersion | string | +| isTwoPackageJsonProjectLayoutUsed | boolean | +| appInfo | [AppInfo](#module_electron-builder/out/appInfo.AppInfo) | +| tempDirManager | [TmpDir](#module_electron-builder-util/out/tmp.TmpDir) | +| repositoryInfo | Promise | +| isPrepackedAppAsar | boolean | +| prepackaged | string | null | +| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | + + +- + + + +### `electron-builder.BuildOptions` ⇐ [PublishOptions](#module_electron-publish.PublishOptions) +**Kind**: interface of [electron-builder](#module_electron-builder) +**Extends**: [PublishOptions](#module_electron-publish.PublishOptions) + +- + + + +### `electron-builder.BuildResult` +**Kind**: interface of [electron-builder](#module_electron-builder) +**Properties** + +| Name | Type | +| --- | --- | +| outDir | string | +| platformToTargets | Map | + + +- + + + +### `electron-builder.CliOptions` ⇐ [PublishOptions](#module_electron-publish.PublishOptions) +**Kind**: interface of [electron-builder](#module_electron-builder) +**Extends**: [PublishOptions](#module_electron-publish.PublishOptions) +**Properties** + +| Name | Type | +| --- | --- | +| mac | Array | +| linux | Array | +| win | Array | +| arch | string | +| x64 | boolean | +| ia32 | boolean | +| armv7l | boolean | +| dir | boolean | +| platform | string | +| project | string | + + +- + + + +### ~~`electron-builder.Config` ⇐ [TargetSpecificOptions](#module_electron-builder-core.TargetSpecificOptions)~~ +***Deprecated*** + +## Configuration Options + +**Kind**: interface of [electron-builder](#module_electron-builder) +**Extends**: [TargetSpecificOptions](#module_electron-builder-core.TargetSpecificOptions) +**See**: [Publish options](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts#publish-options). +**Properties** + +| Name | Type | Description | +| --- | --- | --- | +| appId | string | null | The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as [Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). Defaults to `com.electron.${name}`. It is strongly recommended that an explicit ID be set. | +| copyright | string | null | The human-readable copyright line for the app. Defaults to `Copyright © year author`. | +| iconUrl | string | null | | +| productName | string | null | As [name](#AppMetadata-name), but allows you to specify a product name for your executable which contains spaces and other special characters not allowed in the [name property](https://docs.npmjs.com/files/package.json#name}). | +| files | Array | string | null | A [glob patterns](https://www.npmjs.com/package/glob#glob-primer) relative to the [app directory](#MetadataDirectories-app), which specifies which files to include when copying files to create the package. See [File Patterns](#multiple-glob-patterns). | +| extraResources | Array | [FilePattern](#module_electron-builder-core.FilePattern) | string | null | A [glob patterns](https://www.npmjs.com/package/glob#glob-primer) relative to the project directory, when specified, copy the file or directory with matching names directly into the app's resources directory (`Contents/Resources` for MacOS, `resources` for Linux/Windows). Glob rules the same as for [files](#multiple-glob-patterns). | +| extraFiles | Array | [FilePattern](#module_electron-builder-core.FilePattern) | string | null | The same as [extraResources](#Config-extraResources) but copy into the app's content directory (`Contents` for MacOS, root directory for Linux/Windows). | +| asar | [AsarOptions](#module_electron-builder-core.AsarOptions) | boolean | null | Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/). Defaults to `true`. Node modules, that must be unpacked, will be detected automatically, you don't need to explicitly set [asarUnpack](#Config-asarUnpack) - please file issue if this doesn't work. | +| asarUnpack | Array | string | null | A [glob patterns](https://www.npmjs.com/package/glob#glob-primer) relative to the [app directory](#MetadataDirectories-app), which specifies which files to unpack when creating the [asar](http://electron.atom.io/docs/tutorial/application-packaging/) archive. | +| fileAssociations | Array | [FileAssociation](#module_electron-builder.FileAssociation) | | +| protocols | Array | [Protocol](#module_electron-builder.Protocol) | | +| mac | [MacOptions](#module_electron-builder.MacOptions) | null | | +| dmg | [DmgOptions](#module_electron-builder.DmgOptions) | null | | +| mas | [MasBuildOptions](#module_electron-builder.MasBuildOptions) | null | | +| win | [WinBuildOptions](#module_electron-builder.WinBuildOptions) | null | | +| nsis | [NsisOptions](#module_electron-builder.NsisOptions) | null | | +| portable | [NsisOptions](#module_electron-builder.NsisOptions) | null | | +| pkg | [PkgOptions](#module_electron-builder.PkgOptions) | null | | +| appx | [AppXOptions](#module_electron-builder.AppXOptions) | null | | +| squirrelWindows | [SquirrelWindowsOptions](#module_electron-builder.SquirrelWindowsOptions) | null | | +| linux | [LinuxBuildOptions](#module_electron-builder.LinuxBuildOptions) | null | | +| deb | [DebOptions](#module_electron-builder.DebOptions) | null | | +| snap | [SnapOptions](#module_electron-builder.SnapOptions) | null | | +| appimage | [AppImageOptions](#module_electron-builder.AppImageOptions) | null | | +| pacman | [LinuxBuildOptions](#module_electron-builder.LinuxBuildOptions) | null | | +| rpm | [LinuxBuildOptions](#module_electron-builder.LinuxBuildOptions) | null | | +| freebsd | [LinuxBuildOptions](#module_electron-builder.LinuxBuildOptions) | null | | +| p5p | [LinuxBuildOptions](#module_electron-builder.LinuxBuildOptions) | null | | +| apk | [LinuxBuildOptions](#module_electron-builder.LinuxBuildOptions) | null | | +| compression | "store" | "normal" | "maximum" | null | The compression level, one of `store`, `normal`, `maximum` (default: `normal`). If you want to rapidly test build, `store` can reduce build time significantly. | +| afterPack | callback | programmatic API only* The function to be run after pack (but before pack into distributable format and sign). Promise must be returned. | +| beforeBuild | callback | programmatic API only* The function to be run before dependencies are installed or rebuilt. Works when `npmRebuild` is set to `true`. Promise must be returned. Resolving to `false` will skip dependencies install or rebuild. | +| npmRebuild | boolean | Whether to [rebuild](https://docs.npmjs.com/cli/rebuild) native dependencies (`npm rebuild`) before starting to package the app. Defaults to `true`. | +| npmSkipBuildFromSource | boolean | Whether to omit using [--build-from-source](https://github.com/mapbox/node-pre-gyp#options) flag when installing app native deps. Defaults to `false`. | +| npmArgs | Array | string | null | Additional command line arguments to use when installing app native deps. Defaults to `null`. | +| nodeGypRebuild | boolean | Whether to execute `node-gyp rebuild` before starting to package the app. Defaults to `false`. | +| electronDist | string | The path to custom Electron build (e.g. `~/electron/out/R`). Only macOS supported, file issue if need for Linux or Windows. | +| electronDownload | any | The [electron-download](https://github.com/electron-userland/electron-download#usage) options. | +| icon | string | null | | +| publish | null | string | [GithubOptions](#module_electron-builder-http/out/publishOptions.GithubOptions) | [S3Options](#module_electron-builder-http/out/publishOptions.S3Options) | [GenericServerOptions](#module_electron-builder-http/out/publishOptions.GenericServerOptions) | [BintrayOptions](#module_electron-builder-http/out/publishOptions.BintrayOptions) | Array | Array of option objects. Order is important — first item will be used as a default auto-update server on Windows (NSIS). | +| forceCodeSigning | boolean | Whether to fail if application will be not signed (to prevent unsigned app if code signing configuration is not correct). | +| directories | [MetadataDirectories](#module_electron-builder.MetadataDirectories) | null | | +| electronVersion | string | null | The version of electron you are packaging for. Defaults to version of `electron`, `electron-prebuilt` or `electron-prebuilt-compile` dependency. | +| artifactName | string | null | The [artifact file name pattern](https://github.com/electron-userland/electron-builder/wiki/Options#artifact-file-name-pattern). Defaults to `${productName}-${version}.${ext}` (some target can have another defaults, see corresponding options). Currently supported only for `mas`, `pkg`, `dmg` and `nsis`. | +| buildVersion | string | null | The build version. Maps to the `CFBundleVersion` on macOS, and `FileVersion` metadata property on Windows. Defaults to the `version`. If `TRAVIS_BUILD_NUMBER` or `APPVEYOR_BUILD_NUMBER` or `CIRCLE_BUILD_NUM` or `BUILD_NUMBER` or `bamboo.buildNumber` env defined, it will be used as a build version (`version.build_number`). | + + +- + + + +### `electron-builder.DebOptions` ⇐ [LinuxBuildOptions](#module_electron-builder.LinuxBuildOptions) +### `deb` Debian Package Specific Options + +**Kind**: interface of [electron-builder](#module_electron-builder) +**Extends**: [LinuxBuildOptions](#module_electron-builder.LinuxBuildOptions) +**Properties** + +| Name | Type | Description | +| --- | --- | --- | +| synopsis | string | null | The [short description](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Description). | +| compression | string | null | The compression type, one of `gz`, `bzip2`, `xz`. Defaults to `xz`. | +| priority | string | null | The [Priority](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Priority) attribute. | + + +- + + + +### `electron-builder.DmgContent` +**Kind**: interface of [electron-builder](#module_electron-builder) +**Properties** + +| Name | Type | Description | +| --- | --- | --- | +| x | number | | +| y | number | | +| type | "link" | "file" | | +| name | string | The name of the file within the DMG. Defaults to basename of `path`. | +| path | string | | + + +- + + + +### `electron-builder.DmgOptions` ⇐ [TargetSpecificOptions](#module_electron-builder-core.TargetSpecificOptions) +### `dmg` macOS DMG Options + +**Kind**: interface of [electron-builder](#module_electron-builder) +**Extends**: [TargetSpecificOptions](#module_electron-builder-core.TargetSpecificOptions) +**Properties** + +| Name | Type | Description | +| --- | --- | --- | +| background | string | null | The path to background image (default: `build/background.tiff` or `build/background.png` if exists). The resolution of this file determines the resolution of the installer window. If background is not specified, use `window.size`. Default locations expected background size to be 540x380. See [DMG with Retina background support](http://stackoverflow.com/a/11204769/1910191). | +| backgroundColor | string | null | The background color (accepts css colors). Defaults to `#ffffff` (white) if no background image. | +| icon | string | null | The path to DMG icon (volume icon), which will be shown when mounted, relative to the the [build resources](https://github.com/electron-userland/electron-builder/wiki/Options#MetadataDirectories-buildResources) or to the project directory. Defaults to the application icon (`build/icon.icns`). | +| iconSize | number | null | The size of all the icons inside the DMG. Defaults to 80. | +| iconTextSize | number | null | The size of all the icon texts inside the DMG. Defaults to 12. | +| title | string | null | The title of the produced DMG, which will be shown when mounted (volume name). Defaults to `${productName} ${version}` Macro `${productName}`, `${version}` and `${name}` are supported. | +| contents | Array | The content — to customize icon locations. | +| format | string | The disk image format, one of `UDRW`, `UDRO`, `UDCO`, `UDZO`, `UDBZ`, `ULFO` (lzfse-compressed image (OS X 10.11+ only)). Defaults to `UDBZ` (bzip2-compressed image). | +| window | [DmgWindow](#module_electron-builder.DmgWindow) | The DMG windows position and size. See [dmg.window](#DmgWindow). | + + +- + + + +### `electron-builder.DmgWindow` +### `dmg.window` DMG Windows Position and Size + +**Kind**: interface of [electron-builder](#module_electron-builder) +**Properties** + +| Name | Type | Description | +| --- | --- | --- | +| x | number | The X position relative to left of the screen. Defaults to 400. | +| y | number | The Y position relative to top of the screen. Defaults to 100. | +| width | number | The width. Defaults to background image width or 540. | +| height | number | The height. Defaults to background image height or 380. | + + +- + + + +### `electron-builder.FileAssociation` +### `fileAssociations` File Associations + +macOS (corresponds to [CFBundleDocumentTypes](https://developer.apple.com/library/content/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-101685)) and NSIS only. Array of option objects. + +On Windows works only if [nsis.perMachine](https://github.com/electron-userland/electron-builder/wiki/Options#NsisOptions-perMachine) is set to `true`. + +**Kind**: interface of [electron-builder](#module_electron-builder) +**Properties** + +| Name | Type | Description | +| --- | --- | --- | +| ext | string | Array | The extension (minus the leading period). e.g. `png`. | +| name | string | null | The name. e.g. `PNG`. Defaults to `ext`. | +| description | string | null | windows-only.* The description. | +| icon | string | The path to icon (`.icns` for MacOS and `.ico` for Windows), relative to `build` (build resources directory). Defaults to `${firstExt}.icns`/`${firstExt}.ico` (if several extensions specified, first is used) or to application icon. | +| role | string | macOS-only* The app’s role with respect to the type. The value can be `Editor`, `Viewer`, `Shell`, or `None`. Defaults to `Editor`. Corresponds to `CFBundleTypeRole`. | +| isPackage | boolean | macOS-only* Whether the document is distributed as a bundle. If set to true, the bundle directory is treated as a file. Corresponds to `LSTypeIsPackage`. | + + +- + + + +### `electron-builder.LinuxBuildOptions` ⇐ [PlatformSpecificBuildOptions](#module_electron-builder.PlatformSpecificBuildOptions) +### `linux` Linux Specific Options + +**Kind**: interface of [electron-builder](#module_electron-builder) +**Extends**: [PlatformSpecificBuildOptions](#module_electron-builder.PlatformSpecificBuildOptions) +**Properties** + +| Name | Type | Description | +| --- | --- | --- | +| category | string | null | The [application category](https://specifications.freedesktop.org/menu-spec/latest/apa.html#main-category-registry). | +| packageCategory | string | null | The [package category](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Section). Not applicable for AppImage. | +| description | string | null | As [description](#AppMetadata-description) from application package.json, but allows you to specify different for Linux. | +| target | null | string | [TargetConfig](#module_electron-builder-core.TargetConfig) | Array | Target package type: list of `AppImage`, `snap`, `deb`, `rpm`, `freebsd`, `pacman`, `p5p`, `apk`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`. Defaults to `AppImage`. The most effective [xz](https://en.wikipedia.org/wiki/Xz) compression format used by default. electron-builder [docker image](https://github.com/electron-userland/electron-builder/wiki/Docker) can be used to build Linux targets on any platform. See [Multi platform build](https://github.com/electron-userland/electron-builder/wiki/Multi-Platform-Build). | +| maintainer | string | null | The maintainer. Defaults to [author](#AppMetadata-author). | +| vendor | string | null | The vendor. Defaults to [author](#AppMetadata-author). | +| fpm | Array | null | | +| desktop | module:electron-builder/out/options/linuxOptions.__type | null | The [Desktop file](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) entries (name to value). | +| afterInstall | string | null | | +| afterRemove | string | null | | +| depends | Array | null | Package dependencies. Defaults to `["gconf2", "gconf-service", "libnotify4", "libappindicator1", "libxtst6", "libnss3"]` for `deb`. | +| executableName | string | null | The executable name. Defaults to `productName`. Cannot be specified per target, allowed only in the `linux`. | +| icon | string | The path to icon set directory, relative to the the [build resources](https://github.com/electron-userland/electron-builder/wiki/Options#MetadataDirectories-buildResources) or to the project directory. The icon filename must contain the size (e.g. 32x32.png) of the icon. By default will be generated automatically based on the macOS icns file. | + + +- + + + +### `electron-builder.MacOptions` ⇐ [PlatformSpecificBuildOptions](#module_electron-builder.PlatformSpecificBuildOptions) +### `mac` macOS Specific Options + +**Kind**: interface of [electron-builder](#module_electron-builder) +**Extends**: [PlatformSpecificBuildOptions](#module_electron-builder.PlatformSpecificBuildOptions) +**Properties** + +| Name | Type | Description | +| --- | --- | --- | +| category | string | null | The application category type, as shown in the Finder via *View -> Arrange by Application Category* when viewing the Applications directory. For example, `"category": "public.app-category.developer-tools"` will set the application category to *Developer Tools*. Valid values are listed in [Apple's documentation](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/LaunchServicesKeys.html#//apple_ref/doc/uid/TP40009250-SW8). | +| target | Array | "default" | "dmg" | "mas" | "pkg" | "7z" | "zip" | "tar.xz" | "tar.lz" | "tar.gz" | "tar.bz2" | "dir" | [TargetConfig](#module_electron-builder-core.TargetConfig) | null | The target package type: list of `default`, `dmg`, `mas`, `pkg`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`. Defaults to `default` (dmg and zip for Squirrel.Mac). | +| identity | string | null | The name of certificate to use when signing. Consider using environment variables [CSC_LINK or CSC_NAME](https://github.com/electron-userland/electron-builder/wiki/Code-Signing) instead of specifying this option. MAS installer identity is specified in the [mas](#MasBuildOptions-identity). | +| icon | string | null | The path to application icon. Defaults to `build/icon.icns` (consider using this convention instead of complicating your configuration). | +| entitlements | string | null | The path to entitlements file for signing the app. `build/entitlements.mac.plist` will be used if exists (it is a recommended way to set). MAS entitlements is specified in the [mas](#MasBuildOptions-entitlements). | +| entitlementsInherit | string | null | The path to child entitlements which inherit the security settings for signing frameworks and bundles of a distribution. `build/entitlements.mac.inherit.plist` will be used if exists (it is a recommended way to set). Otherwise [default](https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.darwin.inherit.plist). This option only applies when signing with `entitlements` provided. | +| bundleVersion | string | null | The `CFBundleVersion`. Do not use it unless [you need to](see (https://github.com/electron-userland/electron-builder/issues/565#issuecomment-230678643)). | +| helperBundleId | string | null | The bundle identifier to use in the application helper's plist. Defaults to `${appBundleIdentifier}.helper`. | +| type | "distribution" | "development" | null | Whether to sign app for development or for distribution. One of `development`, `distribution`. Defaults to `distribution`. | +| extendInfo | any | The extra entries for `Info.plist`. | + + +- + + + +### `electron-builder.MasBuildOptions` ⇐ [MacOptions](#module_electron-builder.MacOptions) +### `mas` MAS (Mac Application Store) Specific Options + +**Kind**: interface of [electron-builder](#module_electron-builder) +**Extends**: [MacOptions](#module_electron-builder.MacOptions) +**Properties** + +| Name | Type | Description | +| --- | --- | --- | +| entitlements | string | null | The path to entitlements file for signing the app. `build/entitlements.mas.plist` will be used if exists (it is a recommended way to set). Otherwise [default](https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.mas.plist). | +| entitlementsInherit | string | null | The path to child entitlements which inherit the security settings for signing frameworks and bundles of a distribution. `build/entitlements.mas.inherit.plist` will be used if exists (it is a recommended way to set). Otherwise [default](https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.mas.inherit.plist). | + + +- + + + +### `electron-builder.Metadata` +## Fields in the package.json + +Some standard fields should be defined in the `package.json`. + +**Kind**: interface of [electron-builder](#module_electron-builder) +**Required**: null +**Properties** + +| Name | Type | Description | +| --- | --- | --- | +| repository | string | [RepositoryInfo](#module_electron-builder-core.RepositoryInfo) | null | | +| dependencies | module:electron-builder/out/metadata.__type | | +| version | string | | +| name | string | The application name. | +| productName | string | null | | +| description | string | The application description. | +| main | string | null | | +| author | [AuthorMetadata](#module_electron-builder-core.AuthorMetadata) | | +| homepage | string | null | The url to the project [homepage](https://docs.npmjs.com/files/package.json#homepage) (NuGet Package `projectUrl` (optional) or Linux Package URL (required)). If not specified and your project repository is public on GitHub, it will be `https://github.com/${user}/${project}` by default. | +| license | string | null | linux-only.* The [license](https://docs.npmjs.com/files/package.json#license) name. | +| build | [Config](#module_electron-builder.Config) | | + + +- + + + +### `electron-builder.MetadataDirectories` +### `directories` + +**Kind**: interface of [electron-builder](#module_electron-builder) +**Properties** + +| Name | Type | Description | +| --- | --- | --- | +| buildResources | string | null | The path to build resources, defaults to `build`. | +| output | string | null | The output directory, defaults to `dist`. | +| app | string | null | The application directory (containing the application package.json), defaults to `app`, `www` or working directory. | + + +- + + + +### `electron-builder.NsisOptions` +### `nsis` + +See [NSIS target notes](https://github.com/electron-userland/electron-builder/wiki/NSIS). + +**Kind**: interface of [electron-builder](#module_electron-builder) +**Properties** + +| Name | Type | Description | +| --- | --- | --- | +| oneClick | boolean | One-click installation. Defaults to `true`. | +| perMachine | boolean | Defaults to `false`. If `oneClick` is `true` (default): Install per all users (per-machine). If `oneClick` is `false`: no install mode installer page (choice per-machine or per-user), always install per-machine. | +| allowElevation | boolean | boring installer only.* Allow requesting for elevation. If false, user will have to restart installer with elevated permissions. Defaults to `true`. | +| allowToChangeInstallationDirectory | boolean | boring installer only.* Whether to allow user to change installation directory. Defaults to `false`. | +| runAfterFinish | boolean | one-click installer only.* Run application after finish. Defaults to `true`. | +| guid | string | null | See [GUID vs Application Name](https://github.com/electron-userland/electron-builder/wiki/NSIS#guid-vs-application-name). | +| installerIcon | string | null | The path to installer icon, relative to the the [build resources](https://github.com/electron-userland/electron-builder/wiki/Options#MetadataDirectories-buildResources) or to the project directory. Defaults to `build/installerIcon.ico` or application icon. | +| installerHeader | string | null | boring installer only.* `MUI_HEADERIMAGE`, relative to the the [build resources](https://github.com/electron-userland/electron-builder/wiki/Options#MetadataDirectories-buildResources) or to the project directory. Defaults to `build/installerHeader.bmp` | +| installerSidebar | string | null | boring installer only.* `MUI_WELCOMEFINISHPAGE_BITMAP`, relative to the the [build resources](https://github.com/electron-userland/electron-builder/wiki/Options#MetadataDirectories-buildResources) or to the project directory. Defaults to `build/installerSidebar.bmp` or `${NSISDIR}\\Contrib\\Graphics\\Wizard\\nsis3-metro.bmp` | +| uninstallerSidebar | string | null | boring installer only.* `MUI_UNWELCOMEFINISHPAGE_BITMAP`, relative to the the [build resources](https://github.com/electron-userland/electron-builder/wiki/Options#MetadataDirectories-buildResources) or to the project directory. Defaults to `installerSidebar` option or `build/uninstallerSidebar.bmp` or `build/installerSidebar.bmp` or `${NSISDIR}\\Contrib\\Graphics\\Wizard\\nsis3-metro.bmp` | +| installerHeaderIcon | string | null | one-click installer only.* The path to header icon (above the progress bar), relative to the the [build resources](https://github.com/electron-userland/electron-builder/wiki/Options#MetadataDirectories-buildResources) or to the project directory. Defaults to `build/installerHeaderIcon.ico` or application icon. | +| include | string | null | The path to NSIS include script to customize installer. Defaults to `build/installer.nsh`. See [Custom NSIS script](https://github.com/electron-userland/electron-builder/wiki/NSIS#custom-nsis-script). | +| script | string | null | The path to NSIS script to customize installer. Defaults to `build/installer.nsi`. See [Custom NSIS script](https://github.com/electron-userland/electron-builder/wiki/NSIS#custom-nsis-script). | +| license | string | null | The path to EULA license file. Defaults to `build/license.rtf` or `build/license.txt`. | +| language | string | null | [LCID Dec](https://msdn.microsoft.com/en-au/goglobal/bb964664.aspx), defaults to `1033`(`English - United States`). | +| multiLanguageInstaller | boolean | boring installer only.* Whether to create multi-language installer. Defaults to `unicode` option value. [Not all strings are translated](https://github.com/electron-userland/electron-builder/issues/646#issuecomment-238155800). | +| warningsAsErrors | boolean | Defaults to `true`. If `warningsAsErrors` is `true` (default): NSIS will treat warnings as errors. If `warningsAsErrors` is `false`: NSIS will allow warnings. | +| menuCategory | boolean | string | Whether to create submenu for start menu shortcut and program files directory. Defaults to `false`. If `true`, company name will be used. Or string value. | +| useZip | boolean | | +| artifactName | string | null | The [artifact file name pattern](https://github.com/electron-userland/electron-builder/wiki/Options#artifact-file-name-pattern). Defaults to `${productName} Setup ${version}.${ext}`. | +| unicode | boolean | Whether to create [Unicode installer](http://nsis.sourceforge.net/Docs/Chapter1.html#intro-unicode). Defaults to `true`. | +| deleteAppDataOnUninstall | boolean | one-click installer only.* Whether to delete app data on uninstall. Defaults to `false`. | + + +- + + + +### `electron-builder.NsisWebOptions` ⇐ [NsisOptions](#module_electron-builder.NsisOptions) +### `nsis` Web Installer Specific Options + +**Kind**: interface of [electron-builder](#module_electron-builder) +**Extends**: [NsisOptions](#module_electron-builder.NsisOptions) +**Properties** + +| Name | Type | Description | +| --- | --- | --- | +| appPackageUrl | string | null | The application package download URL. Optional — by default computed using publish configuration. URL like `https://example.com/download/latest` allows web installer to be version independent (installer will download latest application package). Custom `X-Arch` http header is set to `32` or `64`. | +| artifactName | string | null | The [artifact file name pattern](https://github.com/electron-userland/electron-builder/wiki/Options#artifact-file-name-pattern). Defaults to `${productName} Web Setup ${version}.${ext}`. | + + +- + + + +### ~~`electron-builder.PackagerOptions`~~ +***Deprecated*** + +**Kind**: interface of [electron-builder](#module_electron-builder) +**Properties** + +| Name | Type | Description | +| --- | --- | --- | +| targets | Map | | +| projectDir | string | null | | +| cscLink | string | null | | +| cscKeyPassword | string | null | | +| cscInstallerLink | string | null | | +| cscInstallerKeyPassword | string | null | | +| platformPackagerFactory | module:electron-builder/out/packagerApi.__type | null | | +| devMetadata | [Metadata](#module_electron-builder.Metadata) | | +| config | [Config](#module_electron-builder.Config) | string | null | | +| appMetadata | [Metadata](#module_electron-builder.Metadata) | The same as [application package.json](https://github.com/electron-userland/electron-builder/wiki/Options#AppMetadata). Application `package.json` will be still read, but options specified in this object will override. | +| effectiveOptionComputed | callback | | +| extraMetadata | any | | +| prepackaged | string | | + + +- + + + +### `electron-builder.PkgOptions` ⇐ [TargetSpecificOptions](#module_electron-builder-core.TargetSpecificOptions) +### `pkg` macOS Product Archive Options + +**Kind**: interface of [electron-builder](#module_electron-builder) +**Extends**: [TargetSpecificOptions](#module_electron-builder-core.TargetSpecificOptions) +**Properties** + +| Name | Type | Description | +| --- | --- | --- | +| scripts | string | null | The scripts directory, relative to `build` (build resources directory). Defaults to `build/pkg-scripts`. See [Scripting in installer packages](http://macinstallers.blogspot.de/2012/07/scripting-in-installer-packages.html). The scripts can be in any language so long as the files are marked executable and have the appropriate shebang indicating the path to the interpreter. Scripts are required to be executable (`chmod +x file`). | +| productbuild | Array | null | | +| installLocation | string | null | The install location. Defaults to `/Applications`. | +| identity | string | null | | + + +- + + + +### `electron-builder.PlatformSpecificBuildOptions` ⇐ [TargetSpecificOptions](#module_electron-builder-core.TargetSpecificOptions) +**Kind**: interface of [electron-builder](#module_electron-builder) +**Extends**: [TargetSpecificOptions](#module_electron-builder-core.TargetSpecificOptions) +**Properties** + +| Name | Type | +| --- | --- | +| files | Array | string | null | +| extraFiles | Array | [FilePattern](#module_electron-builder-core.FilePattern) | string | null | +| extraResources | Array | [FilePattern](#module_electron-builder-core.FilePattern) | string | null | +| asarUnpack | Array | string | null | +| asar | [AsarOptions](#module_electron-builder-core.AsarOptions) | boolean | null | +| target | Array | string | [TargetConfig](#module_electron-builder-core.TargetConfig) | null | +| icon | string | null | +| fileAssociations | Array | [FileAssociation](#module_electron-builder.FileAssociation) | +| publish | null | string | [GithubOptions](#module_electron-builder-http/out/publishOptions.GithubOptions) | [S3Options](#module_electron-builder-http/out/publishOptions.S3Options) | [GenericServerOptions](#module_electron-builder-http/out/publishOptions.GenericServerOptions) | [BintrayOptions](#module_electron-builder-http/out/publishOptions.BintrayOptions) | Array | + + +- + + + +### `electron-builder.Protocol` +### `protocols` URL Protocol Schemes + +Protocols to associate the app with. macOS only. + +Please note — on macOS [you need to register an `open-url` event handler](http://electron.atom.io/docs/api/app/#event-open-url-macos). + +**Kind**: interface of [electron-builder](#module_electron-builder) +**Properties** + +| Name | Type | Description | +| --- | --- | --- | +| name | string | The name. e.g. `IRC server URL`. | +| role | string | macOS-only* The app’s role with respect to the type. The value can be `Editor`, `Viewer`, `Shell`, or `None`. Defaults to `Editor`. | +| schemes | Array | The schemes. e.g. `["irc", "ircs"]`. | + + +- + + + +### `electron-builder.SnapOptions` ⇐ [LinuxBuildOptions](#module_electron-builder.LinuxBuildOptions) +### `snap` [Snap](http://snapcraft.io) Specific Options + +**Kind**: interface of [electron-builder](#module_electron-builder) +**Extends**: [LinuxBuildOptions](#module_electron-builder.LinuxBuildOptions) +**Properties** + +| Name | Type | Description | +| --- | --- | --- | +| confinement | "devmode" | "strict" | "classic" | null | The type of [confinement](https://snapcraft.io/docs/reference/confinement) supported by the snap. Defaults to `strict`. | +| summary | string | null | The 78 character long summary. Defaults to [productName](#AppMetadata-productName). | +| grade | "devel" | "stable" | null | The quality grade of the snap. It can be either `devel` (i.e. a development version of the snap, so not to be published to the “stable” or “candidate” channels) or “stable” (i.e. a stable release or release candidate, which can be released to all channels). Defaults to `stable`. | +| assumes | Array | null | The list of features that must be supported by the core in order for this snap to install. | +| stagePackages | Array | null | The list of Ubuntu packages to use that are needed to support the `app` part creation. Like `depends` for `deb`. Defaults to `["libnotify4", "libappindicator1", "libxtst6", "libnss3", "libxss1", "fontconfig-config", "gconf2", "libasound2", "pulseaudio"]`. If list contains `default`, it will be replaced to default list, so, `["default", "foo"]` can be used to add custom package `foo` in addition to defaults. | +| plugs | Array | null | The list of [plugs](https://snapcraft.io/docs/reference/interfaces). Defaults to `["home", "x11", "unity7", "browser-support", "network", "gsettings", "pulseaudio", "opengl"]`. If list contains `default`, it will be replaced to default list, so, `["default", "foo"]` can be used to add custom plug `foo` in addition to defaults. | +| ubuntuAppPlatformContent | string | null | Specify `ubuntu-app-platform1` to use [ubuntu-app-platform](https://insights.ubuntu.com/2016/11/17/how-to-create-snap-packages-on-qt-applications/). Snap size will be greatly reduced, but it is not recommended for now because "the snaps must be connected before running uitk-gallery for the first time". | + + +- + + + +### `electron-builder.SourceRepositoryInfo` +**Kind**: interface of [electron-builder](#module_electron-builder) +**Properties** + +| Name | Type | +| --- | --- | +| type | string | +| domain | string | +| user | string | +| project | string | + + +- + + + +### `electron-builder.SquirrelWindowsOptions` ⇐ [WinBuildOptions](#module_electron-builder.WinBuildOptions) +### `squirrelWindows` + +To use Squirrel.Windows please install `electron-builder-squirrel-windows` dependency. Squirrel.Windows target is maintained, but deprecated. Please use `nsis` instead. + +**Kind**: interface of [electron-builder](#module_electron-builder) +**Extends**: [WinBuildOptions](#module_electron-builder.WinBuildOptions) +**Properties** + +| Name | Type | Description | +| --- | --- | --- | +| iconUrl | string | null | A URL to an ICO file to use as the application icon (displayed in Control Panel > Programs and Features). Defaults to the Electron icon. Please note — [local icon file url is not accepted](https://github.com/atom/grunt-electron-installer/issues/73), must be https/http. If you don't plan to build windows installer, you can omit it. If your project repository is public on GitHub, it will be `https://github.com/${u}/${p}/blob/master/build/icon.ico?raw=true` by default. | +| loadingGif | string | null | The path to a .gif file to display during install. `build/install-spinner.gif` will be used if exists (it is a recommended way to set) (otherwise [default](https://github.com/electron/windows-installer/blob/master/resources/install-spinner.gif)). | +| msi | boolean | Whether to create an MSI installer. Defaults to `false` (MSI is not created). | +| remoteReleases | string | boolean | null | A URL to your existing updates. Or `true` to automatically set to your GitHub repository. If given, these will be downloaded to create delta updates. | +| remoteToken | string | null | Authentication token for remote updates | +| useAppIdAsId | boolean | Use `appId` to identify package instead of `name`. | + + +- + + + +### `electron-builder.WinBuildOptions` ⇐ [PlatformSpecificBuildOptions](#module_electron-builder.PlatformSpecificBuildOptions) +### `win` Windows Specific Options + +**Kind**: interface of [electron-builder](#module_electron-builder) +**Extends**: [PlatformSpecificBuildOptions](#module_electron-builder.PlatformSpecificBuildOptions) +**Properties** + +| Name | Type | Description | +| --- | --- | --- | +| target | null | string | [TargetConfig](#module_electron-builder-core.TargetConfig) | Array | Target package type: list of `nsis`, `nsis-web` (Web installer), `portable` (portable app without installation), `appx`, `squirrel`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`. Defaults to `nsis`. AppX package can be built only on Windows 10. To use Squirrel.Windows please install `electron-builder-squirrel-windows` dependency. | +| signingHashAlgorithms | Array | null | Array of signing algorithms used. Defaults to `['sha1', 'sha256']` For AppX `sha256` is always used. | +| icon | string | null | The path to application icon. Defaults to `build/icon.ico` (consider using this convention instead of complicating your configuration). | +| legalTrademarks | string | null | The trademarks and registered trademarks. | +| certificateFile | string | The path to the *.pfx certificate you want to sign with. Please use it only if you cannot use env variable `CSC_LINK` (`WIN_CSC_LINK`) for some reason. Please see [Code Signing](https://github.com/electron-userland/electron-builder/wiki/Code-Signing). | +| certificatePassword | string | The password to the certificate provided in `certificateFile`. Please use it only if you cannot use env variable `CSC_KEY_PASSWORD` (`WIN_CSC_KEY_PASSWORD`) for some reason. Please see [Code Signing](https://github.com/electron-userland/electron-builder/wiki/Code-Signing). | +| certificateSubjectName | string | The name of the subject of the signing certificate. Required only for EV Code Signing and works only on Windows. | +| certificateSha1 | string | The SHA1 hash of the signing certificate. The SHA1 hash is commonly specified when multiple certificates satisfy the criteria specified by the remaining switches. Works only on Windows. | +| rfc3161TimeStampServer | string | The URL of the RFC 3161 time stamp server. Defaults to `http://timestamp.comodoca.com/rfc3161`. | +| timeStampServer | string | The URL of the time stamp server. Defaults to `http://timestamp.verisign.com/scripts/timstamp.dll`. | +| publisherName | string | Array | null | [The publisher name](https://github.com/electron-userland/electron-builder/issues/1187#issuecomment-278972073), exactly as in your code signed certificate. Several names can be provided. Defaults to common name from your code signing certificate. | + + +- + + + +### electron-builder.Packager ⇐ [BuildInfo](#module_electron-builder.BuildInfo) +**Kind**: class of [electron-builder](#module_electron-builder) +**Extends**: [BuildInfo](#module_electron-builder.BuildInfo) + +- + + + +### `electron-builder.build(rawOptions)` ⇒ Promise +**Kind**: method of [electron-builder](#module_electron-builder) + +| Param | Type | +| --- | --- | +| rawOptions | [CliOptions](#module_electron-builder.CliOptions) | + + +- + + + +### `electron-builder.createTargets(platforms, type, arch)` ⇒ Map +**Kind**: method of [electron-builder](#module_electron-builder) + +| Param | Type | +| --- | --- | +| platforms | Array | +| type | string | null | +| arch | string | null | + + +- + + + +## electron-builder-core + +* [electron-builder-core](#module_electron-builder-core) + * [`.AsarOptions`](#module_electron-builder-core.AsarOptions) + * [`.AuthorMetadata`](#module_electron-builder-core.AuthorMetadata) + * [`.BeforeBuildContext`](#module_electron-builder-core.BeforeBuildContext) + * [`.FilePattern`](#module_electron-builder-core.FilePattern) + * [`.RepositoryInfo`](#module_electron-builder-core.RepositoryInfo) + * [`.TargetConfig`](#module_electron-builder-core.TargetConfig) + * [`.TargetSpecificOptions`](#module_electron-builder-core.TargetSpecificOptions) + * [.Platform](#module_electron-builder-core.Platform) + * [`.createTarget(type, archs)`](#module_electron-builder-core.Platform+createTarget) ⇒ Map + * [`.current()`](#module_electron-builder-core.Platform+current) ⇒ [Platform](#module_electron-builder-core.Platform) + * [`.fromString(name)`](#module_electron-builder-core.Platform+fromString) ⇒ [Platform](#module_electron-builder-core.Platform) + * [`.toString()`](#module_electron-builder-core.Platform+toString) ⇒ string + * [.Target](#module_electron-builder-core.Target) + * [`.build(appOutDir, arch)`](#module_electron-builder-core.Target+build) ⇒ Promise + * [`.finishBuild()`](#module_electron-builder-core.Target+finishBuild) ⇒ Promise + * [`.archFromString(name)`](#module_electron-builder-core.archFromString) ⇒ module:electron-builder-core.Arch + * [`.getArchSuffix(arch)`](#module_electron-builder-core.getArchSuffix) ⇒ string + * [`.toLinuxArchString(arch)`](#module_electron-builder-core.toLinuxArchString) ⇒ + + +- + + + +### `electron-builder-core.AsarOptions` +**Kind**: interface of [electron-builder-core](#module_electron-builder-core) +**Properties** + +| Name | Type | +| --- | --- | +| smartUnpack | boolean | +| ordering | string | null | +| extraMetadata | any | null | + + +- + + + +### `electron-builder-core.AuthorMetadata` +**Kind**: interface of [electron-builder-core](#module_electron-builder-core) +**Properties** + +| Name | Type | +| --- | --- | +| name | string | +| email | string | + + +- + + + +### `electron-builder-core.BeforeBuildContext` +**Kind**: interface of [electron-builder-core](#module_electron-builder-core) +**Properties** + +| Name | Type | +| --- | --- | +| appDir | string | +| electronVersion | string | +| platform | [Platform](#module_electron-builder-core.Platform) | +| arch | string | + + +- + + + +### `electron-builder-core.FilePattern` +**Kind**: interface of [electron-builder-core](#module_electron-builder-core) +**Properties** + +| Name | Type | +| --- | --- | +| from | string | +| to | string | +| filter | Array | string | + + +- + + + +### `electron-builder-core.RepositoryInfo` +**Kind**: interface of [electron-builder-core](#module_electron-builder-core) +**Properties** + +| Name | Type | +| --- | --- | +| url | string | + + +- + + + +### `electron-builder-core.TargetConfig` +**Kind**: interface of [electron-builder-core](#module_electron-builder-core) +**Properties** + +| Name | Type | Description | +| --- | --- | --- | +| target | string | The target name. e.g. `snap`. | +| arch | Array | string | The arch or list of archs. | + + +- + + + +### `electron-builder-core.TargetSpecificOptions` +**Kind**: interface of [electron-builder-core](#module_electron-builder-core) +**Properties** + +| Name | Type | Description | +| --- | --- | --- | +| artifactName | string | null | The [artifact file name pattern](https://github.com/electron-userland/electron-builder/wiki/Options#artifact-file-name-pattern). | +| forceCodeSigning | boolean | | + + +- + + + +### electron-builder-core.Platform +**Kind**: class of [electron-builder-core](#module_electron-builder-core) + +* [.Platform](#module_electron-builder-core.Platform) + * [`.createTarget(type, archs)`](#module_electron-builder-core.Platform+createTarget) ⇒ Map + * [`.current()`](#module_electron-builder-core.Platform+current) ⇒ [Platform](#module_electron-builder-core.Platform) + * [`.fromString(name)`](#module_electron-builder-core.Platform+fromString) ⇒ [Platform](#module_electron-builder-core.Platform) + * [`.toString()`](#module_electron-builder-core.Platform+toString) ⇒ string + + +- + + + +#### `platform.createTarget(type, archs)` ⇒ Map +**Kind**: instance method of [Platform](#module_electron-builder-core.Platform) + +| Param | Type | +| --- | --- | +| type | string | Array | null | +| archs | Array | + + +- + + + +#### `platform.current()` ⇒ [Platform](#module_electron-builder-core.Platform) +**Kind**: instance method of [Platform](#module_electron-builder-core.Platform) + +- + + + +#### `platform.fromString(name)` ⇒ [Platform](#module_electron-builder-core.Platform) +**Kind**: instance method of [Platform](#module_electron-builder-core.Platform) + +| Param | Type | +| --- | --- | +| name | string | + + +- + + + +#### `platform.toString()` ⇒ string +**Kind**: instance method of [Platform](#module_electron-builder-core.Platform) + +- + + + +### electron-builder-core.Target +**Kind**: class of [electron-builder-core](#module_electron-builder-core) + +* [.Target](#module_electron-builder-core.Target) + * [`.build(appOutDir, arch)`](#module_electron-builder-core.Target+build) ⇒ Promise + * [`.finishBuild()`](#module_electron-builder-core.Target+finishBuild) ⇒ Promise + + +- + + + +#### `target.build(appOutDir, arch)` ⇒ Promise +**Kind**: instance method of [Target](#module_electron-builder-core.Target) + +| Param | Type | +| --- | --- | +| appOutDir | string | +| arch | "0" | "1" | "2" | + + +- + + + +#### `target.finishBuild()` ⇒ Promise +**Kind**: instance method of [Target](#module_electron-builder-core.Target) + +- + + + +### `electron-builder-core.archFromString(name)` ⇒ module:electron-builder-core.Arch +**Kind**: method of [electron-builder-core](#module_electron-builder-core) + +| Param | Type | +| --- | --- | +| name | string | + + +- + + + +### `electron-builder-core.getArchSuffix(arch)` ⇒ string +**Kind**: method of [electron-builder-core](#module_electron-builder-core) + +| Param | Type | +| --- | --- | +| arch | "0" | "1" | "2" | + + +- + + + +### `electron-builder-core.toLinuxArchString(arch)` ⇒ +**Kind**: method of [electron-builder-core](#module_electron-builder-core) + +| Param | Type | +| --- | --- | +| arch | "0" | "1" | "2" | + + +- + + + +## electron-publish/out/BintrayPublisher + +* [electron-publish/out/BintrayPublisher](#module_electron-publish/out/BintrayPublisher) + * [.BintrayPublisher](#module_electron-publish/out/BintrayPublisher.BintrayPublisher) ⇐ [HttpPublisher](#module_electron-publish.HttpPublisher) + * [`.deleteRelease()`](#module_electron-publish/out/BintrayPublisher.BintrayPublisher+deleteRelease) ⇒ Promise + * [`.toString()`](#module_electron-publish/out/BintrayPublisher.BintrayPublisher+toString) ⇒ string + * [`.doUpload(fileName, dataLength, requestProcessor)`](#module_electron-publish/out/BintrayPublisher.BintrayPublisher+doUpload) ⇒ Promise + * [`.upload(file, safeArtifactName)`](#module_electron-publish.HttpPublisher+upload) ⇒ Promise + * [`.uploadData(data, fileName)`](#module_electron-publish.HttpPublisher+uploadData) ⇒ Promise + * [`.createProgressBar(fileName, fileStat)`](#module_electron-publish.Publisher+createProgressBar) ⇒ + * [`.createReadStreamAndProgressBar(file, fileStat, progressBar, reject)`](#module_electron-publish.Publisher+createReadStreamAndProgressBar) ⇒ NodeJS:ReadableStream + + +- + + + +### electron-publish/out/BintrayPublisher.BintrayPublisher ⇐ [HttpPublisher](#module_electron-publish.HttpPublisher) +**Kind**: class of [electron-publish/out/BintrayPublisher](#module_electron-publish/out/BintrayPublisher) +**Extends**: [HttpPublisher](#module_electron-publish.HttpPublisher) + +* [.BintrayPublisher](#module_electron-publish/out/BintrayPublisher.BintrayPublisher) ⇐ [HttpPublisher](#module_electron-publish.HttpPublisher) + * [`.deleteRelease()`](#module_electron-publish/out/BintrayPublisher.BintrayPublisher+deleteRelease) ⇒ Promise + * [`.toString()`](#module_electron-publish/out/BintrayPublisher.BintrayPublisher+toString) ⇒ string + * [`.doUpload(fileName, dataLength, requestProcessor)`](#module_electron-publish/out/BintrayPublisher.BintrayPublisher+doUpload) ⇒ Promise + * [`.upload(file, safeArtifactName)`](#module_electron-publish.HttpPublisher+upload) ⇒ Promise + * [`.uploadData(data, fileName)`](#module_electron-publish.HttpPublisher+uploadData) ⇒ Promise + * [`.createProgressBar(fileName, fileStat)`](#module_electron-publish.Publisher+createProgressBar) ⇒ + * [`.createReadStreamAndProgressBar(file, fileStat, progressBar, reject)`](#module_electron-publish.Publisher+createReadStreamAndProgressBar) ⇒ NodeJS:ReadableStream + + +- + + + +#### `bintrayPublisher.deleteRelease()` ⇒ Promise +**Kind**: instance method of [BintrayPublisher](#module_electron-publish/out/BintrayPublisher.BintrayPublisher) + +- + + + +#### `bintrayPublisher.toString()` ⇒ string +**Kind**: instance method of [BintrayPublisher](#module_electron-publish/out/BintrayPublisher.BintrayPublisher) +**Overrides**: [toString](#module_electron-publish.Publisher+toString) + +- + + + +#### `bintrayPublisher.doUpload(fileName, dataLength, requestProcessor)` ⇒ Promise +**Kind**: instance method of [BintrayPublisher](#module_electron-publish/out/BintrayPublisher.BintrayPublisher) +**Overrides**: [doUpload](#module_electron-publish.HttpPublisher+doUpload) +**Access**: protected + +| Param | Type | +| --- | --- | +| fileName | string | +| dataLength | number | +| requestProcessor | callback | + + +- + + + +#### `bintrayPublisher.upload(file, safeArtifactName)` ⇒ Promise +**Kind**: instance method of [BintrayPublisher](#module_electron-publish/out/BintrayPublisher.BintrayPublisher) + +| Param | Type | +| --- | --- | +| file | string | +| safeArtifactName | string | + + +- + + + +#### `bintrayPublisher.uploadData(data, fileName)` ⇒ Promise +**Kind**: instance method of [BintrayPublisher](#module_electron-publish/out/BintrayPublisher.BintrayPublisher) + +| Param | Type | +| --- | --- | +| data | Buffer | +| fileName | string | + + +- + + + +#### `bintrayPublisher.createProgressBar(fileName, fileStat)` ⇒ +**Kind**: instance method of [BintrayPublisher](#module_electron-publish/out/BintrayPublisher.BintrayPublisher) +**Access**: protected + +| Param | Type | +| --- | --- | +| fileName | string | +| fileStat | module:fs.Stats | + + +- + + + +#### `bintrayPublisher.createReadStreamAndProgressBar(file, fileStat, progressBar, reject)` ⇒ NodeJS:ReadableStream +**Kind**: instance method of [BintrayPublisher](#module_electron-publish/out/BintrayPublisher.BintrayPublisher) +**Access**: protected + +| Param | Type | +| --- | --- | +| file | string | +| fileStat | module:fs.Stats | +| progressBar | module:progress-ex.default | null | +| reject | callback | + + +- + + + +## electron-publish/out/gitHubPublisher + +* [electron-publish/out/gitHubPublisher](#module_electron-publish/out/gitHubPublisher) + * [`.Release`](#module_electron-publish/out/gitHubPublisher.Release) + * [.GitHubPublisher](#module_electron-publish/out/gitHubPublisher.GitHubPublisher) ⇐ [HttpPublisher](#module_electron-publish.HttpPublisher) + * [`.deleteRelease()`](#module_electron-publish/out/gitHubPublisher.GitHubPublisher+deleteRelease) ⇒ Promise + * [`.getRelease()`](#module_electron-publish/out/gitHubPublisher.GitHubPublisher+getRelease) ⇒ Promise + * [`.toString()`](#module_electron-publish/out/gitHubPublisher.GitHubPublisher+toString) ⇒ string + * [`.doUpload(fileName, dataLength, requestProcessor)`](#module_electron-publish/out/gitHubPublisher.GitHubPublisher+doUpload) ⇒ Promise + * [`.upload(file, safeArtifactName)`](#module_electron-publish.HttpPublisher+upload) ⇒ Promise + * [`.uploadData(data, fileName)`](#module_electron-publish.HttpPublisher+uploadData) ⇒ Promise + * [`.createProgressBar(fileName, fileStat)`](#module_electron-publish.Publisher+createProgressBar) ⇒ + * [`.createReadStreamAndProgressBar(file, fileStat, progressBar, reject)`](#module_electron-publish.Publisher+createReadStreamAndProgressBar) ⇒ NodeJS:ReadableStream + + +- + + + +### `electron-publish/out/gitHubPublisher.Release` +**Kind**: interface of [electron-publish/out/gitHubPublisher](#module_electron-publish/out/gitHubPublisher) +**Properties** + +| Name | Type | +| --- | --- | +| id | number | +| tag_name | string | +| draft | boolean | +| prerelease | boolean | +| published_at | string | +| upload_url | string | + + +- + + + +### electron-publish/out/gitHubPublisher.GitHubPublisher ⇐ [HttpPublisher](#module_electron-publish.HttpPublisher) +**Kind**: class of [electron-publish/out/gitHubPublisher](#module_electron-publish/out/gitHubPublisher) +**Extends**: [HttpPublisher](#module_electron-publish.HttpPublisher) + +* [.GitHubPublisher](#module_electron-publish/out/gitHubPublisher.GitHubPublisher) ⇐ [HttpPublisher](#module_electron-publish.HttpPublisher) + * [`.deleteRelease()`](#module_electron-publish/out/gitHubPublisher.GitHubPublisher+deleteRelease) ⇒ Promise + * [`.getRelease()`](#module_electron-publish/out/gitHubPublisher.GitHubPublisher+getRelease) ⇒ Promise + * [`.toString()`](#module_electron-publish/out/gitHubPublisher.GitHubPublisher+toString) ⇒ string + * [`.doUpload(fileName, dataLength, requestProcessor)`](#module_electron-publish/out/gitHubPublisher.GitHubPublisher+doUpload) ⇒ Promise + * [`.upload(file, safeArtifactName)`](#module_electron-publish.HttpPublisher+upload) ⇒ Promise + * [`.uploadData(data, fileName)`](#module_electron-publish.HttpPublisher+uploadData) ⇒ Promise + * [`.createProgressBar(fileName, fileStat)`](#module_electron-publish.Publisher+createProgressBar) ⇒ + * [`.createReadStreamAndProgressBar(file, fileStat, progressBar, reject)`](#module_electron-publish.Publisher+createReadStreamAndProgressBar) ⇒ NodeJS:ReadableStream + + +- + + + +#### `gitHubPublisher.deleteRelease()` ⇒ Promise +**Kind**: instance method of [GitHubPublisher](#module_electron-publish/out/gitHubPublisher.GitHubPublisher) + +- + + + +#### `gitHubPublisher.getRelease()` ⇒ Promise +**Kind**: instance method of [GitHubPublisher](#module_electron-publish/out/gitHubPublisher.GitHubPublisher) + +- + + + +#### `gitHubPublisher.toString()` ⇒ string +**Kind**: instance method of [GitHubPublisher](#module_electron-publish/out/gitHubPublisher.GitHubPublisher) +**Overrides**: [toString](#module_electron-publish.Publisher+toString) + +- + + + +#### `gitHubPublisher.doUpload(fileName, dataLength, requestProcessor)` ⇒ Promise +**Kind**: instance method of [GitHubPublisher](#module_electron-publish/out/gitHubPublisher.GitHubPublisher) +**Overrides**: [doUpload](#module_electron-publish.HttpPublisher+doUpload) +**Access**: protected + +| Param | Type | +| --- | --- | +| fileName | string | +| dataLength | number | +| requestProcessor | callback | + + +- + + + +#### `gitHubPublisher.upload(file, safeArtifactName)` ⇒ Promise +**Kind**: instance method of [GitHubPublisher](#module_electron-publish/out/gitHubPublisher.GitHubPublisher) + +| Param | Type | +| --- | --- | +| file | string | +| safeArtifactName | string | + + +- + + + +#### `gitHubPublisher.uploadData(data, fileName)` ⇒ Promise +**Kind**: instance method of [GitHubPublisher](#module_electron-publish/out/gitHubPublisher.GitHubPublisher) + +| Param | Type | +| --- | --- | +| data | Buffer | +| fileName | string | + + +- + + + +#### `gitHubPublisher.createProgressBar(fileName, fileStat)` ⇒ +**Kind**: instance method of [GitHubPublisher](#module_electron-publish/out/gitHubPublisher.GitHubPublisher) +**Access**: protected + +| Param | Type | +| --- | --- | +| fileName | string | +| fileStat | module:fs.Stats | + + +- + + + +#### `gitHubPublisher.createReadStreamAndProgressBar(file, fileStat, progressBar, reject)` ⇒ NodeJS:ReadableStream +**Kind**: instance method of [GitHubPublisher](#module_electron-publish/out/gitHubPublisher.GitHubPublisher) +**Access**: protected + +| Param | Type | +| --- | --- | +| file | string | +| fileStat | module:fs.Stats | +| progressBar | module:progress-ex.default | null | +| reject | callback | + + +- + + + +## electron-publish/out/multiProgress + +* [electron-publish/out/multiProgress](#module_electron-publish/out/multiProgress) + * [.MultiProgress](#module_electron-publish/out/multiProgress.MultiProgress) + * [`.createBar(format, options)`](#module_electron-publish/out/multiProgress.MultiProgress+createBar) ⇒ any + * [`.terminate()`](#module_electron-publish/out/multiProgress.MultiProgress+terminate) + + +- + + + +### electron-publish/out/multiProgress.MultiProgress +**Kind**: class of [electron-publish/out/multiProgress](#module_electron-publish/out/multiProgress) + +* [.MultiProgress](#module_electron-publish/out/multiProgress.MultiProgress) + * [`.createBar(format, options)`](#module_electron-publish/out/multiProgress.MultiProgress+createBar) ⇒ any + * [`.terminate()`](#module_electron-publish/out/multiProgress.MultiProgress+terminate) + + +- + + + +#### `multiProgress.createBar(format, options)` ⇒ any +**Kind**: instance method of [MultiProgress](#module_electron-publish/out/multiProgress.MultiProgress) + +| Param | Type | +| --- | --- | +| format | string | +| options | any | + + +- + + + +#### `multiProgress.terminate()` +**Kind**: instance method of [MultiProgress](#module_electron-publish/out/multiProgress.MultiProgress) + +- + + + +## electron-publish + +* [electron-publish](#module_electron-publish) + * [`.PublishContext`](#module_electron-publish.PublishContext) + * [`.PublishOptions`](#module_electron-publish.PublishOptions) + * [.HttpPublisher](#module_electron-publish.HttpPublisher) ⇐ [Publisher](#module_electron-publish.Publisher) + * [`.upload(file, safeArtifactName)`](#module_electron-publish.HttpPublisher+upload) ⇒ Promise + * [`.uploadData(data, fileName)`](#module_electron-publish.HttpPublisher+uploadData) ⇒ Promise + * [`.doUpload(fileName, dataLength, requestProcessor, file)`](#module_electron-publish.HttpPublisher+doUpload) ⇒ Promise + * [`.toString()`](#module_electron-publish.Publisher+toString) ⇒ string + * [`.createProgressBar(fileName, fileStat)`](#module_electron-publish.Publisher+createProgressBar) ⇒ + * [`.createReadStreamAndProgressBar(file, fileStat, progressBar, reject)`](#module_electron-publish.Publisher+createReadStreamAndProgressBar) ⇒ NodeJS:ReadableStream + * [.Publisher](#module_electron-publish.Publisher) + * [`.toString()`](#module_electron-publish.Publisher+toString) ⇒ string + * [`.upload(file, safeArtifactName)`](#module_electron-publish.Publisher+upload) ⇒ Promise + * [`.createProgressBar(fileName, fileStat)`](#module_electron-publish.Publisher+createProgressBar) ⇒ + * [`.createReadStreamAndProgressBar(file, fileStat, progressBar, reject)`](#module_electron-publish.Publisher+createReadStreamAndProgressBar) ⇒ NodeJS:ReadableStream + + +- + + + +### `electron-publish.PublishContext` +**Kind**: interface of [electron-publish](#module_electron-publish) +**Properties** + +| Name | Type | +| --- | --- | +| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | +| progress | [MultiProgress](#module_electron-publish/out/multiProgress.MultiProgress) | null | + + +- + + + +### `electron-publish.PublishOptions` +**Kind**: interface of [electron-publish](#module_electron-publish) +**Properties** + +| Name | Type | +| --- | --- | +| publish | "onTag" | "onTagOrDraft" | "always" | "never" | null | +| draft | boolean | +| prerelease | boolean | + + +- + + + +### electron-publish.HttpPublisher ⇐ [Publisher](#module_electron-publish.Publisher) +**Kind**: class of [electron-publish](#module_electron-publish) +**Extends**: [Publisher](#module_electron-publish.Publisher) + +* [.HttpPublisher](#module_electron-publish.HttpPublisher) ⇐ [Publisher](#module_electron-publish.Publisher) + * [`.upload(file, safeArtifactName)`](#module_electron-publish.HttpPublisher+upload) ⇒ Promise + * [`.uploadData(data, fileName)`](#module_electron-publish.HttpPublisher+uploadData) ⇒ Promise + * [`.doUpload(fileName, dataLength, requestProcessor, file)`](#module_electron-publish.HttpPublisher+doUpload) ⇒ Promise + * [`.toString()`](#module_electron-publish.Publisher+toString) ⇒ string + * [`.createProgressBar(fileName, fileStat)`](#module_electron-publish.Publisher+createProgressBar) ⇒ + * [`.createReadStreamAndProgressBar(file, fileStat, progressBar, reject)`](#module_electron-publish.Publisher+createReadStreamAndProgressBar) ⇒ NodeJS:ReadableStream + + +- + + + +#### `httpPublisher.upload(file, safeArtifactName)` ⇒ Promise +**Kind**: instance method of [HttpPublisher](#module_electron-publish.HttpPublisher) +**Overrides**: [upload](#module_electron-publish.Publisher+upload) + +| Param | Type | +| --- | --- | +| file | string | +| safeArtifactName | string | + + +- + + + +#### `httpPublisher.uploadData(data, fileName)` ⇒ Promise +**Kind**: instance method of [HttpPublisher](#module_electron-publish.HttpPublisher) + +| Param | Type | +| --- | --- | +| data | Buffer | +| fileName | string | + + +- + + + +#### `httpPublisher.doUpload(fileName, dataLength, requestProcessor, file)` ⇒ Promise +**Kind**: instance method of [HttpPublisher](#module_electron-publish.HttpPublisher) +**Access**: protected + +| Param | Type | +| --- | --- | +| fileName | string | +| dataLength | number | +| requestProcessor | callback | +| file | string | + + +- + + + +#### `httpPublisher.toString()` ⇒ string +**Kind**: instance method of [HttpPublisher](#module_electron-publish.HttpPublisher) + +- + + + +#### `httpPublisher.createProgressBar(fileName, fileStat)` ⇒ +**Kind**: instance method of [HttpPublisher](#module_electron-publish.HttpPublisher) +**Access**: protected + +| Param | Type | +| --- | --- | +| fileName | string | +| fileStat | module:fs.Stats | + + +- + + + +#### `httpPublisher.createReadStreamAndProgressBar(file, fileStat, progressBar, reject)` ⇒ NodeJS:ReadableStream +**Kind**: instance method of [HttpPublisher](#module_electron-publish.HttpPublisher) +**Access**: protected + +| Param | Type | +| --- | --- | +| file | string | +| fileStat | module:fs.Stats | +| progressBar | module:progress-ex.default | null | +| reject | callback | + + +- + + + +### electron-publish.Publisher +**Kind**: class of [electron-publish](#module_electron-publish) + +* [.Publisher](#module_electron-publish.Publisher) + * [`.toString()`](#module_electron-publish.Publisher+toString) ⇒ string + * [`.upload(file, safeArtifactName)`](#module_electron-publish.Publisher+upload) ⇒ Promise + * [`.createProgressBar(fileName, fileStat)`](#module_electron-publish.Publisher+createProgressBar) ⇒ + * [`.createReadStreamAndProgressBar(file, fileStat, progressBar, reject)`](#module_electron-publish.Publisher+createReadStreamAndProgressBar) ⇒ NodeJS:ReadableStream + + +- + + + +#### `publisher.toString()` ⇒ string +**Kind**: instance method of [Publisher](#module_electron-publish.Publisher) + +- + + + +#### `publisher.upload(file, safeArtifactName)` ⇒ Promise +**Kind**: instance method of [Publisher](#module_electron-publish.Publisher) + +| Param | Type | +| --- | --- | +| file | string | +| safeArtifactName | string | + + +- + + + +#### `publisher.createProgressBar(fileName, fileStat)` ⇒ +**Kind**: instance method of [Publisher](#module_electron-publish.Publisher) +**Access**: protected + +| Param | Type | +| --- | --- | +| fileName | string | +| fileStat | module:fs.Stats | + + +- + + + +#### `publisher.createReadStreamAndProgressBar(file, fileStat, progressBar, reject)` ⇒ NodeJS:ReadableStream +**Kind**: instance method of [Publisher](#module_electron-publish.Publisher) +**Access**: protected + +| Param | Type | +| --- | --- | +| file | string | +| fileStat | module:fs.Stats | +| progressBar | module:progress-ex.default | null | +| reject | callback | + + +- + + + +## electron-builder-http/out/CancellationToken + +* [electron-builder-http/out/CancellationToken](#module_electron-builder-http/out/CancellationToken) + * [.CancellationError](#module_electron-builder-http/out/CancellationToken.CancellationError) ⇐ Error + * [.CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) ⇐ internal:EventEmitter + * [`.cancel()`](#module_electron-builder-http/out/CancellationToken.CancellationToken+cancel) + * [`.createPromise(callback)`](#module_electron-builder-http/out/CancellationToken.CancellationToken+createPromise) ⇒ Promise + * [`.dispose()`](#module_electron-builder-http/out/CancellationToken.CancellationToken+dispose) + + +- + + + +### electron-builder-http/out/CancellationToken.CancellationError ⇐ Error +**Kind**: class of [electron-builder-http/out/CancellationToken](#module_electron-builder-http/out/CancellationToken) +**Extends**: Error + +- + + + +### electron-builder-http/out/CancellationToken.CancellationToken ⇐ internal:EventEmitter +**Kind**: class of [electron-builder-http/out/CancellationToken](#module_electron-builder-http/out/CancellationToken) +**Extends**: internal:EventEmitter + +* [.CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) ⇐ internal:EventEmitter + * [`.cancel()`](#module_electron-builder-http/out/CancellationToken.CancellationToken+cancel) + * [`.createPromise(callback)`](#module_electron-builder-http/out/CancellationToken.CancellationToken+createPromise) ⇒ Promise + * [`.dispose()`](#module_electron-builder-http/out/CancellationToken.CancellationToken+dispose) + + +- + + + +#### `cancellationToken.cancel()` +**Kind**: instance method of [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) + +- + + + +#### `cancellationToken.createPromise(callback)` ⇒ Promise +**Kind**: instance method of [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) + +| Param | Type | +| --- | --- | +| callback | callback | + + +- + + + +#### `cancellationToken.dispose()` **Kind**: instance method of [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) +- + + + +## electron-builder-http/out/ProgressCallbackTransform + +* [electron-builder-http/out/ProgressCallbackTransform](#module_electron-builder-http/out/ProgressCallbackTransform) + * [`.ProgressInfo`](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressInfo) + * [.ProgressCallbackTransform](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform) ⇐ internal:Transform + * [`._flush(callback)`](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform+_flush) + * [`._transform(chunk, encoding, callback)`](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform+_transform) + + +- + + + +### `electron-builder-http/out/ProgressCallbackTransform.ProgressInfo` +**Kind**: interface of [electron-builder-http/out/ProgressCallbackTransform](#module_electron-builder-http/out/ProgressCallbackTransform) +**Properties** + +| Name | Type | +| --- | --- | +| total | number | +| delta | number | +| transferred | number | +| percent | number | +| bytesPerSecond | number | + + +- + + + +### electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform ⇐ internal:Transform +**Kind**: class of [electron-builder-http/out/ProgressCallbackTransform](#module_electron-builder-http/out/ProgressCallbackTransform) +**Extends**: internal:Transform + +* [.ProgressCallbackTransform](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform) ⇐ internal:Transform + * [`._flush(callback)`](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform+_flush) + * [`._transform(chunk, encoding, callback)`](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform+_transform) + + +- + + + +#### `progressCallbackTransform._flush(callback)` +**Kind**: instance method of [ProgressCallbackTransform](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform) + +| Param | Type | +| --- | --- | +| callback | function | + + +- + + + +#### `progressCallbackTransform._transform(chunk, encoding, callback)` +**Kind**: instance method of [ProgressCallbackTransform](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform) + +| Param | Type | +| --- | --- | +| chunk | any | +| encoding | string | +| callback | function | + + +- + + + +## electron-builder-http/out/bintray + +* [electron-builder-http/out/bintray](#module_electron-builder-http/out/bintray) + * [`.File`](#module_electron-builder-http/out/bintray.File) + * [`.Version`](#module_electron-builder-http/out/bintray.Version) + * [.BintrayClient](#module_electron-builder-http/out/bintray.BintrayClient) + * [`.createVersion(version)`](#module_electron-builder-http/out/bintray.BintrayClient+createVersion) ⇒ Promise + * [`.deleteVersion(version)`](#module_electron-builder-http/out/bintray.BintrayClient+deleteVersion) ⇒ Promise + * [`.getVersion(version)`](#module_electron-builder-http/out/bintray.BintrayClient+getVersion) ⇒ Promise + * [`.getVersionFiles(version)`](#module_electron-builder-http/out/bintray.BintrayClient+getVersionFiles) ⇒ Promise + * [`.bintrayRequest(path, auth, data, cancellationToken, method)`](#module_electron-builder-http/out/bintray.bintrayRequest) ⇒ Promise + + +- + + + +### `electron-builder-http/out/bintray.File` +**Kind**: interface of [electron-builder-http/out/bintray](#module_electron-builder-http/out/bintray) +**Properties** + +| Name | Type | +| --- | --- | +| name | string | +| path | string | +| sha1 | string | +| sha256 | string | + + +- + + + +### `electron-builder-http/out/bintray.Version` +**Kind**: interface of [electron-builder-http/out/bintray](#module_electron-builder-http/out/bintray) +**Properties** + +| Name | Type | +| --- | --- | +| name | string | +| package | string | + + +- + + + +### electron-builder-http/out/bintray.BintrayClient +**Kind**: class of [electron-builder-http/out/bintray](#module_electron-builder-http/out/bintray) + +* [.BintrayClient](#module_electron-builder-http/out/bintray.BintrayClient) + * [`.createVersion(version)`](#module_electron-builder-http/out/bintray.BintrayClient+createVersion) ⇒ Promise + * [`.deleteVersion(version)`](#module_electron-builder-http/out/bintray.BintrayClient+deleteVersion) ⇒ Promise + * [`.getVersion(version)`](#module_electron-builder-http/out/bintray.BintrayClient+getVersion) ⇒ Promise + * [`.getVersionFiles(version)`](#module_electron-builder-http/out/bintray.BintrayClient+getVersionFiles) ⇒ Promise + + +- + + + +#### `bintrayClient.createVersion(version)` ⇒ Promise +**Kind**: instance method of [BintrayClient](#module_electron-builder-http/out/bintray.BintrayClient) + +| Param | Type | +| --- | --- | +| version | string | + + +- + + + +#### `bintrayClient.deleteVersion(version)` ⇒ Promise +**Kind**: instance method of [BintrayClient](#module_electron-builder-http/out/bintray.BintrayClient) + +| Param | Type | +| --- | --- | +| version | string | + + +- + + + +#### `bintrayClient.getVersion(version)` ⇒ Promise +**Kind**: instance method of [BintrayClient](#module_electron-builder-http/out/bintray.BintrayClient) + +| Param | Type | +| --- | --- | +| version | string | + + +- + + + +#### `bintrayClient.getVersionFiles(version)` ⇒ Promise +**Kind**: instance method of [BintrayClient](#module_electron-builder-http/out/bintray.BintrayClient) + +| Param | Type | +| --- | --- | +| version | string | + + +- + + + +### `electron-builder-http/out/bintray.bintrayRequest(path, auth, data, cancellationToken, method)` ⇒ Promise +**Kind**: method of [electron-builder-http/out/bintray](#module_electron-builder-http/out/bintray) + +| Param | Type | +| --- | --- | +| path | string | +| auth | string | null | +| data | module:electron-builder-http/out/bintray.__type | null | +| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | +| method | "GET" | "DELETE" | "PUT" | + + +- + + + +## electron-builder-http/out/publishOptions + +* [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) + * [`.BintrayOptions`](#module_electron-builder-http/out/publishOptions.BintrayOptions) ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) + * [`.GenericServerOptions`](#module_electron-builder-http/out/publishOptions.GenericServerOptions) ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) + * [`.GithubOptions`](#module_electron-builder-http/out/publishOptions.GithubOptions) ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) + * [`.PublishConfiguration`](#module_electron-builder-http/out/publishOptions.PublishConfiguration) + * [`.S3Options`](#module_electron-builder-http/out/publishOptions.S3Options) ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) + * [`.UpdateInfo`](#module_electron-builder-http/out/publishOptions.UpdateInfo) ⇐ [VersionInfo](#module_electron-builder-http/out/publishOptions.VersionInfo) + * [`.VersionInfo`](#module_electron-builder-http/out/publishOptions.VersionInfo) + * [`.githubUrl(options)`](#module_electron-builder-http/out/publishOptions.githubUrl) ⇒ string + * [`.s3Url(options)`](#module_electron-builder-http/out/publishOptions.s3Url) ⇒ string + + +- + + + +### `electron-builder-http/out/publishOptions.BintrayOptions` ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) +Bintray options. + +**Kind**: interface of [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) +**Extends**: [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) +**Properties** + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| package | string | null | | The Bintray package name. | +| repo | string | null | "generic" | The Bintray repository name. | +| user | string | null | | The Bintray user account. Used in cases where the owner is an organization. | + + +- + + + +### `electron-builder-http/out/publishOptions.GenericServerOptions` ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) +Generic (any HTTP(S) server) options. + +**Kind**: interface of [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) +**Extends**: [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) +**Properties** + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| url | string | | The base url. e.g. `https://bucket_name.s3.amazonaws.com`. You can use `${os}` (expanded to `mac`, `linux` or `win` according to target platform) and `${arch}` macros. | +| channel | string | null | "latest" | The channel. | + + +- + + + +### `electron-builder-http/out/publishOptions.GithubOptions` ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) +GitHub options. + +**Kind**: interface of [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) +**Extends**: [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) +**Properties** + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| repo | string | null | | The repository name. [Detected automatically](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts#github-repository). | +| vPrefixedTagName | boolean | true | Whether to use `v`-prefixed tag name. | +| host | string | null | "github.com" | The host (including the port if need). | +| protocol | "https" | "http" | null | https | The protocol. GitHub Publisher supports only `https`. | + + +- + + + +### `electron-builder-http/out/publishOptions.PublishConfiguration` +Can be specified in the [config](https://github.com/electron-userland/electron-builder/wiki/Options#configuration-options) or any platform- or target- specific options. + +If `GH_TOKEN` is set — defaults to `[{provider: "github"}]`. + +If `BT_TOKEN` is set and `GH_TOKEN` is not set — defaults to `[{provider: "bintray"}]`. + +**Kind**: interface of [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) +**Properties** + +| Name | Type | Description | +| --- | --- | --- | +| provider | "github" | "bintray" | "s3" | "generic" | The provider. | +| owner | string | null | The owner. | +| token | string | null | | + + +- + + + +### `electron-builder-http/out/publishOptions.S3Options` ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) +Amazon S3 options. `https` must be used, so, if you use direct Amazon S3 endpoints, format `https://s3.amazonaws.com/bucket_name` [must be used](http://stackoverflow.com/a/11203685/1910191). And do not forget to make files/directories public. + +**Kind**: interface of [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) +**Extends**: [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) +**See**: [Getting your credentials](http://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/getting-your-credentials.html). +**Properties** + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| bucket | string | | The bucket name. | +| path | string | null | "/" | The directory path. | +| channel | string | null | "latest" | The channel. | +| acl | "private" | "public-read" | null | public-read | The ACL. | +| storageClass | "STANDARD" | "REDUCED_REDUNDANCY" | "STANDARD_IA" | null | STANDARD | The type of storage to use for the object. | + + +- + + + +### `electron-builder-http/out/publishOptions.UpdateInfo` ⇐ [VersionInfo](#module_electron-builder-http/out/publishOptions.VersionInfo) +**Kind**: interface of [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) +**Extends**: [VersionInfo](#module_electron-builder-http/out/publishOptions.VersionInfo) +**Properties** + +| Name | Type | +| --- | --- | +| path | string | +| githubArtifactName | string | null | +| sha2 | string | +| releaseName | string | null | +| releaseNotes | string | null | +| releaseDate | string | + + +- + + + +### `electron-builder-http/out/publishOptions.VersionInfo` +**Kind**: interface of [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) +**Properties** + +| Name | Type | +| --- | --- | +| version | string | + + +- + + + +### `electron-builder-http/out/publishOptions.githubUrl(options)` ⇒ string +**Kind**: method of [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) + +| Param | Type | +| --- | --- | +| options | [GithubOptions](#module_electron-builder-http/out/publishOptions.GithubOptions) | + + +- + + + +### `electron-builder-http/out/publishOptions.s3Url(options)` ⇒ string +**Kind**: method of [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) + +| Param | Type | +| --- | --- | +| options | [S3Options](#module_electron-builder-http/out/publishOptions.S3Options) | + + +- + + + +## electron-builder-http + +* [electron-builder-http](#module_electron-builder-http) + * [`.DownloadOptions`](#module_electron-builder-http.DownloadOptions) + * [`.onProgress(progress)`](#module_electron-builder-http.DownloadOptions+onProgress) + * [`.RequestHeaders`](#module_electron-builder-http.RequestHeaders) + * [`.Response`](#module_electron-builder-http.Response) ⇐ internal:EventEmitter + * [`.setEncoding(encoding)`](#module_electron-builder-http.Response+setEncoding) + * [.HttpError](#module_electron-builder-http.HttpError) ⇐ Error + * [.HttpExecutor](#module_electron-builder-http.HttpExecutor) + * [`.download(url, destination, options)`](#module_electron-builder-http.HttpExecutor+download) ⇒ Promise + * [`.request(options, cancellationToken, data)`](#module_electron-builder-http.HttpExecutor+request) ⇒ Promise + * [`.addTimeOutHandler(request, callback)`](#module_electron-builder-http.HttpExecutor+addTimeOutHandler) + * [`.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)`](#module_electron-builder-http.HttpExecutor+doApiRequest) ⇒ Promise + * [`.doDownload(requestOptions, destination, redirectCount, options, callback, onCancel)`](#module_electron-builder-http.HttpExecutor+doDownload) + * [`.doRequest(options, callback)`](#module_electron-builder-http.HttpExecutor+doRequest) ⇒ any + * [`.handleResponse(response, options, cancellationToken, resolve, reject, redirectCount, requestProcessor)`](#module_electron-builder-http.HttpExecutor+handleResponse) + * [.HttpExecutorHolder](#module_electron-builder-http.HttpExecutorHolder) + * [`.configureRequestOptions(options, token, method)`](#module_electron-builder-http.configureRequestOptions) ⇒ module:http.RequestOptions + * [`.download(url, destination, options)`](#module_electron-builder-http.download) ⇒ Promise + * [`.dumpRequestOptions(options)`](#module_electron-builder-http.dumpRequestOptions) ⇒ string + * [`.request(options, cancellationToken, data)`](#module_electron-builder-http.request) ⇒ Promise + + +- + + + +### `electron-builder-http.DownloadOptions` +**Kind**: interface of [electron-builder-http](#module_electron-builder-http) +**Properties** + +| Name | Type | +| --- | --- | +| headers | [RequestHeaders](#module_electron-builder-http.RequestHeaders) | null | +| skipDirCreation | boolean | +| sha2 | string | null | +| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | + + +- + + + +#### `downloadOptions.onProgress(progress)` +**Kind**: instance method of [DownloadOptions](#module_electron-builder-http.DownloadOptions) + +| Param | Type | +| --- | --- | +| progress | [ProgressInfo](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressInfo) | + + +- + + + +### `electron-builder-http.RequestHeaders` +**Kind**: interface of [electron-builder-http](#module_electron-builder-http) + +- + + + +### `electron-builder-http.Response` ⇐ internal:EventEmitter +**Kind**: interface of [electron-builder-http](#module_electron-builder-http) +**Extends**: internal:EventEmitter +**Properties** + +| Name | Type | +| --- | --- | +| statusCode | number | +| statusMessage | string | +| headers | any | + + +- + + + +#### `response.setEncoding(encoding)` +**Kind**: instance method of [Response](#module_electron-builder-http.Response) + +| Param | Type | +| --- | --- | +| encoding | string | + + +- + + + +### electron-builder-http.HttpError ⇐ Error +**Kind**: class of [electron-builder-http](#module_electron-builder-http) +**Extends**: Error + +- + + + +### electron-builder-http.HttpExecutor +**Kind**: class of [electron-builder-http](#module_electron-builder-http) + +* [.HttpExecutor](#module_electron-builder-http.HttpExecutor) + * [`.download(url, destination, options)`](#module_electron-builder-http.HttpExecutor+download) ⇒ Promise + * [`.request(options, cancellationToken, data)`](#module_electron-builder-http.HttpExecutor+request) ⇒ Promise + * [`.addTimeOutHandler(request, callback)`](#module_electron-builder-http.HttpExecutor+addTimeOutHandler) + * [`.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)`](#module_electron-builder-http.HttpExecutor+doApiRequest) ⇒ Promise + * [`.doDownload(requestOptions, destination, redirectCount, options, callback, onCancel)`](#module_electron-builder-http.HttpExecutor+doDownload) + * [`.doRequest(options, callback)`](#module_electron-builder-http.HttpExecutor+doRequest) ⇒ any + * [`.handleResponse(response, options, cancellationToken, resolve, reject, redirectCount, requestProcessor)`](#module_electron-builder-http.HttpExecutor+handleResponse) + + +- + + + +#### `httpExecutor.download(url, destination, options)` ⇒ Promise +**Kind**: instance method of [HttpExecutor](#module_electron-builder-http.HttpExecutor) + +| Param | Type | +| --- | --- | +| url | string | +| destination | string | +| options | [DownloadOptions](#module_electron-builder-http.DownloadOptions) | + + +- + + + +#### `httpExecutor.request(options, cancellationToken, data)` ⇒ Promise +**Kind**: instance method of [HttpExecutor](#module_electron-builder-http.HttpExecutor) + +| Param | Type | +| --- | --- | +| options | module:http.RequestOptions | +| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | +| data | module:electron-builder-http.__type | null | + + +- + + + +#### `httpExecutor.addTimeOutHandler(request, callback)` +**Kind**: instance method of [HttpExecutor](#module_electron-builder-http.HttpExecutor) +**Access**: protected + +| Param | Type | +| --- | --- | +| request | any | +| callback | callback | + + +- + + + +#### `httpExecutor.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)` ⇒ Promise +**Kind**: instance method of [HttpExecutor](#module_electron-builder-http.HttpExecutor) +**Access**: protected + +| Param | Type | +| --- | --- | +| options | module:electron-builder-http.REQUEST_OPTS | +| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | +| requestProcessor | callback | +| redirectCount | number | + + +- + + + +#### `httpExecutor.doDownload(requestOptions, destination, redirectCount, options, callback, onCancel)` +**Kind**: instance method of [HttpExecutor](#module_electron-builder-http.HttpExecutor) +**Access**: protected + +| Param | Type | +| --- | --- | +| requestOptions | any | +| destination | string | +| redirectCount | number | +| options | [DownloadOptions](#module_electron-builder-http.DownloadOptions) | +| callback | callback | +| onCancel | callback | + + +- + + + +#### `httpExecutor.doRequest(options, callback)` ⇒ any +**Kind**: instance method of [HttpExecutor](#module_electron-builder-http.HttpExecutor) +**Access**: protected + +| Param | Type | +| --- | --- | +| options | any | +| callback | callback | + + +- + + + +#### `httpExecutor.handleResponse(response, options, cancellationToken, resolve, reject, redirectCount, requestProcessor)` +**Kind**: instance method of [HttpExecutor](#module_electron-builder-http.HttpExecutor) +**Access**: protected + +| Param | Type | +| --- | --- | +| response | [Response](#module_electron-builder-http.Response) | +| options | module:http.RequestOptions | +| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | +| resolve | callback | +| reject | callback | +| redirectCount | number | +| requestProcessor | callback | + + +- + + + +### electron-builder-http.HttpExecutorHolder +**Kind**: class of [electron-builder-http](#module_electron-builder-http) + +- + + + +### `electron-builder-http.configureRequestOptions(options, token, method)` ⇒ module:http.RequestOptions +**Kind**: method of [electron-builder-http](#module_electron-builder-http) + +| Param | Type | +| --- | --- | +| options | module:http.RequestOptions | +| token | string | null | +| method | "GET" | "DELETE" | "PUT" | + + +- + + + +### `electron-builder-http.download(url, destination, options)` ⇒ Promise +**Kind**: method of [electron-builder-http](#module_electron-builder-http) + +| Param | Type | +| --- | --- | +| url | string | +| destination | string | +| options | [DownloadOptions](#module_electron-builder-http.DownloadOptions) | null | + + +- + + + +### `electron-builder-http.dumpRequestOptions(options)` ⇒ string +**Kind**: method of [electron-builder-http](#module_electron-builder-http) + +| Param | Type | +| --- | --- | +| options | module:http.RequestOptions | + + +- + + + +### `electron-builder-http.request(options, cancellationToken, data)` ⇒ Promise +**Kind**: method of [electron-builder-http](#module_electron-builder-http) + +| Param | Type | +| --- | --- | +| options | module:http.RequestOptions | +| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | +| data | module:electron-builder-http.__type | null | + + +- + + + +## electron-builder-util/out/binDownload + +* [electron-builder-util/out/binDownload](#module_electron-builder-util/out/binDownload) + * [`.getBin(name, dirName, url, sha2)`](#module_electron-builder-util/out/binDownload.getBin) ⇒ Promise + * [`.getBinFromBintray(name, version, sha2)`](#module_electron-builder-util/out/binDownload.getBinFromBintray) ⇒ Promise + + +- + + + +### `electron-builder-util/out/binDownload.getBin(name, dirName, url, sha2)` ⇒ Promise +**Kind**: method of [electron-builder-util/out/binDownload](#module_electron-builder-util/out/binDownload) + | Param | Type | | --- | --- | -| callback | callback | +| name | string | +| dirName | string | +| url | string | +| sha2 | string | - - + + +### `electron-builder-util/out/binDownload.getBinFromBintray(name, version, sha2)` ⇒ Promise +**Kind**: method of [electron-builder-util/out/binDownload](#module_electron-builder-util/out/binDownload) + +| Param | Type | +| --- | --- | +| name | string | +| version | string | +| sha2 | string | -#### `cancellationToken.dispose()` -**Kind**: instance method of [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) - - + -### electron-builder-http/out/CancellationToken.CancellationError ⇐ Error -**Kind**: class of [electron-builder-http/out/CancellationToken](#module_electron-builder-http/out/CancellationToken) -**Extends**: Error +## electron-builder-util/out/deepAssign - - + -## electron-builder-http/out/ProgressCallbackTransform +### `electron-builder-util/out/deepAssign.deepAssign(target, objects)` ⇒ any +**Kind**: method of [electron-builder-util/out/deepAssign](#module_electron-builder-util/out/deepAssign) -* [electron-builder-http/out/ProgressCallbackTransform](#module_electron-builder-http/out/ProgressCallbackTransform) - * [`.ProgressInfo`](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressInfo) - * [.ProgressCallbackTransform](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform) ⇐ internal:Transform - * [`._flush(callback)`](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform+_flush) - * [`._transform(chunk, encoding, callback)`](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform+_transform) +| Param | Type | +| --- | --- | +| target | any | +| objects | Array | - - + -### `electron-builder-http/out/ProgressCallbackTransform.ProgressInfo` -**Kind**: interface of [electron-builder-http/out/ProgressCallbackTransform](#module_electron-builder-http/out/ProgressCallbackTransform) -**Properties** +## electron-builder-util/out/fs -| Name | Type | +* [electron-builder-util/out/fs](#module_electron-builder-util/out/fs) + * [.FileCopier](#module_electron-builder-util/out/fs.FileCopier) + * [`.copy(src, dest, stat)`](#module_electron-builder-util/out/fs.FileCopier+copy) ⇒ Promise + * [`.copyDir(src, destination, filter, isUseHardLink)`](#module_electron-builder-util/out/fs.copyDir) ⇒ Promise + * [`.copyFile(src, dest, stats, isUseHardLink)`](#module_electron-builder-util/out/fs.copyFile) ⇒ Promise + * [`.exists(file)`](#module_electron-builder-util/out/fs.exists) ⇒ Promise + * [`.statOrNull(file)`](#module_electron-builder-util/out/fs.statOrNull) ⇒ Promise + * [`.unlinkIfExists(file)`](#module_electron-builder-util/out/fs.unlinkIfExists) ⇒ Promise + * [`.walk(initialDirPath, filter, consumer)`](#module_electron-builder-util/out/fs.walk) ⇒ Promise + + +- + + + +### electron-builder-util/out/fs.FileCopier +**Kind**: class of [electron-builder-util/out/fs](#module_electron-builder-util/out/fs) + +- + + + +#### `fileCopier.copy(src, dest, stat)` ⇒ Promise +**Kind**: instance method of [FileCopier](#module_electron-builder-util/out/fs.FileCopier) + +| Param | Type | | --- | --- | -| total | number | -| delta | number | -| transferred | number | -| percent | number | -| bytesPerSecond | number | +| src | string | +| dest | string | +| stat | module:fs.Stats | undefined | - - + -### electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform ⇐ internal:Transform -**Kind**: class of [electron-builder-http/out/ProgressCallbackTransform](#module_electron-builder-http/out/ProgressCallbackTransform) -**Extends**: internal:Transform +### `electron-builder-util/out/fs.copyDir(src, destination, filter, isUseHardLink)` ⇒ Promise +Empty directories is never created. +Hard links is used if supported and allowed. -* [.ProgressCallbackTransform](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform) ⇐ internal:Transform - * [`._flush(callback)`](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform+_flush) - * [`._transform(chunk, encoding, callback)`](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform+_transform) +**Kind**: method of [electron-builder-util/out/fs](#module_electron-builder-util/out/fs) + +| Param | Type | +| --- | --- | +| src | string | +| destination | string | +| filter | module:electron-builder-util/out/fs.__type | +| isUseHardLink | callback | - - + -#### `progressCallbackTransform._flush(callback)` -**Kind**: instance method of [ProgressCallbackTransform](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform) +### `electron-builder-util/out/fs.copyFile(src, dest, stats, isUseHardLink)` ⇒ Promise +Hard links is used if supported and allowed. +File permission is fixed — allow execute for all if owner can, allow read for all if owner can. + +**Kind**: method of [electron-builder-util/out/fs](#module_electron-builder-util/out/fs) | Param | Type | | --- | --- | -| callback | function | +| src | string | +| dest | string | +| stats | module:fs.Stats | null | +| isUseHardLink | | - - + -#### `progressCallbackTransform._transform(chunk, encoding, callback)` -**Kind**: instance method of [ProgressCallbackTransform](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform) +### `electron-builder-util/out/fs.exists(file)` ⇒ Promise +**Kind**: method of [electron-builder-util/out/fs](#module_electron-builder-util/out/fs) | Param | Type | | --- | --- | -| chunk | | -| encoding | string | -| callback | function | +| file | string | - - + -## electron-builder-http/out/bintray +### `electron-builder-util/out/fs.statOrNull(file)` ⇒ Promise +**Kind**: method of [electron-builder-util/out/fs](#module_electron-builder-util/out/fs) -* [electron-builder-http/out/bintray](#module_electron-builder-http/out/bintray) - * [`.Version`](#module_electron-builder-http/out/bintray.Version) - * [`.File`](#module_electron-builder-http/out/bintray.File) - * [.BintrayClient](#module_electron-builder-http/out/bintray.BintrayClient) - * [`.createVersion(version)`](#module_electron-builder-http/out/bintray.BintrayClient+createVersion) ⇒ Promise - * [`.deleteVersion(version)`](#module_electron-builder-http/out/bintray.BintrayClient+deleteVersion) ⇒ Promise - * [`.getVersion(version)`](#module_electron-builder-http/out/bintray.BintrayClient+getVersion) ⇒ Promise - * [`.getVersionFiles(version)`](#module_electron-builder-http/out/bintray.BintrayClient+getVersionFiles) ⇒ Promise - * [`.bintrayRequest(path, auth, data, cancellationToken, method)`](#module_electron-builder-http/out/bintray.bintrayRequest) ⇒ Promise +| Param | Type | +| --- | --- | +| file | string | - - + -### `electron-builder-http/out/bintray.Version` -**Kind**: interface of [electron-builder-http/out/bintray](#module_electron-builder-http/out/bintray) -**Properties** +### `electron-builder-util/out/fs.unlinkIfExists(file)` ⇒ Promise +**Kind**: method of [electron-builder-util/out/fs](#module_electron-builder-util/out/fs) -| Name | Type | +| Param | Type | | --- | --- | -| name | string | -| package | string | +| file | string | - - + -### `electron-builder-http/out/bintray.File` -**Kind**: interface of [electron-builder-http/out/bintray](#module_electron-builder-http/out/bintray) -**Properties** +### `electron-builder-util/out/fs.walk(initialDirPath, filter, consumer)` ⇒ Promise +**Kind**: method of [electron-builder-util/out/fs](#module_electron-builder-util/out/fs) -| Name | Type | +| Param | Type | | --- | --- | -| name | string | -| path | string | -| sha1 | string | -| sha256 | string | +| initialDirPath | string | +| filter | module:electron-builder-util/out/fs.__type | null | +| consumer | callback | - - + -### electron-builder-http/out/bintray.BintrayClient -**Kind**: class of [electron-builder-http/out/bintray](#module_electron-builder-http/out/bintray) +## electron-builder-util/out/log -* [.BintrayClient](#module_electron-builder-http/out/bintray.BintrayClient) - * [`.createVersion(version)`](#module_electron-builder-http/out/bintray.BintrayClient+createVersion) ⇒ Promise - * [`.deleteVersion(version)`](#module_electron-builder-http/out/bintray.BintrayClient+deleteVersion) ⇒ Promise - * [`.getVersion(version)`](#module_electron-builder-http/out/bintray.BintrayClient+getVersion) ⇒ Promise - * [`.getVersionFiles(version)`](#module_electron-builder-http/out/bintray.BintrayClient+getVersionFiles) ⇒ Promise +* [electron-builder-util/out/log](#module_electron-builder-util/out/log) + * [`.log(message)`](#module_electron-builder-util/out/log.log) + * [`.setPrinter(value)`](#module_electron-builder-util/out/log.setPrinter) + * [`.subTask(title, promise)`](#module_electron-builder-util/out/log.subTask) ⇒ module:bluebird-lst.Bluebird + * [`.task(title, promise)`](#module_electron-builder-util/out/log.task) ⇒ module:bluebird-lst.Bluebird + * [`.warn(message)`](#module_electron-builder-util/out/log.warn) - - + -#### `bintrayClient.createVersion(version)` ⇒ Promise -**Kind**: instance method of [BintrayClient](#module_electron-builder-http/out/bintray.BintrayClient) +### `electron-builder-util/out/log.log(message)` +**Kind**: method of [electron-builder-util/out/log](#module_electron-builder-util/out/log) | Param | Type | | --- | --- | -| version | string | +| message | string | - - + -#### `bintrayClient.deleteVersion(version)` ⇒ Promise -**Kind**: instance method of [BintrayClient](#module_electron-builder-http/out/bintray.BintrayClient) +### `electron-builder-util/out/log.setPrinter(value)` +**Kind**: method of [electron-builder-util/out/log](#module_electron-builder-util/out/log) | Param | Type | | --- | --- | -| version | string | +| value | module:electron-builder-util/out/log.__type | null | - - + -#### `bintrayClient.getVersion(version)` ⇒ Promise -**Kind**: instance method of [BintrayClient](#module_electron-builder-http/out/bintray.BintrayClient) +### `electron-builder-util/out/log.subTask(title, promise)` ⇒ module:bluebird-lst.Bluebird +**Kind**: method of [electron-builder-util/out/log](#module_electron-builder-util/out/log) | Param | Type | | --- | --- | -| version | string | +| title | string | +| promise | module:bluebird-lst.Bluebird | Promise | - - + -#### `bintrayClient.getVersionFiles(version)` ⇒ Promise -**Kind**: instance method of [BintrayClient](#module_electron-builder-http/out/bintray.BintrayClient) +### `electron-builder-util/out/log.task(title, promise)` ⇒ module:bluebird-lst.Bluebird +**Kind**: method of [electron-builder-util/out/log](#module_electron-builder-util/out/log) | Param | Type | | --- | --- | -| version | string | +| title | string | +| promise | module:bluebird-lst.Bluebird | Promise | - - + -### `electron-builder-http/out/bintray.bintrayRequest(path, auth, data, cancellationToken, method)` ⇒ Promise -**Kind**: method of [electron-builder-http/out/bintray](#module_electron-builder-http/out/bintray) +### `electron-builder-util/out/log.warn(message)` +**Kind**: method of [electron-builder-util/out/log](#module_electron-builder-util/out/log) | Param | Type | | --- | --- | -| path | string | -| auth | string | null | -| data | module:electron-builder-http/out/bintray.__type | null | +| message | string | + + +- + + + +## electron-builder-util/out/nodeHttpExecutor + +* [electron-builder-util/out/nodeHttpExecutor](#module_electron-builder-util/out/nodeHttpExecutor) + * [.NodeHttpExecutor](#module_electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor) ⇐ [HttpExecutor](#module_electron-builder-http.HttpExecutor) + * [`.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)`](#module_electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor+doApiRequest) ⇒ Promise + * [`.download(url, destination, options)`](#module_electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor+download) ⇒ Promise + * [`.doRequest(options, callback)`](#module_electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor+doRequest) ⇒ any + * [`.request(options, cancellationToken, data)`](#module_electron-builder-http.HttpExecutor+request) ⇒ Promise + * [`.addTimeOutHandler(request, callback)`](#module_electron-builder-http.HttpExecutor+addTimeOutHandler) + * [`.doDownload(requestOptions, destination, redirectCount, options, callback, onCancel)`](#module_electron-builder-http.HttpExecutor+doDownload) + * [`.handleResponse(response, options, cancellationToken, resolve, reject, redirectCount, requestProcessor)`](#module_electron-builder-http.HttpExecutor+handleResponse) + * [`.httpExecutor`](#module_electron-builder-util/out/nodeHttpExecutor.httpExecutor) : [NodeHttpExecutor](#module_electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor) + + +- + + + +### electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor ⇐ [HttpExecutor](#module_electron-builder-http.HttpExecutor) +**Kind**: class of [electron-builder-util/out/nodeHttpExecutor](#module_electron-builder-util/out/nodeHttpExecutor) +**Extends**: [HttpExecutor](#module_electron-builder-http.HttpExecutor) + +* [.NodeHttpExecutor](#module_electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor) ⇐ [HttpExecutor](#module_electron-builder-http.HttpExecutor) + * [`.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)`](#module_electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor+doApiRequest) ⇒ Promise + * [`.download(url, destination, options)`](#module_electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor+download) ⇒ Promise + * [`.doRequest(options, callback)`](#module_electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor+doRequest) ⇒ any + * [`.request(options, cancellationToken, data)`](#module_electron-builder-http.HttpExecutor+request) ⇒ Promise + * [`.addTimeOutHandler(request, callback)`](#module_electron-builder-http.HttpExecutor+addTimeOutHandler) + * [`.doDownload(requestOptions, destination, redirectCount, options, callback, onCancel)`](#module_electron-builder-http.HttpExecutor+doDownload) + * [`.handleResponse(response, options, cancellationToken, resolve, reject, redirectCount, requestProcessor)`](#module_electron-builder-http.HttpExecutor+handleResponse) + + +- + + + +#### `nodeHttpExecutor.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)` ⇒ Promise +**Kind**: instance method of [NodeHttpExecutor](#module_electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor) +**Overrides**: [doApiRequest](#module_electron-builder-http.HttpExecutor+doApiRequest) + +| Param | Type | +| --- | --- | +| options | module:https.RequestOptions | | cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | -| method | "GET" | "DELETE" | "PUT" | +| requestProcessor | callback | +| redirectCount | number | - - + -## electron-builder-http/out/publishOptions +#### `nodeHttpExecutor.download(url, destination, options)` ⇒ Promise +**Kind**: instance method of [NodeHttpExecutor](#module_electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor) +**Overrides**: [download](#module_electron-builder-http.HttpExecutor+download) -* [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) - * [`.PublishConfiguration`](#module_electron-builder-http/out/publishOptions.PublishConfiguration) - * [`.GenericServerOptions`](#module_electron-builder-http/out/publishOptions.GenericServerOptions) ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) - * [`.S3Options`](#module_electron-builder-http/out/publishOptions.S3Options) ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) - * [`.VersionInfo`](#module_electron-builder-http/out/publishOptions.VersionInfo) - * [`.UpdateInfo`](#module_electron-builder-http/out/publishOptions.UpdateInfo) ⇐ [VersionInfo](#module_electron-builder-http/out/publishOptions.VersionInfo) - * [`.GithubOptions`](#module_electron-builder-http/out/publishOptions.GithubOptions) ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) - * [`.BintrayOptions`](#module_electron-builder-http/out/publishOptions.BintrayOptions) ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) - * [`.s3Url(options)`](#module_electron-builder-http/out/publishOptions.s3Url) ⇒ string - * [`.githubUrl(options)`](#module_electron-builder-http/out/publishOptions.githubUrl) ⇒ string +| Param | Type | +| --- | --- | +| url | string | +| destination | string | +| options | [DownloadOptions](#module_electron-builder-http.DownloadOptions) | - - + -### `electron-builder-http/out/publishOptions.PublishConfiguration` -Can be specified in the [config](https://github.com/electron-userland/electron-builder/wiki/Options#configuration-options) or any platform- or target- specific options. +#### `nodeHttpExecutor.doRequest(options, callback)` ⇒ any +**Kind**: instance method of [NodeHttpExecutor](#module_electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor) +**Overrides**: [doRequest](#module_electron-builder-http.HttpExecutor+doRequest) +**Access**: protected -If `GH_TOKEN` is set — defaults to `[{provider: "github"}]`. +| Param | Type | +| --- | --- | +| options | any | +| callback | callback | -If `BT_TOKEN` is set and `GH_TOKEN` is not set — defaults to `[{provider: "bintray"}]`. -**Kind**: interface of [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) -**Properties** +- -| Name | Type | Description | -| --- | --- | --- | -| provider | github | bintray | s3 | generic | The provider. | -| owner | string | null | The owner. | -| token | string | null | | + + +#### `nodeHttpExecutor.request(options, cancellationToken, data)` ⇒ Promise +**Kind**: instance method of [NodeHttpExecutor](#module_electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor) + +| Param | Type | +| --- | --- | +| options | module:http.RequestOptions | +| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | +| data | module:electron-builder-http.__type | null | + + +- + + + +#### `nodeHttpExecutor.addTimeOutHandler(request, callback)` +**Kind**: instance method of [NodeHttpExecutor](#module_electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor) +**Access**: protected + +| Param | Type | +| --- | --- | +| request | any | +| callback | callback | + + +- + + + +#### `nodeHttpExecutor.doDownload(requestOptions, destination, redirectCount, options, callback, onCancel)` +**Kind**: instance method of [NodeHttpExecutor](#module_electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor) +**Access**: protected + +| Param | Type | +| --- | --- | +| requestOptions | any | +| destination | string | +| redirectCount | number | +| options | [DownloadOptions](#module_electron-builder-http.DownloadOptions) | +| callback | callback | +| onCancel | callback | + + +- + + + +#### `nodeHttpExecutor.handleResponse(response, options, cancellationToken, resolve, reject, redirectCount, requestProcessor)` +**Kind**: instance method of [NodeHttpExecutor](#module_electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor) +**Access**: protected + +| Param | Type | +| --- | --- | +| response | [Response](#module_electron-builder-http.Response) | +| options | module:http.RequestOptions | +| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | +| resolve | callback | +| reject | callback | +| redirectCount | number | +| requestProcessor | callback | - - + -### `electron-builder-http/out/publishOptions.GenericServerOptions` ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) -Generic (any HTTP(S) server) options. +### `electron-builder-util/out/nodeHttpExecutor.httpExecutor` : [NodeHttpExecutor](#module_electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor) +**Kind**: constant of [electron-builder-util/out/nodeHttpExecutor](#module_electron-builder-util/out/nodeHttpExecutor) -**Kind**: interface of [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) -**Extends**: [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) -**Properties** +- -| Name | Type | Default | Description | -| --- | --- | --- | --- | -| url | string | | The base url. e.g. `https://bucket_name.s3.amazonaws.com`. You can use `${os}` (expanded to `mac`, `linux` or `win` according to target platform) and `${arch}` macros. | -| channel | string | null | "latest" | The channel. | + + +## electron-builder-util/out/promise + +* [electron-builder-util/out/promise](#module_electron-builder-util/out/promise) + * [.NestedError](#module_electron-builder-util/out/promise.NestedError) ⇐ Error + * [`.all(promises)`](#module_electron-builder-util/out/promise.all) ⇒ module:bluebird-lst.Bluebird + * [`.executeFinally(promise, task)`](#module_electron-builder-util/out/promise.executeFinally) ⇒ Promise + * [`.printErrorAndExit(error)`](#module_electron-builder-util/out/promise.printErrorAndExit) + * [`.throwError(errors)`](#module_electron-builder-util/out/promise.throwError) - - + -### `electron-builder-http/out/publishOptions.S3Options` ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) -Amazon S3 options. `https` must be used, so, if you use direct Amazon S3 endpoints, format `https://s3.amazonaws.com/bucket_name` [must be used](http://stackoverflow.com/a/11203685/1910191). And do not forget to make files/directories public. +### electron-builder-util/out/promise.NestedError ⇐ Error +**Kind**: class of [electron-builder-util/out/promise](#module_electron-builder-util/out/promise) +**Extends**: Error -**Kind**: interface of [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) -**Extends**: [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) -**See**: [Getting your credentials](http://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/getting-your-credentials.html). -**Properties** +- -| Name | Type | Default | Description | -| --- | --- | --- | --- | -| bucket | string | | The bucket name. | -| path | string | null | "/" | The directory path. | -| channel | string | null | "latest" | The channel. | -| acl | "private" | "public-read" | null | public-read | The ACL. | -| storageClass | "STANDARD" | "REDUCED_REDUNDANCY" | "STANDARD_IA" | null | STANDARD | The type of storage to use for the object. | + + +### `electron-builder-util/out/promise.all(promises)` ⇒ module:bluebird-lst.Bluebird +**Kind**: method of [electron-builder-util/out/promise](#module_electron-builder-util/out/promise) + +| Param | Type | +| --- | --- | +| promises | Array | - - + -### `electron-builder-http/out/publishOptions.VersionInfo` -**Kind**: interface of [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) -**Properties** +### `electron-builder-util/out/promise.executeFinally(promise, task)` ⇒ Promise +**Kind**: method of [electron-builder-util/out/promise](#module_electron-builder-util/out/promise) -| Name | Type | +| Param | Type | | --- | --- | -| version | string | +| promise | Promise | +| task | callback | - - + -### `electron-builder-http/out/publishOptions.UpdateInfo` ⇐ [VersionInfo](#module_electron-builder-http/out/publishOptions.VersionInfo) -**Kind**: interface of [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) -**Extends**: [VersionInfo](#module_electron-builder-http/out/publishOptions.VersionInfo) -**Properties** +### `electron-builder-util/out/promise.printErrorAndExit(error)` +**Kind**: method of [electron-builder-util/out/promise](#module_electron-builder-util/out/promise) -| Name | Type | +| Param | Type | | --- | --- | -| path | string | -| githubArtifactName | string | null | -| sha2 | string | -| releaseName | string | null | -| releaseNotes | string | null | -| releaseDate | string | +| error | Error | - - - -### `electron-builder-http/out/publishOptions.GithubOptions` ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) -GitHub options. + -**Kind**: interface of [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) -**Extends**: [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) -**Properties** +### `electron-builder-util/out/promise.throwError(errors)` +**Kind**: method of [electron-builder-util/out/promise](#module_electron-builder-util/out/promise) -| Name | Type | Default | Description | -| --- | --- | --- | --- | -| repo | string | null | | The repository name. [Detected automatically](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts#github-repository). | -| vPrefixedTagName | boolean | true | Whether to use `v`-prefixed tag name. | -| host | string | null | "github.com" | The host (including the port if need). | -| protocol | "https" | "http" | null | https | The protocol. GitHub Publisher supports only `https`. | +| Param | Type | +| --- | --- | +| errors | Array | - - - -### `electron-builder-http/out/publishOptions.BintrayOptions` ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) -### `publish` Bintray + -**Kind**: interface of [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) -**Extends**: [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) -**Properties** +## electron-builder-util/out/tmp -| Name | Type | Default | Description | -| --- | --- | --- | --- | -| package | string | null | | The Bintray package name. | -| repo | string | null | "generic" | The Bintray repository name. | -| user | string | null | | The Bintray user account. Used in cases where the owner is an organization. | +* [electron-builder-util/out/tmp](#module_electron-builder-util/out/tmp) + * [.TmpDir](#module_electron-builder-util/out/tmp.TmpDir) + * [`.cleanup()`](#module_electron-builder-util/out/tmp.TmpDir+cleanup) ⇒ Promise + * [`.getTempFile(suffix)`](#module_electron-builder-util/out/tmp.TmpDir+getTempFile) ⇒ Promise - - + -### `electron-builder-http/out/publishOptions.s3Url(options)` ⇒ string -**Kind**: method of [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) +### electron-builder-util/out/tmp.TmpDir +**Kind**: class of [electron-builder-util/out/tmp](#module_electron-builder-util/out/tmp) -| Param | Type | -| --- | --- | -| options | [S3Options](#module_electron-builder-http/out/publishOptions.S3Options) | +* [.TmpDir](#module_electron-builder-util/out/tmp.TmpDir) + * [`.cleanup()`](#module_electron-builder-util/out/tmp.TmpDir+cleanup) ⇒ Promise + * [`.getTempFile(suffix)`](#module_electron-builder-util/out/tmp.TmpDir+getTempFile) ⇒ Promise - - + -### `electron-builder-http/out/publishOptions.githubUrl(options)` ⇒ string -**Kind**: method of [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) +#### `tmpDir.cleanup()` ⇒ Promise +**Kind**: instance method of [TmpDir](#module_electron-builder-util/out/tmp.TmpDir) + +- + + + +#### `tmpDir.getTempFile(suffix)` ⇒ Promise +**Kind**: instance method of [TmpDir](#module_electron-builder-util/out/tmp.TmpDir) | Param | Type | | --- | --- | -| options | [GithubOptions](#module_electron-builder-http/out/publishOptions.GithubOptions) | +| suffix | string | - - + -## electron-builder-http +## electron-builder-util -* [electron-builder-http](#module_electron-builder-http) - * [`.RequestHeaders`](#module_electron-builder-http.RequestHeaders) - * [`.Response`](#module_electron-builder-http.Response) ⇐ internal:EventEmitter - * [`.setEncoding(encoding)`](#module_electron-builder-http.Response+setEncoding) - * [`.DownloadOptions`](#module_electron-builder-http.DownloadOptions) - * [`.onProgress(progress)`](#module_electron-builder-http.DownloadOptions+onProgress) - * [.HttpExecutorHolder](#module_electron-builder-http.HttpExecutorHolder) - * [.HttpError](#module_electron-builder-http.HttpError) ⇐ Error - * [.HttpExecutor](#module_electron-builder-http.HttpExecutor) - * [`.download(url, destination, options)`](#module_electron-builder-http.HttpExecutor+download) ⇒ Promise - * [`.request(options, cancellationToken, data)`](#module_electron-builder-http.HttpExecutor+request) ⇒ Promise - * [`.addTimeOutHandler(request, callback)`](#module_electron-builder-http.HttpExecutor+addTimeOutHandler) - * [`.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)`](#module_electron-builder-http.HttpExecutor+doApiRequest) ⇒ Promise - * [`.doDownload(requestOptions, destination, redirectCount, options, callback, onCancel)`](#module_electron-builder-http.HttpExecutor+doDownload) - * [`.doRequest(options, callback)`](#module_electron-builder-http.HttpExecutor+doRequest) ⇒ - * [`.handleResponse(response, options, cancellationToken, resolve, reject, redirectCount, requestProcessor)`](#module_electron-builder-http.HttpExecutor+handleResponse) - * [`.download(url, destination, options)`](#module_electron-builder-http.download) ⇒ Promise - * [`.request(options, cancellationToken, data)`](#module_electron-builder-http.request) ⇒ Promise - * [`.configureRequestOptions(options, token, method)`](#module_electron-builder-http.configureRequestOptions) ⇒ module:http.RequestOptions - * [`.dumpRequestOptions(options)`](#module_electron-builder-http.dumpRequestOptions) ⇒ string +* [electron-builder-util](#module_electron-builder-util) + * [`.BaseExecOptions`](#module_electron-builder-util.BaseExecOptions) + * [`.ExecOptions`](#module_electron-builder-util.ExecOptions) ⇐ [BaseExecOptions](#module_electron-builder-util.BaseExecOptions) + * [.Lazy](#module_electron-builder-util.Lazy) + * [`.addValue(map, key, value)`](#module_electron-builder-util.addValue) + * [`.asArray(v)`](#module_electron-builder-util.asArray) ⇒ Array + * [`.computeDefaultAppDirectory(projectDir, userAppDir)`](#module_electron-builder-util.computeDefaultAppDirectory) ⇒ Promise + * [`.debug7zArgs(command)`](#module_electron-builder-util.debug7zArgs) ⇒ Array + * [`.doSpawn(command, args, options, pipeInput)`](#module_electron-builder-util.doSpawn) ⇒ module:child_process.ChildProcess + * [`.exec(file, args, options)`](#module_electron-builder-util.exec) ⇒ Promise + * [`.execWine(file, args, options)`](#module_electron-builder-util.execWine) ⇒ Promise + * [`.getCacheDirectory()`](#module_electron-builder-util.getCacheDirectory) ⇒ string + * [`.getPlatformIconFileName(value, isMac)`](#module_electron-builder-util.getPlatformIconFileName) ⇒ + * [`.getTempName(prefix)`](#module_electron-builder-util.getTempName) ⇒ string + * [`.handleProcess(event, childProcess, command, resolve, reject)`](#module_electron-builder-util.handleProcess) + * [`.isEmptyOrSpaces(s)`](#module_electron-builder-util.isEmptyOrSpaces) ⇒ boolean + * [`.prepareArgs(args, exePath)`](#module_electron-builder-util.prepareArgs) ⇒ Array + * [`.removePassword(input)`](#module_electron-builder-util.removePassword) ⇒ string + * [`.replaceDefault(inList, defaultList)`](#module_electron-builder-util.replaceDefault) ⇒ Array + * [`.smarten(s)`](#module_electron-builder-util.smarten) ⇒ string + * [`.spawn(command, args, options)`](#module_electron-builder-util.spawn) ⇒ Promise + * [`.use(value, task)`](#module_electron-builder-util.use) ⇒ - - + + +### `electron-builder-util.BaseExecOptions` +**Kind**: interface of [electron-builder-util](#module_electron-builder-util) +**Properties** + +| Name | Type | +| --- | --- | +| cwd | string | +| env | any | +| stdio | any | -### `electron-builder-http.RequestHeaders` -**Kind**: interface of [electron-builder-http](#module_electron-builder-http) - - + -### `electron-builder-http.Response` ⇐ internal:EventEmitter -**Kind**: interface of [electron-builder-http](#module_electron-builder-http) -**Extends**: internal:EventEmitter +### `electron-builder-util.ExecOptions` ⇐ [BaseExecOptions](#module_electron-builder-util.BaseExecOptions) +**Kind**: interface of [electron-builder-util](#module_electron-builder-util) +**Extends**: [BaseExecOptions](#module_electron-builder-util.BaseExecOptions) **Properties** | Name | Type | | --- | --- | -| statusCode | number | -| statusMessage | string | -| headers | | +| customFds | any | +| encoding | string | +| timeout | number | +| maxBuffer | number | +| killSignal | string | - - + -#### `response.setEncoding(encoding)` -**Kind**: instance method of [Response](#module_electron-builder-http.Response) +### electron-builder-util.Lazy +**Kind**: class of [electron-builder-util](#module_electron-builder-util) + +- + + + +### `electron-builder-util.addValue(map, key, value)` +**Kind**: method of [electron-builder-util](#module_electron-builder-util) | Param | Type | | --- | --- | -| encoding | string | +| map | Map | +| key | module:electron-builder-util.K | +| value | module:electron-builder-util.T | - - + -### `electron-builder-http.DownloadOptions` -**Kind**: interface of [electron-builder-http](#module_electron-builder-http) -**Properties** +### `electron-builder-util.asArray(v)` ⇒ Array +**Kind**: method of [electron-builder-util](#module_electron-builder-util) -| Name | Type | +| Param | Type | | --- | --- | -| headers | [RequestHeaders](#module_electron-builder-http.RequestHeaders) | null | -| skipDirCreation | boolean | -| sha2 | string | null | -| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | +| v | null | undefined | module:electron-builder-util.T | Array | - - + -#### `downloadOptions.onProgress(progress)` -**Kind**: instance method of [DownloadOptions](#module_electron-builder-http.DownloadOptions) +### `electron-builder-util.computeDefaultAppDirectory(projectDir, userAppDir)` ⇒ Promise +**Kind**: method of [electron-builder-util](#module_electron-builder-util) | Param | Type | | --- | --- | -| progress | [ProgressInfo](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressInfo) | +| projectDir | string | +| userAppDir | string | null | undefined | - - + + +### `electron-builder-util.debug7zArgs(command)` ⇒ Array +**Kind**: method of [electron-builder-util](#module_electron-builder-util) + +| Param | Type | +| --- | --- | +| command | "a" | "x" | -### electron-builder-http.HttpExecutorHolder -**Kind**: class of [electron-builder-http](#module_electron-builder-http) - - + + +### `electron-builder-util.doSpawn(command, args, options, pipeInput)` ⇒ module:child_process.ChildProcess +**Kind**: method of [electron-builder-util](#module_electron-builder-util) + +| Param | Type | +| --- | --- | +| command | string | +| args | Array | +| options | module:child_process.SpawnOptions | +| pipeInput | Boolean | -### electron-builder-http.HttpError ⇐ Error -**Kind**: class of [electron-builder-http](#module_electron-builder-http) -**Extends**: Error - - + -### electron-builder-http.HttpExecutor -**Kind**: class of [electron-builder-http](#module_electron-builder-http) +### `electron-builder-util.exec(file, args, options)` ⇒ Promise +**Kind**: method of [electron-builder-util](#module_electron-builder-util) -* [.HttpExecutor](#module_electron-builder-http.HttpExecutor) - * [`.download(url, destination, options)`](#module_electron-builder-http.HttpExecutor+download) ⇒ Promise - * [`.request(options, cancellationToken, data)`](#module_electron-builder-http.HttpExecutor+request) ⇒ Promise - * [`.addTimeOutHandler(request, callback)`](#module_electron-builder-http.HttpExecutor+addTimeOutHandler) - * [`.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)`](#module_electron-builder-http.HttpExecutor+doApiRequest) ⇒ Promise - * [`.doDownload(requestOptions, destination, redirectCount, options, callback, onCancel)`](#module_electron-builder-http.HttpExecutor+doDownload) - * [`.doRequest(options, callback)`](#module_electron-builder-http.HttpExecutor+doRequest) ⇒ - * [`.handleResponse(response, options, cancellationToken, resolve, reject, redirectCount, requestProcessor)`](#module_electron-builder-http.HttpExecutor+handleResponse) +| Param | Type | +| --- | --- | +| file | string | +| args | Array | null | +| options | [ExecOptions](#module_electron-builder-util.ExecOptions) | - - + -#### `httpExecutor.download(url, destination, options)` ⇒ Promise -**Kind**: instance method of [HttpExecutor](#module_electron-builder-http.HttpExecutor) +### `electron-builder-util.execWine(file, args, options)` ⇒ Promise +**Kind**: method of [electron-builder-util](#module_electron-builder-util) | Param | Type | | --- | --- | -| url | string | -| destination | string | -| options | [DownloadOptions](#module_electron-builder-http.DownloadOptions) | +| file | string | +| args | Array | +| options | [ExecOptions](#module_electron-builder-util.ExecOptions) | - - + -#### `httpExecutor.request(options, cancellationToken, data)` ⇒ Promise -**Kind**: instance method of [HttpExecutor](#module_electron-builder-http.HttpExecutor) +### `electron-builder-util.getCacheDirectory()` ⇒ string +**Kind**: method of [electron-builder-util](#module_electron-builder-util) + +- + + + +### `electron-builder-util.getPlatformIconFileName(value, isMac)` ⇒ +**Kind**: method of [electron-builder-util](#module_electron-builder-util) | Param | Type | | --- | --- | -| options | module:http.RequestOptions | -| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | -| data | module:electron-builder-http.__type | null | +| value | string | null | undefined | +| isMac | boolean | - - + -#### `httpExecutor.addTimeOutHandler(request, callback)` -**Kind**: instance method of [HttpExecutor](#module_electron-builder-http.HttpExecutor) -**Access**: protected +### `electron-builder-util.getTempName(prefix)` ⇒ string +**Kind**: method of [electron-builder-util](#module_electron-builder-util) | Param | Type | | --- | --- | -| request | | -| callback | callback | +| prefix | string | null | undefined | - - + -#### `httpExecutor.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)` ⇒ Promise -**Kind**: instance method of [HttpExecutor](#module_electron-builder-http.HttpExecutor) -**Access**: protected +### `electron-builder-util.handleProcess(event, childProcess, command, resolve, reject)` +**Kind**: method of [electron-builder-util](#module_electron-builder-util) | Param | Type | | --- | --- | -| options | module:electron-builder-http.REQUEST_OPTS | -| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | -| requestProcessor | callback | -| redirectCount | number | +| event | string | +| childProcess | module:child_process.ChildProcess | +| command | string | +| resolve | module:electron-builder-util.__type | null | +| reject | callback | - - + -#### `httpExecutor.doDownload(requestOptions, destination, redirectCount, options, callback, onCancel)` -**Kind**: instance method of [HttpExecutor](#module_electron-builder-http.HttpExecutor) -**Access**: protected +### `electron-builder-util.isEmptyOrSpaces(s)` ⇒ boolean +**Kind**: method of [electron-builder-util](#module_electron-builder-util) | Param | Type | | --- | --- | -| requestOptions | | -| destination | string | -| redirectCount | number | -| options | [DownloadOptions](#module_electron-builder-http.DownloadOptions) | -| callback | callback | -| onCancel | callback | +| s | string | null | undefined | - - + -#### `httpExecutor.doRequest(options, callback)` ⇒ -**Kind**: instance method of [HttpExecutor](#module_electron-builder-http.HttpExecutor) -**Access**: protected +### `electron-builder-util.prepareArgs(args, exePath)` ⇒ Array +**Kind**: method of [electron-builder-util](#module_electron-builder-util) | Param | Type | | --- | --- | -| options | | -| callback | callback | +| args | Array | +| exePath | string | - - + -#### `httpExecutor.handleResponse(response, options, cancellationToken, resolve, reject, redirectCount, requestProcessor)` -**Kind**: instance method of [HttpExecutor](#module_electron-builder-http.HttpExecutor) -**Access**: protected +### `electron-builder-util.removePassword(input)` ⇒ string +**Kind**: method of [electron-builder-util](#module_electron-builder-util) | Param | Type | | --- | --- | -| response | [Response](#module_electron-builder-http.Response) | -| options | module:http.RequestOptions | -| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | -| resolve | callback | -| reject | callback | -| redirectCount | number | -| requestProcessor | callback | +| input | string | - - + -### `electron-builder-http.download(url, destination, options)` ⇒ Promise -**Kind**: method of [electron-builder-http](#module_electron-builder-http) +### `electron-builder-util.replaceDefault(inList, defaultList)` ⇒ Array +**Kind**: method of [electron-builder-util](#module_electron-builder-util) | Param | Type | | --- | --- | -| url | string | -| destination | string | -| options | [DownloadOptions](#module_electron-builder-http.DownloadOptions) | null | +| inList | Array | null | undefined | +| defaultList | Array | - - + -### `electron-builder-http.request(options, cancellationToken, data)` ⇒ Promise -**Kind**: method of [electron-builder-http](#module_electron-builder-http) +### `electron-builder-util.smarten(s)` ⇒ string +**Kind**: method of [electron-builder-util](#module_electron-builder-util) | Param | Type | | --- | --- | -| options | module:http.RequestOptions | -| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | -| data | module:electron-builder-http.__type | null | +| s | string | - - + -### `electron-builder-http.configureRequestOptions(options, token, method)` ⇒ module:http.RequestOptions -**Kind**: method of [electron-builder-http](#module_electron-builder-http) +### `electron-builder-util.spawn(command, args, options)` ⇒ Promise +**Kind**: method of [electron-builder-util](#module_electron-builder-util) | Param | Type | | --- | --- | -| options | module:http.RequestOptions | -| token | string | null | -| method | "GET" | "DELETE" | "PUT" | +| command | string | +| args | Array | null | +| options | module:child_process.SpawnOptions | - - + -### `electron-builder-http.dumpRequestOptions(options)` ⇒ string -**Kind**: method of [electron-builder-http](#module_electron-builder-http) +### `electron-builder-util.use(value, task)` ⇒ +**Kind**: method of [electron-builder-util](#module_electron-builder-util) | Param | Type | | --- | --- | -| options | module:http.RequestOptions | +| value | module:electron-builder-util.T | null | +| task | callback | - diff --git a/docs/Options.md b/docs/Options.md index 5a659082eac..9b8e9016992 100644 --- a/docs/Options.md +++ b/docs/Options.md @@ -118,6 +118,7 @@ You can use [file macros](#file-macros) in the `from` and `to` fields as well. | --- | --- | appId |

The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as [Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported).

Defaults to com.electron.${name}. It is strongly recommended that an explicit ID be set.

| copyright | The human-readable copyright line for the app. Defaults to `Copyright © year author`. +| iconUrl | * @deprecated | productName |

As [name](#AppMetadata-name), but allows you to specify a product name for your executable which contains spaces and other special characters not allowed in the [name property](https://docs.npmjs.com/files/package.json#name}).

| files |

A [glob patterns](https://www.npmjs.com/package/glob#glob-primer) relative to the [app directory](#MetadataDirectories-app), which specifies which files to include when copying files to create the package.

See [File Patterns](#multiple-glob-patterns).

| extraResources |

A [glob patterns](https://www.npmjs.com/package/glob#glob-primer) relative to the project directory, when specified, copy the file or directory with matching names directly into the app’s resources directory (Contents/Resources for MacOS, resources for Linux/Windows).

Glob rules the same as for [files](#multiple-glob-patterns).

@@ -133,7 +134,7 @@ You can use [file macros](#file-macros) in the `from` and `to` fields as well. | nodeGypRebuild | Whether to execute `node-gyp rebuild` before starting to package the app. Defaults to `false`. | electronDist | The path to custom Electron build (e.g. `~/electron/out/R`). Only macOS supported, file issue if need for Linux or Windows. | electronDownload | The [electron-download](https://github.com/electron-userland/electron-download#usage) options. -| publish | +| publish | | forceCodeSigning | Whether to fail if application will be not signed (to prevent unsigned app if code signing configuration is not correct). | electronVersion | The version of electron you are packaging for. Defaults to version of `electron`, `electron-prebuilt` or `electron-prebuilt-compile` dependency. | artifactName |

The [artifact file name pattern](https://github.com/electron-userland/electron-builder/wiki/Options#artifact-file-name-pattern). Defaults to ${productName}-${version}.${ext} (some target can have another defaults, see corresponding options).

Currently supported only for mas, pkg, dmg and nsis.

diff --git a/jsdoc/scope.hbs b/jsdoc/scope.hbs new file mode 100644 index 00000000000..2fcdcd8fdcd --- /dev/null +++ b/jsdoc/scope.hbs @@ -0,0 +1,10 @@ +{{#if scope}} +**Kind**: {{#if (equal kind "event") ~}} +event emitted{{#if memberof}} by {{>link to=memberof}}{{/if}} +{{else~}} +{{#unless (equal scope "static") ~}}{{scope}} {{/unless}}{{#if virtual}}abstract {{/if}}{{kindInThisContext}}{{#if memberof}} of {{>link to=memberof}}{{/if}} +{{/if~}} +{{else~}} +{{#if isExported}}**Kind**: Exported {{kind}} +{{/if~}} +{{/if~}} \ No newline at end of file diff --git a/package.json b/package.json index e7f3be13518..471fe7d4482 100644 --- a/package.json +++ b/package.json @@ -19,9 +19,9 @@ "set-versions": "node test/out/helpers/setVersions.js", "npm-publish": "yarn compile && ./packages/npm-publish.sh && conventional-changelog -p angular -i CHANGELOG.md -s", "schema": "typescript-json-schema packages/electron-builder/tsconfig.json Config --out packages/electron-builder/scheme.json --noExtraProps --useTypeOfKeyword --strictNullChecks", - "jsdoc": "ts2jsdoc packages/electron-updater packages/electron-builder-http", - "docs": "jsdoc2md --files 'jsdoc/out/**/*.js' --name-format --module-index-format grouped --separators --plugin dmd-tf > docs/API.md", - "api-docs": "node ./test/vendor/yarn.js docs && node ./test/vendor/yarn.js docs" + "jsdoc": "ts2jsdoc packages/electron-updater packages/electron-builder-http packages/electron-builder-util packages/electron-publish packages/electron-builder", + "docs": "jsdoc2md --files 'jsdoc/out/**/*.js' --name-format --module-index-format grouped --separators --partial jsdoc/scope.hbs > docs/API.md", + "api-docs": "node ./test/vendor/yarn.js jsdoc && node ./test/vendor/yarn.js docs" }, "//": "repository must be specified otherwise conventional-changelog will use forked repo (currently cloned)", "repository": "electron-userland/electron-builder", @@ -79,7 +79,6 @@ "convert-source-map": "^1.4.0", "decompress-zip": "^0.3.0", "depcheck": "^0.6.7", - "dmd-tf": "^3.0.3", "electron-download-tf": "4.0.0", "jest-cli": "^19.0.2", "jest-environment-node-debug": "^2.0.0", diff --git a/packages/electron-builder-core/src/core.ts b/packages/electron-builder-core/src/core.ts index 8f304696fe8..f6e654e6976 100644 --- a/packages/electron-builder-core/src/core.ts +++ b/packages/electron-builder-core/src/core.ts @@ -120,4 +120,36 @@ export interface TargetSpecificOptions { } export const DEFAULT_TARGET = "default" -export const DIR_TARGET = "dir" \ No newline at end of file +export const DIR_TARGET = "dir" + +export interface AuthorMetadata { + readonly name: string + readonly email?: string +} + +export type CompressionLevel = "store" | "normal" | "maximum" + +export interface RepositoryInfo { + readonly url: string +} + +export interface FilePattern { + from?: string + to?: string + filter?: Array | string +} + +export interface AsarOptions { + smartUnpack?: boolean + + ordering?: string | null + + extraMetadata?: any | null +} + +export interface BeforeBuildContext { + readonly appDir: string + readonly electronVersion: string + readonly platform: Platform + readonly arch: string +} \ No newline at end of file diff --git a/packages/electron-builder-core/tsconfig.json b/packages/electron-builder-core/tsconfig.json index ddce4b78028..493d4496fc0 100755 --- a/packages/electron-builder-core/tsconfig.json +++ b/packages/electron-builder-core/tsconfig.json @@ -3,6 +3,7 @@ "compilerOptions": { "outDir": "out" }, + "jsdoc": "../../jsdoc/out/core", "declaration": true, "include": [ "src/**/*.ts" diff --git a/packages/electron-builder-http/src/publishOptions.ts b/packages/electron-builder-http/src/publishOptions.ts index 6d1993b7d70..1e502038e1d 100644 --- a/packages/electron-builder-http/src/publishOptions.ts +++ b/packages/electron-builder-http/src/publishOptions.ts @@ -26,6 +26,38 @@ export interface PublishConfiguration { readonly token?: string | null } +/** + * GitHub options. + */ +export interface GithubOptions extends PublishConfiguration { + /** + * The repository name. [Detected automatically](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts#github-repository). + */ + readonly repo?: string | null + + /** + * Whether to use `v`-prefixed tag name. + * @default true + */ + readonly vPrefixedTagName?: boolean + + /** + * The host (including the port if need). + * @default github.com + */ + readonly host?: string | null + + /** + * The protocol. GitHub Publisher supports only `https`. + * @default https + */ + readonly protocol?: "https" | "http" | null +} + +export function githubUrl(options: GithubOptions) { + return `${options.protocol || "https"}://${options.host || "github.com"}` +} + /** * Generic (any HTTP(S) server) options. */ @@ -85,52 +117,6 @@ export function s3Url(options: S3Options) { return url } -export interface VersionInfo { - readonly version: string -} - -export interface UpdateInfo extends VersionInfo { - readonly path: string - readonly githubArtifactName?: string | null - readonly sha2: string - - readonly releaseName?: string | null - readonly releaseNotes?: string | null - readonly releaseDate: string -} - -/** - * GitHub options. - */ -export interface GithubOptions extends PublishConfiguration { - /** - * The repository name. [Detected automatically](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts#github-repository). - */ - readonly repo?: string | null - - /** - * Whether to use `v`-prefixed tag name. - * @default true - */ - readonly vPrefixedTagName?: boolean - - /** - * The host (including the port if need). - * @default github.com - */ - readonly host?: string | null - - /** - * The protocol. GitHub Publisher supports only `https`. - * @default https - */ - readonly protocol?: "https" | "http" | null -} - -export function githubUrl(options: GithubOptions) { - return `${options.protocol || "https"}://${options.host || "github.com"}` -} - /** * Bintray options. */ @@ -150,4 +136,18 @@ export interface BintrayOptions extends PublishConfiguration { * The Bintray user account. Used in cases where the owner is an organization. */ readonly user?: string | null +} + +export interface VersionInfo { + readonly version: string +} + +export interface UpdateInfo extends VersionInfo { + readonly path: string + readonly githubArtifactName?: string | null + readonly sha2: string + + readonly releaseName?: string | null + readonly releaseNotes?: string | null + readonly releaseDate: string } \ No newline at end of file diff --git a/packages/electron-builder-util/src/util.ts b/packages/electron-builder-util/src/util.ts index 054589d81c4..0f52f602983 100644 --- a/packages/electron-builder-util/src/util.ts +++ b/packages/electron-builder-util/src/util.ts @@ -279,4 +279,19 @@ export function replaceDefault(inList: Array | null | undefined, default inList = list } return inList +} + +export function getPlatformIconFileName(value: string | null | undefined, isMac: boolean) { + if (value === undefined) { + return undefined + } + if (value === null) { + return null + } + + if (!value.includes(".")) { + return `${value}.${isMac ? "icns" : "ico"}` + } + + return value.replace(isMac ? ".ico" : ".icns", isMac ? ".icns" : ".ico") } \ No newline at end of file diff --git a/packages/electron-builder-util/tsconfig.json b/packages/electron-builder-util/tsconfig.json index b3db699d1dc..67c710c6bdf 100755 --- a/packages/electron-builder-util/tsconfig.json +++ b/packages/electron-builder-util/tsconfig.json @@ -4,6 +4,7 @@ "outDir": "out" }, "declaration": true, + "jsdoc": "../../jsdoc/out/util", "include": [ "src/**/*.ts" ], diff --git a/packages/electron-builder/src/asarUtil.ts b/packages/electron-builder/src/asarUtil.ts index 4a0f85e7465..11488b7bfed 100644 --- a/packages/electron-builder/src/asarUtil.ts +++ b/packages/electron-builder/src/asarUtil.ts @@ -1,4 +1,5 @@ import BluebirdPromise from "bluebird-lst" +import { AsarOptions } from "electron-builder-core" import { debug } from "electron-builder-util" import { deepAssign } from "electron-builder-util/out/deepAssign" import { CONCURRENCY, FileCopier, Filter, MAX_FILE_REQUESTS, statOrNull, walk } from "electron-builder-util/out/fs" @@ -6,7 +7,6 @@ import { log } from "electron-builder-util/out/log" import { createReadStream, createWriteStream, ensureDir, readFile, readJson, readlink, stat, Stats, writeFile } from "fs-extra-p" import * as path from "path" import { AsarFilesystem, Node, readAsar } from "./asar" -import { AsarOptions } from "./metadata" const isBinaryFile: any = BluebirdPromise.promisify(require("isbinaryfile")) const pickle = require ("chromium-pickle-js") diff --git a/packages/electron-builder/src/index.ts b/packages/electron-builder/src/index.ts index 3ac5f5145bd..34a7bd06afb 100644 --- a/packages/electron-builder/src/index.ts +++ b/packages/electron-builder/src/index.ts @@ -1,8 +1,8 @@ -export { Packager } from "./packager" +export { Packager, BuildResult } from "./packager" export { PackagerOptions, ArtifactCreated, BuildInfo, SourceRepositoryInfo } from "./packagerApi" export { getArchSuffix, Platform, Arch, archFromString, Target, DIR_TARGET } from "electron-builder-core" export { BuildOptions, build, CliOptions, createTargets } from "./builder" -export { Metadata, Config, CompressionLevel, FilePattern } from "./metadata" -export { MacOptions, DmgOptions, MasBuildOptions, MacOsTargetName, PkgOptions } from "./options/macOptions" -export { WinBuildOptions, NsisOptions, SquirrelWindowsOptions, AppXOptions } from "./options/winOptions" -export { LinuxBuildOptions, DebOptions } from "./options/linuxOptions" \ No newline at end of file +export { Metadata, Config, AfterPackContext, Protocol, MetadataDirectories, FileAssociation, PlatformSpecificBuildOptions } from "./metadata" +export { MacOptions, DmgOptions, MasBuildOptions, MacOsTargetName, PkgOptions, DmgContent, DmgWindow } from "./options/macOptions" +export { WinBuildOptions, NsisOptions, SquirrelWindowsOptions, AppXOptions, NsisWebOptions } from "./options/winOptions" +export { LinuxBuildOptions, DebOptions, SnapOptions, AppImageOptions } from "./options/linuxOptions" \ No newline at end of file diff --git a/packages/electron-builder/src/metadata.ts b/packages/electron-builder/src/metadata.ts index 304e3b65c72..eaa125d163d 100755 --- a/packages/electron-builder/src/metadata.ts +++ b/packages/electron-builder/src/metadata.ts @@ -1,20 +1,10 @@ -import { Arch, Platform, Target, TargetConfig, TargetSpecificOptions } from "electron-builder-core" +import { Arch, AsarOptions, AuthorMetadata, BeforeBuildContext, CompressionLevel, FilePattern, RepositoryInfo, Target, TargetConfig, TargetSpecificOptions } from "electron-builder-core" import { Publish } from "electron-builder-http/out/publishOptions" import { AppImageOptions, DebOptions, LinuxBuildOptions, SnapOptions } from "./options/linuxOptions" import { DmgOptions, MacOptions, MasBuildOptions, PkgOptions } from "./options/macOptions" import { AppXOptions, NsisOptions, SquirrelWindowsOptions, WinBuildOptions } from "./options/winOptions" import { PlatformPackager } from "./platformPackager" -export interface AsarOptions { - dot?: boolean - - smartUnpack?: boolean - - ordering?: string | null - - extraMetadata?: any | null -} - /** ## Fields in the package.json @@ -59,23 +49,6 @@ export interface Metadata { readonly build?: Config } -export interface RepositoryInfo { - readonly url: string -} - -export interface AuthorMetadata { - readonly name: string - readonly email?: string -} - -export type CompressionLevel = "store" | "normal" | "maximum" - -export interface FilePattern { - from?: string - to?: string - filter?: Array | string -} - /** ## Configuration Options */ @@ -94,7 +67,9 @@ export interface Config extends PlatformSpecificBuildOptions, TargetSpecificOpti */ readonly copyright?: string | null - // deprecated + /** + * @deprecated + */ readonly iconUrl?: string | null /** @@ -207,8 +182,7 @@ export interface Config extends PlatformSpecificBuildOptions, TargetSpecificOpti /** * Array of option objects. Order is important — first item will be used as a default auto-update server on Windows (NSIS). - * - * See [publish](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts#publish-options). + * @see [Publish options](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts#publish-options). */ readonly publish?: Publish @@ -246,13 +220,6 @@ export interface AfterPackContext { readonly targets: Array } -export interface BeforeBuildContext { - readonly appDir: string - readonly electronVersion: string - readonly platform: Platform - readonly arch: string -} - /** ### `fileAssociations` File Associations @@ -352,19 +319,4 @@ export interface PlatformSpecificBuildOptions extends TargetSpecificOptions { readonly fileAssociations?: Array | FileAssociation readonly publish?: Publish -} - -export function getPlatformIconFileName(value: string | null | undefined, isMac: boolean) { - if (value === undefined) { - return undefined - } - if (value === null) { - return null - } - - if (!value.includes(".")) { - return `${value}.${isMac ? "icns" : "ico"}` - } - - return value.replace(isMac ? ".ico" : ".icns", isMac ? ".icns" : ".ico") } \ No newline at end of file diff --git a/packages/electron-builder/src/packager.ts b/packages/electron-builder/src/packager.ts index a935745542d..9ff22a0e301 100644 --- a/packages/electron-builder/src/packager.ts +++ b/packages/electron-builder/src/packager.ts @@ -441,6 +441,9 @@ function checkConflictingOptions(options: any) { } } +/** + * @private + */ export async function checkWineVersion(checkPromise: Promise) { function wineError(prefix: string): string { return `${prefix}, please see https://github.com/electron-userland/electron-builder/wiki/Multi-Platform-Build#${(process.platform === "linux" ? "linux" : "macos")}` diff --git a/packages/electron-builder/src/packager/mac.ts b/packages/electron-builder/src/packager/mac.ts index 97250383839..a9ee1d2bf18 100644 --- a/packages/electron-builder/src/packager/mac.ts +++ b/packages/electron-builder/src/packager/mac.ts @@ -1,11 +1,10 @@ import BluebirdPromise from "bluebird-lst" -import { asArray, use } from "electron-builder-util" +import { asArray, getPlatformIconFileName, use } from "electron-builder-util" import { copyFile, unlinkIfExists } from "electron-builder-util/out/fs" import { warn } from "electron-builder-util/out/log" import { copy, readFile, rename, unlink, utimes, writeFile } from "fs-extra-p" import * as path from "path" import { build as buildPlist, parse as parsePlist } from "plist" -import { getPlatformIconFileName } from "../metadata" import { normalizeExt, PlatformPackager } from "../platformPackager" function doRename(basePath: string, oldName: string, newName: string) { diff --git a/packages/electron-builder/src/platformPackager.ts b/packages/electron-builder/src/platformPackager.ts index 57612034cee..cbe5dd2488f 100644 --- a/packages/electron-builder/src/platformPackager.ts +++ b/packages/electron-builder/src/platformPackager.ts @@ -1,5 +1,5 @@ import BluebirdPromise from "bluebird-lst" -import { Arch, getArchSuffix, Platform, Target, TargetSpecificOptions } from "electron-builder-core" +import { Arch, AsarOptions, FilePattern, getArchSuffix, Platform, Target, TargetSpecificOptions } from "electron-builder-core" import { asArray, debug, isEmptyOrSpaces, Lazy, use } from "electron-builder-util" import { deepAssign } from "electron-builder-util/out/deepAssign" import { copyDir, statOrNull, unlinkIfExists } from "electron-builder-util/out/fs" @@ -10,7 +10,7 @@ import * as path from "path" import { AppInfo } from "./appInfo" import { checkFileInArchive, createAsarArchive } from "./asarUtil" import { copyFiles, FileMatcher } from "./fileMatcher" -import { AsarOptions, Config, FileAssociation, FilePattern, PlatformSpecificBuildOptions } from "./metadata" +import { Config, FileAssociation, PlatformSpecificBuildOptions } from "./metadata" import { unpackElectron } from "./packager/dirPackager" import { BuildInfo, PackagerOptions } from "./packagerApi" import { readInstalled } from "./readInstalled" diff --git a/packages/electron-builder/src/repositoryInfo.ts b/packages/electron-builder/src/repositoryInfo.ts index 486e3212153..04951925f83 100644 --- a/packages/electron-builder/src/repositoryInfo.ts +++ b/packages/electron-builder/src/repositoryInfo.ts @@ -1,7 +1,8 @@ +import { RepositoryInfo } from "electron-builder-core" import { readFile } from "fs-extra-p" import { fromUrl as parseRepositoryUrl, Info } from "hosted-git-info" import * as path from "path" -import { Metadata, RepositoryInfo } from "./metadata" +import { Metadata } from "./metadata" export interface RepositorySlug { user: string diff --git a/packages/electron-builder/src/targets/archive.ts b/packages/electron-builder/src/targets/archive.ts index 5ecd3e6017d..33727ed3945 100644 --- a/packages/electron-builder/src/targets/archive.ts +++ b/packages/electron-builder/src/targets/archive.ts @@ -1,9 +1,9 @@ import { path7za } from "7zip-bin" +import { CompressionLevel } from "electron-builder-core" import { debug7zArgs, spawn } from "electron-builder-util" import { exists } from "electron-builder-util/out/fs" import { unlink } from "fs-extra-p" import * as path from "path" -import { CompressionLevel } from "../metadata" class CompressionDescriptor { constructor(public flag: string, public env: string, public minLevel: string, public maxLevel: string = "-9") { diff --git a/packages/electron-builder/src/targets/nsis.ts b/packages/electron-builder/src/targets/nsis.ts index 5619c373973..8a9be2e4948 100644 --- a/packages/electron-builder/src/targets/nsis.ts +++ b/packages/electron-builder/src/targets/nsis.ts @@ -1,6 +1,6 @@ import BluebirdPromise from "bluebird-lst" import { Arch, Target } from "electron-builder-core" -import { asArray, debug, doSpawn, exec, handleProcess, isEmptyOrSpaces, use } from "electron-builder-util" +import { asArray, debug, doSpawn, exec, getPlatformIconFileName, handleProcess, isEmptyOrSpaces, use } from "electron-builder-util" import { getBinFromBintray } from "electron-builder-util/out/binDownload" import { copyFile } from "electron-builder-util/out/fs" import { log, subTask, warn } from "electron-builder-util/out/log" @@ -8,7 +8,6 @@ import { readFile, unlink } from "fs-extra-p" import * as path from "path" import sanitizeFileName from "sanitize-filename" import { v5 as uuid5 } from "uuid-1345" -import { getPlatformIconFileName } from "../metadata" import { NsisOptions } from "../options/winOptions" import { normalizeExt } from "../platformPackager" import { getSignVendorPath } from "../windowsCodeSign" @@ -356,19 +355,20 @@ export default class NsisTarget extends Target { } private async computeFinalScript(originalScript: string, isInstaller: boolean) { + const packager = this.packager let scriptHeader = `!addincludedir "${path.win32.join(__dirname, "..", "..", "templates", "nsis", "include")}"\n` + const pluginArch = this.isUnicodeEnabled ? "x86-unicode" : "x86-ansi" scriptHeader += `!addplugindir /${pluginArch} "${path.join(await nsisResourcePathPromise, "plugins", pluginArch)}"\n` + scriptHeader += `!addplugindir /${pluginArch} "${path.join(packager.buildResourcesDir, pluginArch)}"\n` if (this.isPortable) { return scriptHeader + originalScript } - const packager = this.packager const customInclude = await packager.getResource(this.options.include, "installer.nsh") if (customInclude != null) { scriptHeader += `!addincludedir "${packager.buildResourcesDir}"\n` - scriptHeader += `!addplugindir /${pluginArch} "${path.join(packager.buildResourcesDir, pluginArch)}"\n` scriptHeader += `!include "${customInclude}"\n\n` } diff --git a/packages/electron-builder/templates/nsis/langs.nsh b/packages/electron-builder/templates/nsis/langs.nsh index 8ae0261a008..f2beaaa2c18 100644 --- a/packages/electron-builder/templates/nsis/langs.nsh +++ b/packages/electron-builder/templates/nsis/langs.nsh @@ -18,8 +18,8 @@ !insertmacro MUI_LANGUAGE "Russian" #!insertmacro MUI_LANGUAGE "Portuguese" #!insertmacro MUI_LANGUAGE "PortugueseBR" -#!insertmacro MUI_LANGUAGE "Polish" -#!insertmacro MUI_LANGUAGE "Ukrainian" +!insertmacro MUI_LANGUAGE "Polish" +!insertmacro MUI_LANGUAGE "Ukrainian" !insertmacro MUI_LANGUAGE "Czech" #!insertmacro MUI_LANGUAGE "Slovak" #!insertmacro MUI_LANGUAGE "Croatian" diff --git a/packages/electron-builder/templates/nsis/oneClick.nsh b/packages/electron-builder/templates/nsis/oneClick.nsh index 11dbf5528c9..698670cf1a5 100644 --- a/packages/electron-builder/templates/nsis/oneClick.nsh +++ b/packages/electron-builder/templates/nsis/oneClick.nsh @@ -31,7 +31,11 @@ !insertmacro MUI_UNPAGE_INSTFILES !endif -!insertmacro MUI_LANGUAGE "English" +!ifdef MULTI_LANGUAGE_INSTALLER + !include "langs.nsh" +!else + !insertmacro MUI_LANGUAGE "English" +!endif !macro initMultiUser !ifdef INSTALL_MODE_PER_ALL_USERS diff --git a/packages/electron-builder/tsconfig.json b/packages/electron-builder/tsconfig.json index dc89400f695..983e7c95e7f 100755 --- a/packages/electron-builder/tsconfig.json +++ b/packages/electron-builder/tsconfig.json @@ -4,6 +4,7 @@ "outDir": "out" }, "declaration": true, + "jsdoc": "../../jsdoc/out/builder", "docs": "../../docs/Options.md", "include": [ "src/**/*.ts", diff --git a/packages/electron-publish/tsconfig.json b/packages/electron-publish/tsconfig.json index fb4fd7ebbad..84d78a5648d 100755 --- a/packages/electron-publish/tsconfig.json +++ b/packages/electron-publish/tsconfig.json @@ -4,6 +4,7 @@ "outDir": "out" }, "declaration": true, + "jsdoc": "../../jsdoc/out/electron-updater", "include": [ "src/**/*.ts" ], diff --git a/test/src/windows/oneClickInstallerTest.ts b/test/src/windows/oneClickInstallerTest.ts index 82f8a80244e..28563de5139 100644 --- a/test/src/windows/oneClickInstallerTest.ts +++ b/test/src/windows/oneClickInstallerTest.ts @@ -18,7 +18,6 @@ test("one-click", app({ package: "TestApp", }, nsis: { - unicode: false, deleteAppDataOnUninstall: true, }, }