From 1dc932847efbcca97fd3da6abdca61cb58915eb9 Mon Sep 17 00:00:00 2001 From: develar Date: Wed, 7 Jun 2017 18:13:28 +0200 Subject: [PATCH] docs: list format for options Reexport some classes to simplify docs Capitalize String/Boolean/Number --- README.md | 2 +- docker/6/Dockerfile | 2 +- docker/8/Dockerfile | 2 +- docs/Auto Update.md | 54 +- docs/NSIS.md | 2 +- docs/Options.md | 711 +++------ docs/Publishing Artifacts.md | 56 +- docs/api/electron-builder-core.md | 149 +- docs/api/electron-builder-http.md | 152 +- docs/api/electron-builder-util.md | 213 ++- docs/api/electron-builder.md | 1359 ++++++----------- docs/api/electron-publish.md | 233 +-- docs/api/electron-updater.md | 42 +- jsdoc/helpers.js | 114 +- jsdoc/properties-list.hbs | 7 +- package.json | 6 +- packages/electron-builder-core/src/core.ts | 97 -- packages/electron-builder-core/tsconfig.json | 5 +- packages/electron-builder-http/tsconfig.json | 3 +- packages/electron-builder-util/tsconfig.json | 5 +- packages/electron-builder/src/asarUtil.ts | 2 +- packages/electron-builder/src/builder.ts | 1 + packages/electron-builder/src/fileMatcher.ts | 4 +- packages/electron-builder/src/index.ts | 8 +- packages/electron-builder/src/metadata.ts | 190 ++- .../src/options/linuxOptions.ts | 22 +- .../src/options/macOptions.ts | 25 +- .../src/options/winOptions.ts | 34 +- packages/electron-builder/src/packagerApi.ts | 2 +- .../electron-builder/src/platformPackager.ts | 4 +- .../src/publish/PublishManager.ts | 3 +- .../electron-builder/src/repositoryInfo.ts | 3 +- packages/electron-builder/src/targets/fpm.ts | 2 +- .../src/targets/targetFactory.ts | 3 +- packages/electron-builder/tsconfig.json | 3 +- packages/electron-publish/tsconfig.json | 5 +- packages/electron-publisher-s3/package.json | 2 +- packages/electron-updater/package.json | 2 +- packages/electron-updater/src/AppUpdater.ts | 9 +- packages/electron-updater/tsconfig.json | 3 +- packages/jsdoc2md.js | 31 +- yarn.lock | 47 +- 42 files changed, 1328 insertions(+), 2291 deletions(-) diff --git a/README.md b/README.md index 58391ab1cdc..525b4f5d38a 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ _Note: Platform specific `7zip-bin-*` packages are `optionalDependencies`, which ## Quick Setup Guide -1. Specify the standard fields in the application `package.json` — [name](https://github.com/electron-userland/electron-builder/wiki/Options#AppMetadata-name), `description`, `version` and [author](https://docs.npmjs.com/files/package.json#people-fields-author-contributors). +1. Specify the standard fields in the application `package.json` — [name](https://github.com/electron-userland/electron-builder/wiki/Options#Metadata-name), `description`, `version` and [author](https://docs.npmjs.com/files/package.json#people-fields-author-contributors). 2. Specify the [build](https://github.com/electron-userland/electron-builder/wiki/Options#build) configuration in the `package.json` as follows: ```json diff --git a/docker/6/Dockerfile b/docker/6/Dockerfile index 2623b2a9b66..1d5f7b98e3f 100644 --- a/docker/6/Dockerfile +++ b/docker/6/Dockerfile @@ -1,4 +1,4 @@ FROM electronuserland/electron-builder:base # https://github.com/npm/npm/issues/4531 -RUN curl -sL https://deb.nodesource.com/setup_6.x | bash - && apt-get install -y nodejs && curl -L https://npmjs.org/install.sh | sh && npm cache clean && npm config set unsafe-perm true && npm completion >> ~/.bashrc && apt-get clean && rm -rf /var/lib/apt/lists/* \ No newline at end of file +RUN curl -sL https://deb.nodesource.com/setup_6.x | bash - && apt-get install -y nodejs && npm config set unsafe-perm true && apt-get clean && rm -rf /var/lib/apt/lists/* \ No newline at end of file diff --git a/docker/8/Dockerfile b/docker/8/Dockerfile index 2aff1507345..d8eb30e4eb8 100644 --- a/docker/8/Dockerfile +++ b/docker/8/Dockerfile @@ -1,4 +1,4 @@ FROM electronuserland/electron-builder:base # https://github.com/npm/npm/issues/4531 -RUN curl -sL https://deb.nodesource.com/setup_8.x | bash - && apt-get install -y nodejs && curl -L https://npmjs.org/install.sh | sh && npm cache clean && npm config set unsafe-perm true && npm completion >> ~/.bashrc && apt-get clean && rm -rf /var/lib/apt/lists/* \ No newline at end of file +RUN curl -sL https://deb.nodesource.com/setup_8.x | bash - && apt-get install -y nodejs && npm config set unsafe-perm true && apt-get clean && rm -rf /var/lib/apt/lists/* \ No newline at end of file diff --git a/docs/Auto Update.md b/docs/Auto Update.md index 6064db1c2ce..5832271ebe2 100644 --- a/docs/Auto Update.md +++ b/docs/Auto Update.md @@ -114,7 +114,7 @@ Emitted on progress. Only supported over Windows build, since `Squirrel.Mac` [do * [.AppUpdater](#AppUpdater) ⇐ internal:EventEmitter * [`.checkForUpdates()`](#module_electron-updater.AppUpdater+checkForUpdates) ⇒ Promise<[UpdateCheckResult](#UpdateCheckResult)> * [`.downloadUpdate(cancellationToken)`](#module_electron-updater.AppUpdater+downloadUpdate) ⇒ Promise<any> - * [`.getFeedURL()`](#module_electron-updater.AppUpdater+getFeedURL) ⇒ undefined \| null \| string + * [`.getFeedURL()`](#module_electron-updater.AppUpdater+getFeedURL) ⇒ undefined \| null \| String * [`.setFeedURL(options)`](#module_electron-updater.AppUpdater+setFeedURL) * [`.loadUpdateConfig()`](#module_electron-updater.AppUpdater+loadUpdateConfig) ⇒ Promise<any> * [`.quitAndInstall(isSilent)`](#module_electron-updater.AppUpdater+quitAndInstall) @@ -129,12 +129,12 @@ Emitted on progress. Only supported over Windows build, since `Squirrel.Mac` [do * [`.updateCancelled(handler)`](#module_electron-updater.UpdaterSignal+updateCancelled) * [`.updateDownloaded(handler)`](#module_electron-updater.UpdaterSignal+updateDownloaded) * [`.autoUpdater`](#module_electron-updater.autoUpdater) : [AppUpdater](#AppUpdater) - * [`.formatUrl(url)`](#module_electron-updater.formatUrl) ⇒ string - * [`.getChannelFilename(channel)`](#module_electron-updater.getChannelFilename) ⇒ string + * [`.formatUrl(url)`](#module_electron-updater.formatUrl) ⇒ String + * [`.getChannelFilename(channel)`](#module_electron-updater.getChannelFilename) ⇒ String * [`.getCurrentPlatform()`](#module_electron-updater.getCurrentPlatform) ⇒ any - * [`.getCustomChannelName(channel)`](#module_electron-updater.getCustomChannelName) ⇒ string - * [`.getDefaultChannelName()`](#module_electron-updater.getDefaultChannelName) ⇒ string - * [`.isUseOldMacProvider()`](#module_electron-updater.isUseOldMacProvider) ⇒ boolean + * [`.getCustomChannelName(channel)`](#module_electron-updater.getCustomChannelName) ⇒ String + * [`.getDefaultChannelName()`](#module_electron-updater.getDefaultChannelName) ⇒ String + * [`.isUseOldMacProvider()`](#module_electron-updater.isUseOldMacProvider) ⇒ Boolean @@ -144,10 +144,10 @@ Emitted on progress. Only supported over Windows build, since `Squirrel.Mac` [do | Name | Type | | --- | --- | -| **name**| string | -| **url**| string | -| sha2| string | -| sha512| string | +| **name**| String | +| **url**| String | +| sha2| String | +| sha512| String | | headers| Object | @@ -209,9 +209,9 @@ Emitted on progress. Only supported over Windows build, since `Squirrel.Mac` [do | Name | Type | Description | | --- | --- | --- | -| autoDownload = true| boolean | Whether to automatically download an update when it is found. | -| allowPrerelease| boolean | *GitHub provider only.* Whether to allow update to pre-release versions. Defaults to `true` if application version contains prerelease components (e.g. `0.12.1-alpha.1`, here `alpha` is a prerelease component), otherwise `false`.

If `true`, downgrade will be allowed (`allowDowngrade` will be set to `true`). | -| allowDowngrade| boolean | Whether to allow version downgrade (when a user from the beta channel wants to go back to the stable channel). | +| autoDownload = true| Boolean | Whether to automatically download an update when it is found. | +| allowPrerelease| Boolean | *GitHub provider only.* Whether to allow update to pre-release versions. Defaults to `true` if application version contains prerelease components (e.g. `0.12.1-alpha.1`, here `alpha` is a prerelease component), otherwise `false`.

If `true`, downgrade will be allowed (`allowDowngrade` will be set to `true`). | +| allowDowngrade| Boolean | Whether to allow version downgrade (when a user from the beta channel wants to go back to the stable channel). | | requestHeaders| [RequestHeaders](electron-builder-http#RequestHeaders) \| null | The request headers. | | logger = (<any>global).__test_app ? null : console| [Logger](#Logger) \| null | The logger. You can pass [electron-log](https://github.com/megahertz/electron-log), [winston](https://github.com/winstonjs/winston) or another logger with the following interface: `{ info(), warn(), error() }`. Set it to `null` if you would like to disable a logging feature. | | signals = new UpdaterSignal(this)| [UpdaterSignal](#UpdaterSignal) | For type safety you can use signals, e.g. `autoUpdater.signals.updateDownloaded(() => {})` instead of `autoUpdater.on('update-available', () => {})` | @@ -220,7 +220,7 @@ Emitted on progress. Only supported over Windows build, since `Squirrel.Mac` [do * [.AppUpdater](#AppUpdater) ⇐ internal:EventEmitter * [`.checkForUpdates()`](#module_electron-updater.AppUpdater+checkForUpdates) ⇒ Promise<[UpdateCheckResult](#UpdateCheckResult)> * [`.downloadUpdate(cancellationToken)`](#module_electron-updater.AppUpdater+downloadUpdate) ⇒ Promise<any> - * [`.getFeedURL()`](#module_electron-updater.AppUpdater+getFeedURL) ⇒ undefined \| null \| string + * [`.getFeedURL()`](#module_electron-updater.AppUpdater+getFeedURL) ⇒ undefined \| null \| String * [`.setFeedURL(options)`](#module_electron-updater.AppUpdater+setFeedURL) * [`.loadUpdateConfig()`](#module_electron-updater.AppUpdater+loadUpdateConfig) ⇒ Promise<any> * [`.quitAndInstall(isSilent)`](#module_electron-updater.AppUpdater+quitAndInstall) @@ -245,7 +245,7 @@ Start downloading update manually. You can use this method if `autoDownload` opt -#### `appUpdater.getFeedURL()` ⇒ undefined \| null \| string +#### `appUpdater.getFeedURL()` ⇒ undefined \| null \| String **Kind**: instance method of [AppUpdater](#AppUpdater) @@ -256,7 +256,7 @@ Configure update provider. If value is `string`, [module:electron-builder-http/o | Param | Type | Description | | --- | --- | --- | -| options | [PublishConfiguration](Publishing-Artifacts#PublishConfiguration) \| [GenericServerOptions](Publishing-Artifacts#GenericServerOptions) \| [S3Options](Publishing-Artifacts#S3Options) \| [BintrayOptions](Publishing-Artifacts#BintrayOptions) \| [GithubOptions](Publishing-Artifacts#GithubOptions) \| string | If you want to override configuration in the `app-update.yml`. | +| options | [PublishConfiguration](Publishing-Artifacts#PublishConfiguration) \| [GenericServerOptions](Publishing-Artifacts#GenericServerOptions) \| [S3Options](Publishing-Artifacts#S3Options) \| [BintrayOptions](Publishing-Artifacts#BintrayOptions) \| [GithubOptions](Publishing-Artifacts#GithubOptions) \| String | If you want to override configuration in the `app-update.yml`. | @@ -275,18 +275,12 @@ This is different from the normal quit event sequence. | Param | Type | Description | | --- | --- | --- | -| isSilent | boolean | *windows-only* Runs the installer in silent mode. | +| isSilent | Boolean | *windows-only* Runs the installer in silent mode. | ### Provider **Kind**: class of [electron-updater](#module_electron-updater) -**Properties** - -| Name | Type | -| --- | --- | -| requestHeaders| [RequestHeaders](electron-builder-http#RequestHeaders) \| null | - * [.Provider](#Provider) * [`.getLatestVersion()`](#module_electron-updater.Provider+getLatestVersion) ⇒ Promise<module:electron-updater.T> @@ -381,7 +375,7 @@ Emitted when an authenticating proxy is asking for user credentials. **Kind**: constant of [electron-updater](#module_electron-updater) -### `electron-updater.formatUrl(url)` ⇒ string +### `electron-updater.formatUrl(url)` ⇒ String **Kind**: method of [electron-updater](#module_electron-updater) | Param | Type | @@ -390,12 +384,12 @@ Emitted when an authenticating proxy is asking for user credentials. -### `electron-updater.getChannelFilename(channel)` ⇒ string +### `electron-updater.getChannelFilename(channel)` ⇒ String **Kind**: method of [electron-updater](#module_electron-updater) | Param | Type | | --- | --- | -| channel | string | +| channel | String | @@ -403,20 +397,20 @@ Emitted when an authenticating proxy is asking for user credentials. **Kind**: method of [electron-updater](#module_electron-updater) -### `electron-updater.getCustomChannelName(channel)` ⇒ string +### `electron-updater.getCustomChannelName(channel)` ⇒ String **Kind**: method of [electron-updater](#module_electron-updater) | Param | Type | | --- | --- | -| channel | string | +| channel | String | -### `electron-updater.getDefaultChannelName()` ⇒ string +### `electron-updater.getDefaultChannelName()` ⇒ String **Kind**: method of [electron-updater](#module_electron-updater) -### `electron-updater.isUseOldMacProvider()` ⇒ boolean +### `electron-updater.isUseOldMacProvider()` ⇒ Boolean **Kind**: method of [electron-updater](#module_electron-updater) diff --git a/docs/NSIS.md b/docs/NSIS.md index 50e24cc048c..a4f9adef764 100644 --- a/docs/NSIS.md +++ b/docs/NSIS.md @@ -43,7 +43,7 @@ Windows requires to use registry keys (e.g. INSTALL/UNINSTALL info). Squirrel.Wi But it is not robust — Google can use key Google Chrome SxS, because it is a Google. So, it is better to use [GUID](http://stackoverflow.com/a/246935/1910191). -You are not forced to explicitly specify it — name-based [UUID v5](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_5_.28SHA-1_hash_.26_namespace.29) will be generated from your [appId](https://github.com/electron-userland/electron-builder/wiki/Options#Config-appId) or [name](https://github.com/electron-userland/electron-builder/wiki/Options#AppMetadata-name). +You are not forced to explicitly specify it — name-based [UUID v5](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_5_.28SHA-1_hash_.26_namespace.29) will be generated from your [appId](https://github.com/electron-userland/electron-builder/wiki/Options#Config-appId) or [name](https://github.com/electron-userland/electron-builder/wiki/Options#Metadata-name). It means that you **should not change appId** once your application in use (or name if `appId` was not set). Application product name (title) or description can be safely changed. You can explicitly set guid using option [nsis.guid](https://github.com/electron-userland/electron-builder/wiki/Options#NsisOptions-guid), but it is not recommended — consider using [appId](https://github.com/electron-userland/electron-builder/wiki/Options#Config-appId). diff --git a/docs/Options.md b/docs/Options.md index 4eacea38232..b302c8467a0 100644 --- a/docs/Options.md +++ b/docs/Options.md @@ -16,6 +16,24 @@ Most of the options accept `null` — for example, to explicitly set that DMG ic ## File Patterns +* `*` Matches 0 or more characters in a single path portion +* `?` Matches 1 character +* `[...]` Matches a range of characters, similar to a RegExp range. + If the first character of the range is `!` or `^` then it matches + any character not in the range. +* `!(pattern|pattern|pattern)` Matches anything that does not match + any of the patterns provided. +* `?(pattern|pattern|pattern)` Matches zero or one occurrence of the + patterns provided. +* `+(pattern|pattern|pattern)` Matches one or more occurrences of the + patterns provided. +* `*(a|b|c)` Matches zero or more occurrences of the patterns provided +* `@(pattern|pat*|pat?erN)` Matches exactly one of the patterns + provided +* `**` If a "globstar" is alone in a path portion, then it matches + zero or more directories and subdirectories searching for matches. + It does not crawl symlinked directories. + Hidden files are not ignored by default, but all files that should be ignored, are [ignored by default](#default-file-pattern). Development dependencies are never copied in any case. You don't need to ignore it explicitly. @@ -59,7 +77,7 @@ You can use macros in the file patterns, artifact file name patterns and publish ## Source and Destination Directories You may also specify custom source and destination directories by using JSON objects instead of simple glob patterns. -Note this only works for `extraFiles` and `extraResources`. +Note this only works for [extraFiles](#Config-extraFiles) and [extraResources](#Config-extraResources). ```js [ { @@ -90,484 +108,237 @@ You can use [file macros](#file-macros) in the `from` and `to` fields as well. `${ext}` macro is supported in addition to [file macros](#file-macros). -## Build Version Management -`CFBundleVersion` (macOS) and `FileVersion` (Windows) will be set automatically to `version.build_number` on CI server (Travis, AppVeyor, CircleCI and Bamboo supported). - -## API - -* [electron-builder](#module_electron-builder) - * [`.AppXOptions`](#AppXOptions) - * [`.BuildOptions`](#BuildOptions) ⇐ [PublishOptions](electron-publish#PublishOptions) - * [`.CliOptions`](#CliOptions) ⇐ [PublishOptions](electron-publish#PublishOptions) - * [`.Config`](#Config) ⇐ [PlatformSpecificBuildOptions](electron-builder-core#PlatformSpecificBuildOptions) - * [`.DebOptions`](#DebOptions) ⇐ [LinuxTargetSpecificOptions](electron-builder#LinuxTargetSpecificOptions) - * [`.DmgContent`](#DmgContent) - * [`.DmgOptions`](#DmgOptions) ⇐ [TargetSpecificOptions](electron-builder-core#TargetSpecificOptions) - * [`.DmgWindow`](#DmgWindow) - * [`.LinuxBuildOptions`](#LinuxBuildOptions) ⇐ [CommonLinuxOptions](electron-builder#CommonLinuxOptions) - * [`.MacOptions`](#MacOptions) ⇐ [PlatformSpecificBuildOptions](electron-builder-core#PlatformSpecificBuildOptions) - * [`.MasBuildOptions`](#MasBuildOptions) ⇐ [MacOptions](#MacOptions) - * [`.Metadata`](#Metadata) - * [`.MetadataDirectories`](#MetadataDirectories) - * [`.NsisOptions`](#NsisOptions) ⇐ [TargetSpecificOptions](electron-builder-core#TargetSpecificOptions) - * [`.NsisWebOptions`](#NsisWebOptions) ⇐ [NsisOptions](#NsisOptions) - * [`.PackagerOptions`](#PackagerOptions) - * [`.PkgOptions`](#PkgOptions) ⇐ [TargetSpecificOptions](electron-builder-core#TargetSpecificOptions) - * [`.PortableOptions`](#PortableOptions) ⇐ [CommonNsisOptions](electron-builder#CommonNsisOptions) - * [`.SnapOptions`](#SnapOptions) ⇐ [LinuxBuildOptions](#LinuxBuildOptions) - * [`.SquirrelWindowsOptions`](#SquirrelWindowsOptions) ⇐ [WinBuildOptions](#WinBuildOptions) - * [`.WinBuildOptions`](#WinBuildOptions) ⇐ [PlatformSpecificBuildOptions](electron-builder-core#PlatformSpecificBuildOptions) - - - -### `AppXOptions` -AppX Options ([appx](#Config-appx)). - -**Kind**: interface of [electron-builder](#module_electron-builder) -**See**: [Windows AppX docs](https://msdn.microsoft.com/en-us/library/windows/apps/br211453.aspx). -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| backgroundColor| string \| null | The background color of the app tile. See: [Visual Elements](https://msdn.microsoft.com/en-us/library/windows/apps/br211471.aspx). | -| 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). | - - - -### `BuildOptions` ⇐ [PublishOptions](electron-publish#PublishOptions) -**Kind**: interface of [electron-builder](#module_electron-builder) -**Extends**: [PublishOptions](electron-publish#PublishOptions) - - -### `CliOptions` ⇐ [PublishOptions](electron-publish#PublishOptions) -**Kind**: interface of [electron-builder](#module_electron-builder) -**Extends**: [PublishOptions](electron-publish#PublishOptions) -**Properties** - -| Name | Type | -| --- | --- | -| mac| Array<string> | -| linux| Array<string> | -| win| Array<string> | -| arch| string | -| x64| boolean | -| ia32| boolean | -| armv7l| boolean | -| dir| boolean | -| platform| string | -| project| string | - -### `Config` ⇐ [PlatformSpecificBuildOptions](electron-builder-core#PlatformSpecificBuildOptions) +## `Config` ⇐ [PlatformSpecificBuildOptions](electron-builder#PlatformSpecificBuildOptions) Configuration Options **Kind**: interface of [electron-builder](#module_electron-builder) -**Extends**: [PlatformSpecificBuildOptions](electron-builder-core#PlatformSpecificBuildOptions) -**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`. | -| 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> \| 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](#file-patterns). | -| extraResources| Array<string \| [FilePattern](electron-builder-core#FilePattern)> \| [FilePattern](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<string \| [FilePattern](electron-builder-core#FilePattern)> \| [FilePattern](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 = true| [AsarOptions](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/).

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> \| 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](electron-builder-core#FileAssociation)> \| [FileAssociation](electron-builder-core#FileAssociation) | File associations. | -| protocols| Array<[Protocol](electron-builder-core#Protocol)> \| [Protocol](electron-builder-core#Protocol) | URL protocol schemes. | -| compression = normal| "store" \| "normal" \| "maximum" \| null | The compression level. 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 = true| boolean | Whether to [rebuild](https://docs.npmjs.com/cli/rebuild) native dependencies (`npm rebuild`) before starting to package the app. | -| npmSkipBuildFromSource| boolean | Whether to omit using [--build-from-source](https://github.com/mapbox/node-pre-gyp#options) flag when installing app native deps. | -| npmArgs| Array<string> \| string \| null | Additional command line arguments to use when installing app native deps. | -| nodeGypRebuild| boolean | Whether to execute `node-gyp rebuild` before starting to package the app. | -| 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. | -| publish| null \| string \| [GithubOptions](Publishing-Artifacts#GithubOptions) \| [S3Options](Publishing-Artifacts#S3Options) \| [GenericServerOptions](Publishing-Artifacts#GenericServerOptions) \| [BintrayOptions](Publishing-Artifacts#BintrayOptions) \| Array | Array of option objects. Order is important — first item will be used as a default auto-update server. See: [Publish options](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts#publish-options). | -| forceCodeSigning| boolean | Whether to fail if application will be not signed (to prevent unsigned app if code signing configuration is not correct). | -| directories| [MetadataDirectories](#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. | -| muonVersion| string \| null | The version of muon you are packaging for. | -| 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). | -| 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`). | -| electronCompile| boolean | Whether to use [electron-compile](http://github.com/electron/electron-compile) to compile app. Defaults to `true` if `electron-compile` in the dependencies. And `false` if in the `devDependencies` or doesn't specified. | -| detectUpdateChannel = true| boolean | Whether to infer update channel from application version prerelease components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`. | -| mac| [MacOptions](#MacOptions) \| null | | -| mas| [MasBuildOptions](#MasBuildOptions) \| null | | -| dmg| [DmgOptions](#DmgOptions) \| null | | -| pkg| [PkgOptions](#PkgOptions) \| null | | -| win| [WinBuildOptions](#WinBuildOptions) \| null | | -| nsis| [NsisOptions](#NsisOptions) \| null | | -| nsisWeb| [NsisWebOptions](#NsisWebOptions) \| null | | -| portable| [PortableOptions](#PortableOptions) \| null | | -| appx| [AppXOptions](#AppXOptions) \| null | | -| squirrelWindows| [SquirrelWindowsOptions](#SquirrelWindowsOptions) \| null | | -| linux| [LinuxBuildOptions](#LinuxBuildOptions) \| null | | -| deb| [DebOptions](#DebOptions) \| null | | -| snap| [SnapOptions](#SnapOptions) \| null | | -| appimage| [LinuxTargetSpecificOptions](electron-builder#LinuxTargetSpecificOptions) \| null | | -| pacman| [LinuxTargetSpecificOptions](electron-builder#LinuxTargetSpecificOptions) \| null | | -| rpm| [LinuxTargetSpecificOptions](electron-builder#LinuxTargetSpecificOptions) \| null | | -| freebsd| [LinuxTargetSpecificOptions](electron-builder#LinuxTargetSpecificOptions) \| null | | -| p5p| [LinuxTargetSpecificOptions](electron-builder#LinuxTargetSpecificOptions) \| null | | -| apk| [LinuxTargetSpecificOptions](electron-builder#LinuxTargetSpecificOptions) \| null | | - - - -### `DebOptions` ⇐ [LinuxTargetSpecificOptions](electron-builder#LinuxTargetSpecificOptions) -Debian Package Specific Options - -**Kind**: interface of [electron-builder](#module_electron-builder) -**Extends**: [LinuxTargetSpecificOptions](electron-builder#LinuxTargetSpecificOptions) -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| compression = xz| "gz" \| "bzip2" \| "xz" \| null | The compression type. | -| priority| string \| null | The [Priority](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Priority) attribute. | -| depends| Array<string> \| null | Package dependencies. Defaults to `["gconf2", "gconf-service", "libnotify4", "libappindicator1", "libxtst6", "libnss3"]`. | - - - -### `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 | | - - - -### `DmgOptions` ⇐ [TargetSpecificOptions](electron-builder-core#TargetSpecificOptions) -macOS DMG Options ([dmg](#Config-dmg)). - -To add license to DMG, create file `license_LANG_CODE.txt` in the build resources. Multiple license files in different languages are supported — use lang postfix (e.g. `_de`, `_ru`)). For example, create files `license_de.txt` and `license_en.txt` in the build resources. -If OS language is german, `license_de.txt` will be displayed. See map of [language code to name](https://github.com/meikidd/iso-639-1/blob/master/src/data.js). - -**Kind**: interface of [electron-builder](#module_electron-builder) -**Extends**: [TargetSpecificOptions](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 = 80| number \| null | The size of all the icons inside the DMG. | -| iconTextSize = 12| number \| null | The size of all the icon texts inside the DMG. | -| title = "${productName} ${version}"| string \| null | The title of the produced DMG, which will be shown when mounted (volume name).

Macro `${productName}`, `${version}` and `${name}` are supported. | -| contents| Array<[DmgContent](#DmgContent)> | The content — to customize icon locations. | -| format = UDZO| "UDRW" \| "UDRO" \| "UDCO" \| "UDZO" \| "UDBZ" \| "ULFO" | The disk image format. `ULFO` (lzfse-compressed image (OS X 10.11+ only)). | -| window| [DmgWindow](#DmgWindow) | The DMG windows position and size. See [dmg.window](#DmgWindow). | - -**Example** *(change file icons location for DMG)* -```js -{ - "contents": [ - { - "x": 130, - "y": 220 - }, - { - "x": 410, - "y": 220, - "type": "link", - "path": "/Applications" - } - ] -} -``` - - -### `DmgWindow` -DMG Windows Position and Size - -**Kind**: interface of [electron-builder](#module_electron-builder) +**Extends**: [PlatformSpecificBuildOptions](electron-builder#PlatformSpecificBuildOptions) **Properties** - -| Name | Type | Description | -| --- | --- | --- | -| x = 400| number | The X position relative to left of the screen. | -| y = 100| number | The Y position relative to top of the screen. | -| width| number | The width. Defaults to background image width or 540. | -| height| number | The height. Defaults to background image height or 380. | - - - -### `LinuxBuildOptions` ⇐ [CommonLinuxOptions](electron-builder#CommonLinuxOptions) -Linux Options - -**Kind**: interface of [electron-builder](#module_electron-builder) -**Extends**: [CommonLinuxOptions](electron-builder#CommonLinuxOptions) -**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 = AppImage| null \| string \| [TargetConfig](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`.

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). See: [Please do not put an AppImage into another archive like a .zip or .tar.gz](https://github.com/probonopd/AppImageKit/wiki/Creating-AppImages#common-mistake) | -| maintainer| string \| null | The maintainer. Defaults to [author](#AppMetadata-author). | -| vendor| string \| null | The vendor. Defaults to [author](#AppMetadata-author). | -| desktop| Object<string, any> \| null | The [Desktop file](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) entries (name to value). | -| 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. | -| synopsis| string \| null | The [short description](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Description). | - - - -### `MacOptions` ⇐ [PlatformSpecificBuildOptions](electron-builder-core#PlatformSpecificBuildOptions) -macOS Options ([mac](#Config-mac)). - -**Kind**: interface of [electron-builder](#module_electron-builder) -**Extends**: [PlatformSpecificBuildOptions](electron-builder-core#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<[TargetConfig](electron-builder-core#TargetConfig) \| "default" \| "dmg" \| "mas" \| "mas-dev" \| "pkg" \| "7z" \| "zip" \| "tar.xz" \| "tar.lz" \| "tar.gz" \| "tar.bz2" \| "dir"> \| "default" \| "dmg" \| "mas" \| "mas-dev" \| "pkg" \| "7z" \| "zip" \| "tar.xz" \| "tar.lz" \| "tar.gz" \| "tar.bz2" \| "dir" \| [TargetConfig](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 = "build/icon.icns"| string \| null | The path to application icon. | -| 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](https://github.com/electron-userland/electron-builder/issues/565#issuecomment-230678643). | -| helperBundleId = "${appBundleIdentifier}.helper"| string \| null | The bundle identifier to use in the application helper's plist. | -| type = distribution| "distribution" \| "development" \| null | Whether to sign app for development or for distribution. | -| extendInfo| any | The extra entries for `Info.plist`. | -| binaries| Array<string> \| null | Paths of any extra binaries that need to be signed. | -| requirements| string \| null | Path of [requirements file](https://developer.apple.com/library/mac/documentation/Security/Conceptual/CodeSigningGuide/RequirementLang/RequirementLang.html) used in signing. Not applicable for MAS. | - - - -### `MasBuildOptions` ⇐ [MacOptions](#MacOptions) -MAS (Mac Application Store) Options ([mas](#Config-mas)). - -**Kind**: interface of [electron-builder](#module_electron-builder) -**Extends**: [MacOptions](#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). | -| binaries| Array<string> \| null | Paths of any extra binaries that need to be signed. | - - - -### `Metadata` -Fields in the package.json +* `appId` = `com.electron.${name}` String - 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). It is strongly recommended that an explicit ID be set. +* `copyright` = `Copyright © year ${author}` String - The human-readable copyright line for the app. +* `productName` String - As [name](#Metadata-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> | String - A [glob patterns](#file-patterns) relative to the [app directory](#MetadataDirectories-app), which specifies which files to include when copying files to create the package. +* `extraResources` Array<String | [FilePattern](electron-builder-core#FilePattern)> | [FilePattern](electron-builder-core#FilePattern) | String - A [glob patterns](#file-patterns) 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<String | [FilePattern](electron-builder-core#FilePattern)> | [FilePattern](electron-builder-core#FilePattern) | String - The same as [extraResources](#Config-extraResources) but copy into the app's content directory (`Contents` for MacOS, root directory for Linux/Windows). +* `asar` = `true` Boolean | [AsarOptions](#AsarOptions) - Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/). + + 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. + * `smartUnpack` = `true` Boolean - Whether to automatically unpack executables files. + * `ordering` String +* `asarUnpack` Array<String> | String - A [glob patterns](#file-patterns) 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](#FileAssociation)> | [FileAssociation](#FileAssociation) - File associations. + * **`ext`** String | Array<String> - The extension (minus the leading period). e.g. `png`. + * `name` String - The name. e.g. `PNG`. Defaults to `ext`. + * `description` String - *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` = `Editor` String - *macOS-only* The app’s role with respect to the type. The value can be `Editor`, `Viewer`, `Shell`, or `None`. 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`. +* `protocols` Array<[Protocol](#Protocol)> | [Protocol](#Protocol) - URL protocol schemes. + * **`name`** String - The name. e.g. `IRC server URL`. + * **`schemes`** Array<String> - The schemes. e.g. `["irc", "ircs"]`. + * `role` = `Editor` "Editor" | "Viewer" | "Shell" | "None" - *macOS-only* The app’s role with respect to the type. +* `compression` = `normal` "store" | "normal" | "maximum" - The compression level. 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` = `true` Boolean - Whether to [rebuild](https://docs.npmjs.com/cli/rebuild) native dependencies (`npm rebuild`) before starting to package the app. +* `npmSkipBuildFromSource` = `false` Boolean - Whether to omit using [--build-from-source](https://github.com/mapbox/node-pre-gyp#options) flag when installing app native deps. +* `npmArgs` Array<String> | String - Additional command line arguments to use when installing app native deps. +* `nodeGypRebuild` = `false` Boolean - Whether to execute `node-gyp rebuild` before starting to package the app. +* `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. +* `publish` String | [GithubOptions](Publishing-Artifacts#GithubOptions) | [S3Options](Publishing-Artifacts#S3Options) | [GenericServerOptions](Publishing-Artifacts#GenericServerOptions) | [BintrayOptions](Publishing-Artifacts#BintrayOptions) | Array - Array of option objects. Order is important — first item will be used as a default auto-update server. See: [Publish options](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts#publish-options). +* `forceCodeSigning` = `false` Boolean - Whether to fail if application will be not signed (to prevent unsigned app if code signing configuration is not correct). +* `directories` + * `buildResources` = `build` String - The path to build resources. + * `output` = `dist` String - The output directory. + * `app` String - The application directory (containing the application package.json), defaults to `app`, `www` or working directory. +* `electronVersion` String - The version of electron you are packaging for. Defaults to version of `electron`, `electron-prebuilt` or `electron-prebuilt-compile` dependency. +* `muonVersion` String - The version of muon you are packaging for. +* `artifactName` String - 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). +* `buildVersion` String - 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`). +* `electronCompile` Boolean - Whether to use [electron-compile](http://github.com/electron/electron-compile) to compile app. Defaults to `true` if `electron-compile` in the dependencies. And `false` if in the `devDependencies` or doesn't specified. +* `detectUpdateChannel` = `true` Boolean - Whether to infer update channel from application version prerelease components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`. +* `mac` - macOS options. + * `category` String - 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<[TargetConfig](electron-builder-core#TargetConfig) | "default" | "dmg" | "mas" | "mas-dev" | "pkg" | "7z" | "zip" | "tar.xz" | "tar.lz" | "tar.gz" | "tar.bz2" | "dir"> | "default" | "dmg" | "mas" | "mas-dev" | "pkg" | "7z" | "zip" | "tar.xz" | "tar.lz" | "tar.gz" | "tar.bz2" | "dir" | [TargetConfig](electron-builder-core#TargetConfig) - 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 - 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` = `build/icon.icns` String - The path to application icon. + * `entitlements` String - 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 - 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 - The `CFBundleVersion`. Do not use it unless [you need to](https://github.com/electron-userland/electron-builder/issues/565#issuecomment-230678643). + * `helperBundleId` = `${appBundleIdentifier}.helper` String - The bundle identifier to use in the application helper's plist. + * `type` = `distribution` "distribution" | "development" - Whether to sign app for development or for distribution. + * `extendInfo` any - The extra entries for `Info.plist`. + * `binaries` Array<String> - Paths of any extra binaries that need to be signed. + * `requirements` String - Path of [requirements file](https://developer.apple.com/library/mac/documentation/Security/Conceptual/CodeSigningGuide/RequirementLang/RequirementLang.html) used in signing. Not applicable for MAS. +* `mas` - MAS (Mac Application Store) options. + * `entitlements` String - 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 - 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). + * `binaries` Array<String> - Paths of any extra binaries that need to be signed. +* `dmg` - macOS DMG options. + + To add license to DMG, create file `license_LANG_CODE.txt` in the build resources. Multiple license files in different languages are supported — use lang postfix (e.g. `_de`, `_ru`)). For example, create files `license_de.txt` and `license_en.txt` in the build resources. If OS language is german, `license_de.txt` will be displayed. See map of [language code to name](https://github.com/meikidd/iso-639-1/blob/master/src/data.js). + * `background` String - 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 - The background color (accepts css colors). Defaults to `#ffffff` (white) if no background image. + * `icon` String - 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` = `80` Number - The size of all the icons inside the DMG. + * `iconTextSize` = `12` Number - The size of all the icon texts inside the DMG. + * `title` = `${productName} ${version}` String - The title of the produced DMG, which will be shown when mounted (volume name). + + Macro `${productName}`, `${version}` and `${name}` are supported. + * `contents` Array<[DmgContent](#DmgContent)> - The content — to customize icon locations. + * `format` = `UDZO` "UDRW" | "UDRO" | "UDCO" | "UDZO" | "UDBZ" | "ULFO" - The disk image format. `ULFO` (lzfse-compressed image (OS X 10.11+ only)). + * `window` - The DMG windows position and size. + * `x` = `400` Number - The X position relative to left of the screen. + * `y` = `100` Number - The Y position relative to top of the screen. + * `width` Number - The width. Defaults to background image width or 540. + * `height` Number - The height. Defaults to background image height or 380. +* `pkg` - macOS product archive options. + * `scripts` = `build/pkg-scripts` String - The scripts directory, relative to `build` (build resources directory). 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`). See: [Scripting in installer packages](http://macinstallers.blogspot.de/2012/07/scripting-in-installer-packages.html). + * `installLocation` = `/Applications` String - The install location. + * `identity` String +* `win` - Windows options. + * `target` = `nsis` String | [TargetConfig](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`. AppX package can be built only on Windows 10. + + To use Squirrel.Windows please install `electron-builder-squirrel-windows` dependency. + * `signingHashAlgorithms` = `['sha1', 'sha256']` Array<"sha1" | "sha256"> - Array of signing algorithms used. For AppX `sha256` is always used. + * `icon` = `build/icon.ico` String - The path to application icon. + * `legalTrademarks` String - 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. + * `additionalCertificateFile` String - The path to an additional certificate file you want to add to the signature block. + * `rfc3161TimeStampServer` = `http://timestamp.comodoca.com/rfc3161` String - The URL of the RFC 3161 time stamp server. + * `timeStampServer` = `http://timestamp.verisign.com/scripts/timstamp.dll` String - The URL of the time stamp server. + * `publisherName` String | Array<String> - [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. + * `forceCodeSigningVerification` = `true` Boolean - Whether to verify the signature of an available update before installation. The [publisher name](WinBuildOptions#publisherName) will be used for the signature verification. +* `nsis` - NSIS options. See [NSIS target notes](https://github.com/electron-userland/electron-builder/wiki/NSIS). + * `oneClick` = `true` Boolean - One-click installation. + * `perMachine` = `false` Boolean - 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` = `true` Boolean - *boring installer only.* Allow requesting for elevation. If false, user will have to restart installer with elevated permissions. + * `allowToChangeInstallationDirectory` = `false` Boolean - *boring installer only.* Whether to allow user to change installation directory. + * `runAfterFinish` = `true` Boolean - *one-click installer only.* Run application after finish. + * `guid` String - See [GUID vs Application Name](https://github.com/electron-userland/electron-builder/wiki/NSIS#guid-vs-application-name). + * `installerIcon` String - 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. + * `uninstallerIcon` String - The path to uninstaller 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/uninstallerIcon.ico` or application icon. + * `installerHeader` = `build/installerHeader.bmp` String - *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. + * `installerSidebar` String - *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 - *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 - *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 - 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 - 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 - The path to EULA license file. Defaults to `license.rtf` or `license.txt` or `eula.rtf` or `eula.txt` (or uppercase variants, e.g. `EULA.txt` or `LICENSE.TXT`). + + Multiple license files in different languages are supported — use lang postfix (e.g. `_de`, `_ru`)). For example, create files `license_de.txt` and `license_en.txt` in the build resources. If OS language is german, `license_de.txt` will be displayed. See map of [language code to name](https://github.com/meikidd/iso-639-1/blob/master/src/data.js). + + Appropriate license file will be selected by user OS language. + * `language` String - [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` = `true` Boolean - If `warningsAsErrors` is `true` (default): NSIS will treat warnings as errors. If `warningsAsErrors` is `false`: NSIS will allow warnings. + * `menuCategory` = `false` Boolean | String - Whether to create submenu for start menu shortcut and program files directory. If `true`, company name will be used. Or string value. + * `artifactName` String - 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` = `true` Boolean - Whether to create [Unicode installer](http://nsis.sourceforge.net/Docs/Chapter1.html#intro-unicode). + * `deleteAppDataOnUninstall` = `false` Boolean - *one-click installer only.* Whether to delete app data on uninstall. +* `nsisWeb` - Web Installer specific options. + * `appPackageUrl` String - 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 - 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}`. +* `portable` - Portable specific options. + * `requestExecutionLevel` = `user` "user" | "highest" | "admin" - The [requested execution level](http://nsis.sourceforge.net/Reference/RequestExecutionLevel) for Windows. +* `appx` - AppX options. See [Windows AppX docs](https://msdn.microsoft.com/en-us/library/windows/apps/br211453.aspx). + * `backgroundColor` String - The background color of the app tile. See: [Visual Elements](https://msdn.microsoft.com/en-us/library/windows/apps/br211471.aspx). + * `publisher` String - 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 - 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 - 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 - 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). +* `squirrelWindows` - Squirrel.Windows options. + + To use Squirrel.Windows please install `electron-builder-squirrel-windows` dependency. Squirrel.Windows target is maintained, but deprecated. Please use `nsis` instead. + * `iconUrl` String - 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 - 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 - 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 - Authentication token for remote updates + * `useAppIdAsId` Boolean - Use `appId` to identify package instead of `name`. +* `linux` - Linux options. + * `category` String - The [application category](https://specifications.freedesktop.org/menu-spec/latest/apa.html#main-category-registry). + * `packageCategory` String - The [package category](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Section). Not applicable for AppImage. + * `description` String - As [description](#Metadata-description) from application package.json, but allows you to specify different for Linux. + * `target` = `AppImage` String | [TargetConfig](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`. + + 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). See: [Please do not put an AppImage into another archive like a .zip or .tar.gz](https://github.com/probonopd/AppImageKit/wiki/Creating-AppImages#common-mistake) + * `maintainer` String - The maintainer. Defaults to [author](#Metadata-author). + * `vendor` String - The vendor. Defaults to [author](#Metadata-author). + * `desktop` Object<String, any> - The [Desktop file](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) entries (name to value). + * `executableName` String - 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. + * `synopsis` String - The [short description](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Description). +* `deb` - Debian package specific options. + * `compression` = `xz` "gz" | "bzip2" | "xz" - The compression type. + * `priority` String - The [Priority](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Priority) attribute. + * `depends` Array<String> - Package dependencies. Defaults to `["gconf2", "gconf-service", "libnotify4", "libappindicator1", "libxtst6", "libnss3"]`. +* `snap` - [Snap](http://snapcraft.io) options. + * `confinement` = `strict` "devmode" | "strict" | "classic" - The type of [confinement](https://snapcraft.io/docs/reference/confinement) supported by the snap. + * `summary` String - The 78 character long summary. Defaults to [productName](#Config-productName). + * `grade` = `stable` "devel" | "stable" - 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). + * `assumes` Array<String> - The list of features that must be supported by the core in order for this snap to install. + * `buildPackages` Array<String> - The list of debian packages needs to be installed for building this snap. + * `stagePackages` Array<String> - 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<String> - 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. + * `after` Array<String> - Specifies any [parts](https://snapcraft.io/docs/reference/parts) that should be built before this part. Defaults to `["desktop-only""]`. + + If list contains `default`, it will be replaced to default list, so, `["default", "foo"]` can be used to add custom parts `foo` in addition to defaults. + * `ubuntuAppPlatformContent` String - 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". +* `appimage` [LinuxTargetSpecificOptions](electron-builder#LinuxTargetSpecificOptions) +* `pacman` [LinuxTargetSpecificOptions](electron-builder#LinuxTargetSpecificOptions) +* `rpm` [LinuxTargetSpecificOptions](electron-builder#LinuxTargetSpecificOptions) +* `freebsd` [LinuxTargetSpecificOptions](electron-builder#LinuxTargetSpecificOptions) +* `p5p` [LinuxTargetSpecificOptions](electron-builder#LinuxTargetSpecificOptions) +* `apk` [LinuxTargetSpecificOptions](electron-builder#LinuxTargetSpecificOptions) + +## `Metadata` Some standard fields should be defined in the `package.json`. **Kind**: interface of [electron-builder](#module_electron-builder) **Properties** - -| Name | Type | Description | -| --- | --- | --- | -| repository| string \| [RepositoryInfo](electron-builder-core#RepositoryInfo) \| null | | -| dependencies| Object<string, any> | | -| version| string | | -| **name**| string | The application name. | -| productName| string \| null | | -| description| string | The application description. | -| main| string \| null | | -| author| [AuthorMetadata](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](#Config) | | - - - -### `MetadataDirectories` -`directories` - -**Kind**: interface of [electron-builder](#module_electron-builder) -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| buildResources = "build"| string \| null | The path to build resources. | -| output = "dist"| string \| null | The output directory. | -| app| string \| null | The application directory (containing the application package.json), defaults to `app`, `www` or working directory. | - - - -### `NsisOptions` ⇐ [TargetSpecificOptions](electron-builder-core#TargetSpecificOptions) -NSIS specific options ([nsis](#Config-nsis)). - -See [NSIS target notes](https://github.com/electron-userland/electron-builder/wiki/NSIS). - -**Kind**: interface of [electron-builder](#module_electron-builder) -**Extends**: [TargetSpecificOptions](electron-builder-core#TargetSpecificOptions) -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| oneClick = true| boolean | One-click installation. | -| perMachine| boolean | 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 = true| boolean | *boring installer only.* Allow requesting for elevation. If false, user will have to restart installer with elevated permissions. | -| allowToChangeInstallationDirectory| boolean | *boring installer only.* Whether to allow user to change installation directory. | -| runAfterFinish = true| boolean | *one-click installer only.* Run application after finish. | -| 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. | -| uninstallerIcon| string \| null | The path to uninstaller 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/uninstallerIcon.ico` or application icon. | -| installerHeader = "build/installerHeader.bmp"| 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. | -| 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 `license.rtf` or `license.txt` or `eula.rtf` or `eula.txt` (or uppercase variants, e.g. `EULA.txt` or `LICENSE.TXT`).

Multiple license files in different languages are supported — use lang postfix (e.g. `_de`, `_ru`)). For example, create files `license_de.txt` and `license_en.txt` in the build resources. If OS language is german, `license_de.txt` will be displayed. See map of [language code to name](https://github.com/meikidd/iso-639-1/blob/master/src/data.js).

Appropriate license file will be selected by user OS language. | -| 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 = true| boolean | 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. If `true`, company name will be used. Or string value. | -| 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 = true| boolean | Whether to create [Unicode installer](http://nsis.sourceforge.net/Docs/Chapter1.html#intro-unicode). | -| deleteAppDataOnUninstall| boolean | *one-click installer only.* Whether to delete app data on uninstall. | - - - -### `NsisWebOptions` ⇐ [NsisOptions](#NsisOptions) -Web Installer Specific Options ([nsisWeb](#Config-nsisWeb)). - -**Kind**: interface of [electron-builder](#module_electron-builder) -**Extends**: [NsisOptions](#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}`. | - - - -### `PackagerOptions` -**Kind**: interface of [electron-builder](#module_electron-builder) -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| targets| Map<[Platform](electron-builder-core#Platform) \| Map<[Arch](electron-builder-core#Arch) \| Array<string>>> | | -| 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](#Metadata) | Deprecated: {tag.description} | -| config| [Config](#Config) \| string \| null | | -| appMetadata| [Metadata](#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 | | - - - -### `PkgOptions` ⇐ [TargetSpecificOptions](electron-builder-core#TargetSpecificOptions) -macOS Product Archive Options ([pkg](#Config-pkg)). - -**Kind**: interface of [electron-builder](#module_electron-builder) -**Extends**: [TargetSpecificOptions](electron-builder-core#TargetSpecificOptions) -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| scripts = "build/pkg-scripts"| string \| null | The scripts directory, relative to `build` (build resources directory). 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`). See: [Scripting in installer packages](http://macinstallers.blogspot.de/2012/07/scripting-in-installer-packages.html). | -| installLocation = "/Applications"| string \| null | The install location. | -| identity| string \| null | | - - - -### `PortableOptions` ⇐ [CommonNsisOptions](electron-builder#CommonNsisOptions) -Portable Specific Options ([portable](#Config-portable)). - -**Kind**: interface of [electron-builder](#module_electron-builder) -**Extends**: [CommonNsisOptions](electron-builder#CommonNsisOptions) -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| requestExecutionLevel = user| "user" \| "highest" \| "admin" | The [requested execution level](http://nsis.sourceforge.net/Reference/RequestExecutionLevel) for Windows. | - - - -### `SnapOptions` ⇐ [LinuxBuildOptions](#LinuxBuildOptions) -[Snap](http://snapcraft.io) Options - -**Kind**: interface of [electron-builder](#module_electron-builder) -**Extends**: [LinuxBuildOptions](#LinuxBuildOptions) -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| confinement = strict| "devmode" \| "strict" \| "classic" \| null | The type of [confinement](https://snapcraft.io/docs/reference/confinement) supported by the snap. | -| summary| string \| null | The 78 character long summary. Defaults to [productName](#AppMetadata-productName). | -| grade = stable| "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). | -| assumes| Array<string> \| null | The list of features that must be supported by the core in order for this snap to install. | -| buildPackages| Array<string> \| null | The list of debian packages needs to be installed for building this snap. | -| stagePackages| Array<string> \| 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<string> \| 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. | -| after| Array<string> \| null | Specifies any [parts](https://snapcraft.io/docs/reference/parts) that should be built before this part. Defaults to `["desktop-only""]`.

If list contains `default`, it will be replaced to default list, so, `["default", "foo"]` can be used to add custom parts `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". | - - - -### `SquirrelWindowsOptions` ⇐ [WinBuildOptions](#WinBuildOptions) -Squirrel.Windows Options ([squirrelWindows](#Config-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](#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`. | - - - -### `WinBuildOptions` ⇐ [PlatformSpecificBuildOptions](electron-builder-core#PlatformSpecificBuildOptions) -Windows Specific Options ([win](#Config-win)). - -**Kind**: interface of [electron-builder](#module_electron-builder) -**Extends**: [PlatformSpecificBuildOptions](electron-builder-core#PlatformSpecificBuildOptions) -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| target| null \| string \| [TargetConfig](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<"sha1" \| "sha256"> \| null | Array of signing algorithms used. Defaults to `['sha1', 'sha256']`

For AppX `sha256` is always used. | -| icon = "build/icon.ico"| string \| null | The path to application icon. | -| 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. | -| additionalCertificateFile| string | The path to an additional certificate file you want to add to the signature block. | -| 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<string> \| 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. | -| forceCodeSigningVerification = true| boolean | Whether to verify the signature of an available update before installation. The [publisher name](WinBuildOptions#publisherName) will be used for the signature verification. | - - +* **`name`** String - The application name. +* `description` String - The application description. +* `homepage` String - 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 - *linux-only.* The [license](https://docs.npmjs.com/files/package.json#license) name. +* `author` + * **`name`** String + * `email` String +* `repository` String | [RepositoryInfo](#RepositoryInfo) - The [repository](https://docs.npmjs.com/files/package.json#repository). + * **`url`** String +* `build` [Config](#Config) + +## Build Version Management +`CFBundleVersion` (macOS) and `FileVersion` (Windows) will be set automatically to `version.build_number` on CI server (Travis, AppVeyor, CircleCI and Bamboo supported). \ No newline at end of file diff --git a/docs/Publishing Artifacts.md b/docs/Publishing Artifacts.md index 8db01be3917..9fb83bc8cde 100644 --- a/docs/Publishing Artifacts.md +++ b/docs/Publishing Artifacts.md @@ -79,8 +79,8 @@ Can be specified in the [configuration options](https://github.com/electron-user * [`.S3Options`](#S3Options) ⇐ [PublishConfiguration](#PublishConfiguration) * [`.UpdateInfo`](#UpdateInfo) ⇐ [VersionInfo](#VersionInfo) * [`.VersionInfo`](#VersionInfo) - * [`.githubUrl(options)`](#module_electron-builder-http/out/publishOptions.githubUrl) ⇒ string - * [`.s3Url(options)`](#module_electron-builder-http/out/publishOptions.s3Url) ⇒ string + * [`.githubUrl(options)`](#module_electron-builder-http/out/publishOptions.githubUrl) ⇒ String + * [`.s3Url(options)`](#module_electron-builder-http/out/publishOptions.s3Url) ⇒ String @@ -93,10 +93,10 @@ Bintray options. | Name | Type | Description | | --- | --- | --- | -| package| string \| null | The Bintray package name. | -| repo = "generic"| string \| null | The Bintray repository name. | -| user| string \| null | The Bintray user account. Used in cases where the owner is an organization. | -| token| string \| null | | +| package| String \| null | The Bintray package name. | +| repo = "generic"| String \| null | The Bintray repository name. | +| user| String \| null | The Bintray user account. Used in cases where the owner is an organization. | +| token| String \| null | | @@ -109,8 +109,8 @@ Generic (any HTTP(S) server) options. | Name | Type | 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 = "latest"| string \| null | The channel. | +| **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 = "latest"| String \| null | The channel. | @@ -126,12 +126,12 @@ Define `GH_TOKEN` environment variable. | Name | Type | Description | | --- | --- | --- | -| repo| string \| null | The repository name. [Detected automatically](#github-repository-and-bintray-package). | -| vPrefixedTagName = true| boolean | Whether to use `v`-prefixed tag name. | -| host = "github.com"| string \| null | The host (including the port if need). | +| repo| String \| null | The repository name. [Detected automatically](#github-repository-and-bintray-package). | +| vPrefixedTagName = true| Boolean | Whether to use `v`-prefixed tag name. | +| host = "github.com"| String \| null | The host (including the port if need). | | protocol = https| "https" \| "http" \| null | The protocol. GitHub Publisher supports only `https`. | -| token| string \| null | The access token to support auto-update from private github repositories. Never specify it in the configuration files. Only for [setFeedURL](module:electron-updater/out/AppUpdater.AppUpdater+setFeedURL). | -| private| boolean \| null | Whether to use private github auto-update provider if `GH_TOKEN` environment variable is set. See: https://github.com/electron-userland/electron-builder/wiki/Auto-Update#private-github-update-repo | +| token| String \| null | The access token to support auto-update from private github repositories. Never specify it in the configuration files. Only for [setFeedURL](module:electron-updater/out/AppUpdater.AppUpdater+setFeedURL). | +| private| Boolean \| null | Whether to use private github auto-update provider if `GH_TOKEN` environment variable is set. See: https://github.com/electron-userland/electron-builder/wiki/Auto-Update#private-github-update-repo | @@ -148,7 +148,7 @@ If `BT_TOKEN` is set and `GH_TOKEN` is not set — defaults to `[{provider: "bin | Name | Type | Description | | --- | --- | --- | | **provider**| "github" \| "bintray" \| "s3" \| "generic" | The provider. | -| owner| string \| null | The owner. | +| owner| String \| null | The owner. | @@ -165,10 +165,10 @@ Or in the [~/.aws/credentials](http://docs.aws.amazon.com/sdk-for-javascript/v2/ | Name | Type | Description | | --- | --- | --- | -| **bucket**| string | The bucket name. | -| path = "/"| string \| null | The directory path. | -| region| string \| null | The region. Is determined and set automatically when publishing. | -| channel = "latest"| string \| null | The channel. | +| **bucket**| String | The bucket name. | +| path = "/"| String \| null | The directory path. | +| region| String \| null | The region. Is determined and set automatically when publishing. | +| channel = "latest"| String \| null | The channel. | | acl = public-read| "private" \| "public-read" \| null | The ACL. | | storageClass = STANDARD| "STANDARD" \| "REDUCED_REDUNDANCY" \| "STANDARD_IA" \| null | The type of storage to use for the object. | @@ -188,13 +188,13 @@ Or in the [~/.aws/credentials](http://docs.aws.amazon.com/sdk-for-javascript/v2/ | Name | Type | Description | | --- | --- | --- | -| **path**| string | | -| githubArtifactName| string \| null | | -| sha2| string | | -| sha512| string | | -| releaseName| string \| null | The release name. | -| releaseNotes| string \| null | The release notes. | -| **releaseDate**| string | The release date. | +| **path**| String | | +| githubArtifactName| String \| null | | +| sha2| String | | +| sha512| String | | +| releaseName| String \| null | The release name. | +| releaseNotes| String \| null | The release notes. | +| **releaseDate**| String | The release date. | @@ -204,11 +204,11 @@ Or in the [~/.aws/credentials](http://docs.aws.amazon.com/sdk-for-javascript/v2/ | Name | Type | Description | | --- | --- | --- | -| **version**| string | The version. | +| **version**| String | The version. | -### `electron-builder-http/out/publishOptions.githubUrl(options)` ⇒ 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 | @@ -217,7 +217,7 @@ Or in the [~/.aws/credentials](http://docs.aws.amazon.com/sdk-for-javascript/v2/ -### `electron-builder-http/out/publishOptions.s3Url(options)` ⇒ string +### `electron-builder-http/out/publishOptions.s3Url(options)` ⇒ String **Kind**: method of [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) | Param | Type | diff --git a/docs/api/electron-builder-core.md b/docs/api/electron-builder-core.md index 37e8b0099a4..fa6daa960b6 100644 --- a/docs/api/electron-builder-core.md +++ b/docs/api/electron-builder-core.md @@ -3,53 +3,24 @@ ## electron-builder-core * [electron-builder-core](#module_electron-builder-core) - * [`.AsarOptions`](#AsarOptions) ⇐ module:asar-integrity.AsarIntegrityOptions - * [`.AuthorMetadata`](#AuthorMetadata) * [`.BeforeBuildContext`](#BeforeBuildContext) - * [`.FileAssociation`](#FileAssociation) * [`.FilePattern`](#FilePattern) - * [`.PlatformSpecificBuildOptions`](#PlatformSpecificBuildOptions) ⇐ [TargetSpecificOptions](#TargetSpecificOptions) - * [`.Protocol`](#Protocol) - * [`.RepositoryInfo`](#RepositoryInfo) * [`.SourceRepositoryInfo`](#SourceRepositoryInfo) * [`.TargetConfig`](#TargetConfig) * [`.TargetSpecificOptions`](#TargetSpecificOptions) * [.Platform](#Platform) - * [`.createTarget(type, archs)`](#module_electron-builder-core.Platform+createTarget) ⇒ Map<[Platform](#Platform) \| Map<[Arch](#Arch) \| Array<string>>> + * [`.createTarget(type, archs)`](#module_electron-builder-core.Platform+createTarget) ⇒ Map<[Platform](#Platform) \| Map<[Arch](#Arch) \| Array<String>>> * [`.current()`](#module_electron-builder-core.Platform+current) ⇒ [Platform](#Platform) * [`.fromString(name)`](#module_electron-builder-core.Platform+fromString) ⇒ [Platform](#Platform) - * [`.toString()`](#module_electron-builder-core.Platform+toString) ⇒ string + * [`.toString()`](#module_electron-builder-core.Platform+toString) ⇒ String * [.Target](#Target) * [`.build(appOutDir, arch)`](#module_electron-builder-core.Target+build) ⇒ Promise<any> * [`.finishBuild()`](#module_electron-builder-core.Target+finishBuild) ⇒ Promise<any> * [`.Arch`](#Arch) : enum * [`.archFromString(name)`](#module_electron-builder-core.archFromString) ⇒ [Arch](#Arch) - * [`.getArchSuffix(arch)`](#module_electron-builder-core.getArchSuffix) ⇒ string + * [`.getArchSuffix(arch)`](#module_electron-builder-core.getArchSuffix) ⇒ String * [`.toLinuxArchString(arch)`](#module_electron-builder-core.toLinuxArchString) ⇒ "armv7l" \| "i386" \| "amd64" - - -### `AsarOptions` ⇐ module:asar-integrity.AsarIntegrityOptions -**Kind**: interface of [electron-builder-core](#module_electron-builder-core) -**Extends**: module:asar-integrity.AsarIntegrityOptions -**Properties** - -| Name | Type | -| --- | --- | -| smartUnpack| boolean | -| ordering| string \| null | - - - -### `AuthorMetadata` -**Kind**: interface of [electron-builder-core](#module_electron-builder-core) -**Properties** - -| Name | Type | -| --- | --- | -| **name**| string | -| email| string | - ### `BeforeBuildContext` @@ -58,31 +29,10 @@ | Name | Type | | --- | --- | -| **appDir**| string | -| **electronVersion**| string | +| **appDir**| String | +| **electronVersion**| String | | **platform**| [Platform](#Platform) | -| **arch**| string | - - - -### `FileAssociation` -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. - -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-core](#module_electron-builder-core) -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| **ext**| string \| Array<string> | 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 \| null | 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 = "Editor"| string | *macOS-only* The app’s role with respect to the type. The value can be `Editor`, `Viewer`, `Shell`, or `None`. 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`. | +| **arch**| String | @@ -92,54 +42,9 @@ On Windows works only if [nsis.perMachine](https://github.com/electron-userland/ | Name | Type | | --- | --- | -| from| string | -| to| string | -| filter| Array<string> \| string | - - - -### `PlatformSpecificBuildOptions` ⇐ [TargetSpecificOptions](#TargetSpecificOptions) -**Kind**: interface of [electron-builder-core](#module_electron-builder-core) -**Extends**: [TargetSpecificOptions](#TargetSpecificOptions) -**Properties** - -| Name | Type | -| --- | --- | -| files| Array<string> \| string \| null | -| extraFiles| Array<string \| [FilePattern](#FilePattern)> \| [FilePattern](#FilePattern) \| string \| null | -| extraResources| Array<string \| [FilePattern](#FilePattern)> \| [FilePattern](#FilePattern) \| string \| null | -| asarUnpack| Array<string> \| string \| null | -| asar| [AsarOptions](#AsarOptions) \| boolean \| null | -| target| Array<string \| [TargetConfig](#TargetConfig)> \| string \| [TargetConfig](#TargetConfig) \| null | -| icon| string \| null | -| fileAssociations| Array<[FileAssociation](#FileAssociation)> \| [FileAssociation](#FileAssociation) | -| forceCodeSigning| boolean | - - - -### `Protocol` -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-core](#module_electron-builder-core) -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| **name**| string | The name. e.g. `IRC server URL`. | -| role = Editor| "Editor" \| "Viewer" \| "Shell" \| "None" | *macOS-only* The app’s role with respect to the type. | -| **schemes**| Array<string> | The schemes. e.g. `["irc", "ircs"]`. | - - - -### `RepositoryInfo` -**Kind**: interface of [electron-builder-core](#module_electron-builder-core) -**Properties** - -| Name | Type | -| --- | --- | -| **url**| string | +| from| String | +| to| String | +| filter| Array<String> \| String | @@ -149,10 +54,10 @@ Please note — on macOS [you need to register an `open-url` event handler](http | Name | Type | | --- | --- | -| **type**| string | -| **domain**| string | -| **user**| string | -| **project**| string | +| **type**| String | +| **domain**| String | +| **user**| String | +| **project**| String | @@ -162,8 +67,8 @@ Please note — on macOS [you need to register an `open-url` event handler](http | Name | Type | Description | | --- | --- | --- | -| **target**| string | The target name. e.g. `snap`. | -| arch| Array<"x64" \| "ia32" \| "armv7l"> \| string | The arch or list of archs. | +| **target**| String | The target name. e.g. `snap`. | +| arch| Array<"x64" \| "ia32" \| "armv7l"> \| String | The arch or list of archs. | @@ -173,8 +78,8 @@ Please note — on macOS [you need to register an `open-url` event handler](http | Name | Type | Description | | --- | --- | --- | -| artifactName| string \| null | The [artifact file name pattern](https://github.com/electron-userland/electron-builder/wiki/Options#artifact-file-name-pattern). | -| publish| null \| string \| [GithubOptions](Publishing-Artifacts#GithubOptions) \| [S3Options](Publishing-Artifacts#S3Options) \| [GenericServerOptions](Publishing-Artifacts#GenericServerOptions) \| [BintrayOptions](Publishing-Artifacts#BintrayOptions) \| Array | | +| artifactName| String \| null | The [artifact file name pattern](https://github.com/electron-userland/electron-builder/wiki/Options#artifact-file-name-pattern). | +| publish| null \| String \| [GithubOptions](Publishing-Artifacts#GithubOptions) \| [S3Options](Publishing-Artifacts#S3Options) \| [GenericServerOptions](Publishing-Artifacts#GenericServerOptions) \| [BintrayOptions](Publishing-Artifacts#BintrayOptions) \| Array | | @@ -191,19 +96,19 @@ Please note — on macOS [you need to register an `open-url` event handler](http * [.Platform](#Platform) - * [`.createTarget(type, archs)`](#module_electron-builder-core.Platform+createTarget) ⇒ Map<[Platform](#Platform) \| Map<[Arch](#Arch) \| Array<string>>> + * [`.createTarget(type, archs)`](#module_electron-builder-core.Platform+createTarget) ⇒ Map<[Platform](#Platform) \| Map<[Arch](#Arch) \| Array<String>>> * [`.current()`](#module_electron-builder-core.Platform+current) ⇒ [Platform](#Platform) * [`.fromString(name)`](#module_electron-builder-core.Platform+fromString) ⇒ [Platform](#Platform) - * [`.toString()`](#module_electron-builder-core.Platform+toString) ⇒ string + * [`.toString()`](#module_electron-builder-core.Platform+toString) ⇒ String -#### `platform.createTarget(type, archs)` ⇒ Map<[Platform](#Platform) \| Map<[Arch](#Arch) \| Array<string>>> +#### `platform.createTarget(type, archs)` ⇒ Map<[Platform](#Platform) \| Map<[Arch](#Arch) \| Array<String>>> **Kind**: instance method of [Platform](#Platform) | Param | Type | | --- | --- | -| type | string \| Array<string> \| null | +| type | String \| Array<String> \| null | | archs | Array<[Arch](#Arch)> | @@ -217,11 +122,11 @@ Please note — on macOS [you need to register an `open-url` event handler](http | Param | Type | | --- | --- | -| name | string | +| name | String | -#### `platform.toString()` ⇒ string +#### `platform.toString()` ⇒ String **Kind**: instance method of [Platform](#Platform) @@ -231,7 +136,7 @@ Please note — on macOS [you need to register an `open-url` event handler](http | Name | Type | | --- | --- | -| outDir| string | +| outDir| String | | options| [TargetSpecificOptions](#TargetSpecificOptions) \| null \| undefined | @@ -246,7 +151,7 @@ Please note — on macOS [you need to register an `open-url` event handler](http | Param | Type | | --- | --- | -| appOutDir | string | +| appOutDir | String | | arch | [Arch](#Arch) | @@ -272,11 +177,11 @@ Please note — on macOS [you need to register an `open-url` event handler](http | Param | Type | | --- | --- | -| name | string | +| name | String | -### `electron-builder-core.getArchSuffix(arch)` ⇒ string +### `electron-builder-core.getArchSuffix(arch)` ⇒ String **Kind**: method of [electron-builder-core](#module_electron-builder-core) | Param | Type | diff --git a/docs/api/electron-builder-http.md b/docs/api/electron-builder-http.md index 591b96086be..0fa52d5e993 100644 --- a/docs/api/electron-builder-http.md +++ b/docs/api/electron-builder-http.md @@ -32,10 +32,10 @@ | Name | Type | | --- | --- | -| **name**| string | -| **path**| string | -| **sha1**| string | -| **sha256**| string | +| **name**| String | +| **path**| String | +| **sha1**| String | +| **sha256**| String | @@ -45,8 +45,8 @@ | Name | Type | | --- | --- | -| **name**| string | -| **package**| string | +| **name**| String | +| **package**| String | @@ -56,11 +56,11 @@ | Name | Type | | --- | --- | -| auth| string \| null | -| repo| string | -| owner| string | -| user| string | -| packageName| string | +| auth| String \| null | +| repo| String | +| owner| String | +| user| String | +| packageName| String | * [.BintrayClient](#BintrayClient) @@ -76,7 +76,7 @@ | Param | Type | | --- | --- | -| version | string | +| version | String | @@ -85,7 +85,7 @@ | Param | Type | | --- | --- | -| version | string | +| version | String | @@ -94,7 +94,7 @@ | Param | Type | | --- | --- | -| version | string | +| version | String | @@ -103,7 +103,7 @@ | Param | Type | | --- | --- | -| version | string | +| version | String | @@ -167,11 +167,11 @@ | Name | Type | | --- | --- | -| **total**| number | -| **delta**| number | -| **transferred**| number | -| **percent**| number | -| **bytesPerSecond**| number | +| **total**| Number | +| **delta**| Number | +| **transferred**| Number | +| **percent**| Number | +| **bytesPerSecond**| Number | @@ -200,7 +200,7 @@ | Param | Type | | --- | --- | | chunk | any | -| encoding | string | +| encoding | String | | callback | function | @@ -219,13 +219,8 @@ * [.HttpError](#HttpError) ⇐ Error * [.HttpExecutor](#HttpExecutor) * [`.request(options, cancellationToken, data)`](#module_electron-builder-http.HttpExecutor+request) ⇒ Promise<module:electron-builder-http.T> - * [`.addTimeOutHandler(request, callback)`](#module_electron-builder-http.HttpExecutor+addTimeOutHandler) - * [`.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)`](#module_electron-builder-http.HttpExecutor+doApiRequest) ⇒ Promise<module:electron-builder-http.T> - * [`.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) * [`.configureRequestOptions(options, token, method)`](#module_electron-builder-http.configureRequestOptions) ⇒ module:http.RequestOptions - * [`.dumpRequestOptions(options)`](#module_electron-builder-http.dumpRequestOptions) ⇒ string + * [`.dumpRequestOptions(options)`](#module_electron-builder-http.dumpRequestOptions) ⇒ String * [`.safeGetHeader(response, headerKey)`](#module_electron-builder-http.safeGetHeader) ⇒ any @@ -237,9 +232,9 @@ | Name | Type | | --- | --- | | headers| [RequestHeaders](#RequestHeaders) \| null | -| skipDirCreation| boolean | -| sha2| string \| null | -| sha512| string \| null | +| skipDirCreation| Boolean | +| sha2| String \| null | +| sha512| String \| null | | **cancellationToken**| [CancellationToken](#CancellationToken) | @@ -264,8 +259,8 @@ | Name | Type | | --- | --- | -| statusCode| number | -| statusMessage| string | +| statusCode| Number | +| statusMessage| String | | **headers**| any | @@ -275,7 +270,7 @@ | Param | Type | | --- | --- | -| encoding | string | +| encoding | String | @@ -304,7 +299,7 @@ | Param | Type | | --- | --- | | chunk | any | -| encoding | string | +| encoding | String | | callback | function | @@ -316,21 +311,6 @@ ### HttpExecutor **Kind**: class of [electron-builder-http](#module_electron-builder-http) -**Properties** - -| Name | Type | -| --- | --- | -| maxRedirects = 10| "10" | - - -* [.HttpExecutor](#HttpExecutor) - * [`.request(options, cancellationToken, data)`](#module_electron-builder-http.HttpExecutor+request) ⇒ Promise<module:electron-builder-http.T> - * [`.addTimeOutHandler(request, callback)`](#module_electron-builder-http.HttpExecutor+addTimeOutHandler) - * [`.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)`](#module_electron-builder-http.HttpExecutor+doApiRequest) ⇒ Promise<module:electron-builder-http.T> - * [`.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.request(options, cancellationToken, data)` ⇒ Promise<module:electron-builder-http.T> @@ -340,73 +320,7 @@ | --- | --- | | options | module:http.RequestOptions | | cancellationToken | [CancellationToken](#CancellationToken) | -| data | Object<string, any> \| null | - - - -#### `httpExecutor.addTimeOutHandler(request, callback)` -**Kind**: instance method of [HttpExecutor](#HttpExecutor) -**Access**: protected - -| Param | Type | -| --- | --- | -| request | any | -| callback | callback | - - - -#### `httpExecutor.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)` ⇒ Promise<module:electron-builder-http.T> -**Kind**: instance method of [HttpExecutor](#HttpExecutor) -**Access**: protected - -| Param | Type | -| --- | --- | -| options | any | -| cancellationToken | [CancellationToken](#CancellationToken) | -| requestProcessor | callback | -| redirectCount | number | - - - -#### `httpExecutor.doDownload(requestOptions, destination, redirectCount, options, callback, onCancel)` -**Kind**: instance method of [HttpExecutor](#HttpExecutor) -**Access**: protected - -| Param | Type | -| --- | --- | -| requestOptions | any | -| destination | string | -| redirectCount | number | -| options | [DownloadOptions](#DownloadOptions) | -| callback | callback | -| onCancel | callback | - - - -#### `httpExecutor.doRequest(options, callback)` ⇒ any -**Kind**: instance method of [HttpExecutor](#HttpExecutor) -**Access**: protected - -| Param | Type | -| --- | --- | -| options | any | -| callback | callback | - - - -#### `httpExecutor.handleResponse(response, options, cancellationToken, resolve, reject, redirectCount, requestProcessor)` -**Kind**: instance method of [HttpExecutor](#HttpExecutor) -**Access**: protected - -| Param | Type | -| --- | --- | -| response | [Response](#Response) | -| options | module:http.RequestOptions | -| cancellationToken | [CancellationToken](#CancellationToken) | -| resolve | callback | -| reject | callback | -| redirectCount | number | -| requestProcessor | callback | +| data | Object<String, any> \| null | @@ -416,12 +330,12 @@ | Param | Type | | --- | --- | | options | module:http.RequestOptions | -| token | string \| null | +| token | String \| null | | method | "GET" \| "DELETE" \| "PUT" | -### `electron-builder-http.dumpRequestOptions(options)` ⇒ string +### `electron-builder-http.dumpRequestOptions(options)` ⇒ String **Kind**: method of [electron-builder-http](#module_electron-builder-http) | Param | Type | @@ -436,5 +350,5 @@ | Param | Type | | --- | --- | | response | any | -| headerKey | string | +| headerKey | String | diff --git a/docs/api/electron-builder-util.md b/docs/api/electron-builder-util.md index d293aea56c9..611193251ba 100644 --- a/docs/api/electron-builder-util.md +++ b/docs/api/electron-builder-util.md @@ -24,43 +24,43 @@ ## 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<string> - * [`.getBinFromBintray(name, version, sha2)`](#module_electron-builder-util/out/binDownload.getBinFromBintray) ⇒ Promise<string> - * [`.getBinFromGithub(name, version, sha2)`](#module_electron-builder-util/out/binDownload.getBinFromGithub) ⇒ Promise<string> + * [`.getBin(name, dirName, url, sha2)`](#module_electron-builder-util/out/binDownload.getBin) ⇒ Promise<String> + * [`.getBinFromBintray(name, version, sha2)`](#module_electron-builder-util/out/binDownload.getBinFromBintray) ⇒ Promise<String> + * [`.getBinFromGithub(name, version, sha2)`](#module_electron-builder-util/out/binDownload.getBinFromGithub) ⇒ Promise<String> -### `electron-builder-util/out/binDownload.getBin(name, dirName, url, sha2)` ⇒ Promise<string> +### `electron-builder-util/out/binDownload.getBin(name, dirName, url, sha2)` ⇒ Promise<String> **Kind**: method of [electron-builder-util/out/binDownload](#module_electron-builder-util/out/binDownload) | Param | Type | | --- | --- | -| name | string | -| dirName | string | -| url | string | -| sha2 | string | +| name | String | +| dirName | String | +| url | String | +| sha2 | String | -### `electron-builder-util/out/binDownload.getBinFromBintray(name, version, sha2)` ⇒ Promise<string> +### `electron-builder-util/out/binDownload.getBinFromBintray(name, version, sha2)` ⇒ Promise<String> **Kind**: method of [electron-builder-util/out/binDownload](#module_electron-builder-util/out/binDownload) | Param | Type | | --- | --- | -| name | string | -| version | string | -| sha2 | string | +| name | String | +| version | String | +| sha2 | String | -### `electron-builder-util/out/binDownload.getBinFromGithub(name, version, sha2)` ⇒ Promise<string> +### `electron-builder-util/out/binDownload.getBinFromGithub(name, version, sha2)` ⇒ Promise<String> **Kind**: method of [electron-builder-util/out/binDownload](#module_electron-builder-util/out/binDownload) | Param | Type | | --- | --- | -| name | string | -| version | string | -| sha2 | string | +| name | String | +| version | String | +| sha2 | String | @@ -84,10 +84,10 @@ * [`.copy(src, dest, stat)`](#module_electron-builder-util/out/fs.FileCopier+copy) ⇒ Promise<void> * [`.copyDir(src, destination, filter, transformer, isUseHardLink)`](#module_electron-builder-util/out/fs.copyDir) ⇒ Promise<any> * [`.copyFile(src, dest, stats, isUseHardLink)`](#module_electron-builder-util/out/fs.copyFile) ⇒ Promise<any> - * [`.exists(file)`](#module_electron-builder-util/out/fs.exists) ⇒ Promise<boolean> + * [`.exists(file)`](#module_electron-builder-util/out/fs.exists) ⇒ Promise<Boolean> * [`.statOrNull(file)`](#module_electron-builder-util/out/fs.statOrNull) ⇒ Promise< \| module:fs.Stats> - * [`.unlinkIfExists(file)`](#module_electron-builder-util/out/fs.unlinkIfExists) ⇒ Promise<string \| void> - * [`.walk(initialDirPath, filter, consumer)`](#module_electron-builder-util/out/fs.walk) ⇒ Promise<Array<string>> + * [`.unlinkIfExists(file)`](#module_electron-builder-util/out/fs.unlinkIfExists) ⇒ Promise<String \| void> + * [`.walk(initialDirPath, filter, consumer)`](#module_electron-builder-util/out/fs.walk) ⇒ Promise<Array<String>> @@ -100,8 +100,8 @@ | Param | Type | | --- | --- | -| src | string | -| dest | string | +| src | String | +| dest | String | | stat | module:fs.Stats \| undefined | @@ -114,8 +114,8 @@ Hard links is used if supported and allowed. | Param | Type | | --- | --- | -| src | string | -| destination | string | +| src | String | +| destination | String | | filter | module:electron-builder-util/out/fs.__type | | transformer | module:electron-builder-util/out/fs.__type | | isUseHardLink | callback | @@ -130,19 +130,19 @@ File permission is fixed — allow execute for all if owner can, allow read for | Param | Type | | --- | --- | -| src | string | -| dest | string | +| src | String | +| dest | String | | stats | module:fs.Stats \| null | | isUseHardLink | | -### `electron-builder-util/out/fs.exists(file)` ⇒ Promise<boolean> +### `electron-builder-util/out/fs.exists(file)` ⇒ Promise<Boolean> **Kind**: method of [electron-builder-util/out/fs](#module_electron-builder-util/out/fs) | Param | Type | | --- | --- | -| file | string | +| file | String | @@ -151,25 +151,25 @@ File permission is fixed — allow execute for all if owner can, allow read for | Param | Type | | --- | --- | -| file | string | +| file | String | -### `electron-builder-util/out/fs.unlinkIfExists(file)` ⇒ Promise<string \| void> +### `electron-builder-util/out/fs.unlinkIfExists(file)` ⇒ Promise<String \| void> **Kind**: method of [electron-builder-util/out/fs](#module_electron-builder-util/out/fs) | Param | Type | | --- | --- | -| file | string | +| file | String | -### `electron-builder-util/out/fs.walk(initialDirPath, filter, consumer)` ⇒ Promise<Array<string>> +### `electron-builder-util/out/fs.walk(initialDirPath, filter, consumer)` ⇒ Promise<Array<String>> **Kind**: method of [electron-builder-util/out/fs](#module_electron-builder-util/out/fs) | Param | Type | | --- | --- | -| initialDirPath | string | +| initialDirPath | String | | filter | module:electron-builder-util/out/fs.__type \| null | | consumer | callback | @@ -191,7 +191,7 @@ File permission is fixed — allow execute for all if owner can, allow read for | Param | Type | | --- | --- | -| message | string | +| message | String | @@ -209,7 +209,7 @@ File permission is fixed — allow execute for all if owner can, allow read for | Param | Type | | --- | --- | -| title | string | +| title | String | | promise | module:bluebird-lst.Bluebird<any> \| Promise<any> | @@ -219,7 +219,7 @@ File permission is fixed — allow execute for all if owner can, allow read for | Param | Type | | --- | --- | -| title | string | +| title | String | | promise | module:bluebird-lst.Bluebird<any> \| Promise<any> | @@ -229,7 +229,7 @@ File permission is fixed — allow execute for all if owner can, allow read for | Param | Type | | --- | --- | -| message | string | +| message | String | @@ -238,8 +238,7 @@ File permission is fixed — allow execute for all if owner can, allow read for * [electron-builder-util/out/nodeHttpExecutor](#module_electron-builder-util/out/nodeHttpExecutor) * [.NodeHttpExecutor](#NodeHttpExecutor) ⇐ [HttpExecutor](electron-builder-http#HttpExecutor) * [`.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)`](#module_electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor+doApiRequest) ⇒ Promise<module:electron-builder-util/out/nodeHttpExecutor.T> - * [`.download(url, destination, options)`](#module_electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor+download) ⇒ Promise<string> - * [`.doRequest(options, callback)`](#module_electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor+doRequest) ⇒ any + * [`.download(url, destination, options)`](#module_electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor+download) ⇒ Promise<String> * [`.httpExecutor`](#module_electron-builder-util/out/nodeHttpExecutor.httpExecutor) : [NodeHttpExecutor](#NodeHttpExecutor) @@ -250,8 +249,7 @@ File permission is fixed — allow execute for all if owner can, allow read for * [.NodeHttpExecutor](#NodeHttpExecutor) ⇐ [HttpExecutor](electron-builder-http#HttpExecutor) * [`.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)`](#module_electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor+doApiRequest) ⇒ Promise<module:electron-builder-util/out/nodeHttpExecutor.T> - * [`.download(url, destination, options)`](#module_electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor+download) ⇒ Promise<string> - * [`.doRequest(options, callback)`](#module_electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor+doRequest) ⇒ any + * [`.download(url, destination, options)`](#module_electron-builder-util/out/nodeHttpExecutor.NodeHttpExecutor+download) ⇒ Promise<String> @@ -263,30 +261,19 @@ File permission is fixed — allow execute for all if owner can, allow read for | options | module:https.RequestOptions | | cancellationToken | [CancellationToken](electron-builder-http#CancellationToken) | | requestProcessor | callback | -| redirectCount | number | +| redirectCount | Number | -#### `nodeHttpExecutor.download(url, destination, options)` ⇒ Promise<string> +#### `nodeHttpExecutor.download(url, destination, options)` ⇒ Promise<String> **Kind**: instance method of [NodeHttpExecutor](#NodeHttpExecutor) | Param | Type | | --- | --- | -| url | string | -| destination | string | +| url | String | +| destination | String | | options | [DownloadOptions](electron-builder-http#DownloadOptions) | - - -#### `nodeHttpExecutor.doRequest(options, callback)` ⇒ any -**Kind**: instance method of [NodeHttpExecutor](#NodeHttpExecutor) -**Access**: protected - -| Param | Type | -| --- | --- | -| options | any | -| callback | callback | - ### `electron-builder-util/out/nodeHttpExecutor.httpExecutor` : [NodeHttpExecutor](#NodeHttpExecutor) @@ -361,7 +348,7 @@ File permission is fixed — allow execute for all if owner can, allow read for * [electron-builder-util/out/tmp](#module_electron-builder-util/out/tmp) * [.TmpDir](#TmpDir) * [`.cleanup()`](#module_electron-builder-util/out/tmp.TmpDir+cleanup) ⇒ Promise<any> - * [`.getTempFile(suffix)`](#module_electron-builder-util/out/tmp.TmpDir+getTempFile) ⇒ Promise<string> + * [`.getTempFile(suffix)`](#module_electron-builder-util/out/tmp.TmpDir+getTempFile) ⇒ Promise<String> @@ -370,7 +357,7 @@ File permission is fixed — allow execute for all if owner can, allow read for * [.TmpDir](#TmpDir) * [`.cleanup()`](#module_electron-builder-util/out/tmp.TmpDir+cleanup) ⇒ Promise<any> - * [`.getTempFile(suffix)`](#module_electron-builder-util/out/tmp.TmpDir+getTempFile) ⇒ Promise<string> + * [`.getTempFile(suffix)`](#module_electron-builder-util/out/tmp.TmpDir+getTempFile) ⇒ Promise<String> @@ -378,12 +365,12 @@ File permission is fixed — allow execute for all if owner can, allow read for **Kind**: instance method of [TmpDir](#TmpDir) -#### `tmpDir.getTempFile(suffix)` ⇒ Promise<string> +#### `tmpDir.getTempFile(suffix)` ⇒ Promise<String> **Kind**: instance method of [TmpDir](#TmpDir) | Param | Type | | --- | --- | -| suffix | string | +| suffix | String | @@ -395,22 +382,22 @@ File permission is fixed — allow execute for all if owner can, allow read for * [.Lazy](#Lazy) * [`.addValue(map, key, value)`](#module_electron-builder-util.addValue) * [`.asArray(v)`](#module_electron-builder-util.asArray) ⇒ Array<module:electron-builder-util.T> - * [`.computeDefaultAppDirectory(projectDir, userAppDir)`](#module_electron-builder-util.computeDefaultAppDirectory) ⇒ Promise<string> - * [`.debug7zArgs(command)`](#module_electron-builder-util.debug7zArgs) ⇒ Array<string> + * [`.computeDefaultAppDirectory(projectDir, userAppDir)`](#module_electron-builder-util.computeDefaultAppDirectory) ⇒ Promise<String> + * [`.debug7zArgs(command)`](#module_electron-builder-util.debug7zArgs) ⇒ Array<String> * [`.doSpawn(command, args, options, pipeInput)`](#module_electron-builder-util.doSpawn) ⇒ module:child_process.ChildProcess - * [`.exec(file, args, options)`](#module_electron-builder-util.exec) ⇒ Promise<string> - * [`.execWine(file, args, options)`](#module_electron-builder-util.execWine) ⇒ Promise<string> - * [`.getCacheDirectory()`](#module_electron-builder-util.getCacheDirectory) ⇒ string - * [`.getPlatformIconFileName(value, isMac)`](#module_electron-builder-util.getPlatformIconFileName) ⇒ undefined \| null \| string - * [`.getTempName(prefix)`](#module_electron-builder-util.getTempName) ⇒ string + * [`.exec(file, args, options)`](#module_electron-builder-util.exec) ⇒ Promise<String> + * [`.execWine(file, args, options)`](#module_electron-builder-util.execWine) ⇒ Promise<String> + * [`.getCacheDirectory()`](#module_electron-builder-util.getCacheDirectory) ⇒ String + * [`.getPlatformIconFileName(value, isMac)`](#module_electron-builder-util.getPlatformIconFileName) ⇒ undefined \| null \| String + * [`.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 + * [`.isEmptyOrSpaces(s)`](#module_electron-builder-util.isEmptyOrSpaces) ⇒ Boolean * [`.isPullRequest()`](#module_electron-builder-util.isPullRequest) ⇒ "undefined" \| "undefined" \| "" - * [`.prepareArgs(args, exePath)`](#module_electron-builder-util.prepareArgs) ⇒ Array<string> - * [`.removePassword(input)`](#module_electron-builder-util.removePassword) ⇒ string - * [`.replaceDefault(inList, defaultList)`](#module_electron-builder-util.replaceDefault) ⇒ Array<string> - * [`.safeStringifyJson(data, skippedNames)`](#module_electron-builder-util.safeStringifyJson) ⇒ string - * [`.smarten(s)`](#module_electron-builder-util.smarten) ⇒ string + * [`.prepareArgs(args, exePath)`](#module_electron-builder-util.prepareArgs) ⇒ Array<String> + * [`.removePassword(input)`](#module_electron-builder-util.removePassword) ⇒ String + * [`.replaceDefault(inList, defaultList)`](#module_electron-builder-util.replaceDefault) ⇒ Array<String> + * [`.safeStringifyJson(data, skippedNames)`](#module_electron-builder-util.safeStringifyJson) ⇒ String + * [`.smarten(s)`](#module_electron-builder-util.smarten) ⇒ String * [`.spawn(command, args, options)`](#module_electron-builder-util.spawn) ⇒ Promise<any> * [`.use(value, task)`](#module_electron-builder-util.use) ⇒ null \| module:electron-builder-util.R @@ -422,7 +409,7 @@ File permission is fixed — allow execute for all if owner can, allow read for | Name | Type | | --- | --- | -| cwd| string | +| cwd| String | | env| any | | stdio| any | @@ -436,10 +423,10 @@ File permission is fixed — allow execute for all if owner can, allow read for | Name | Type | | --- | --- | | customFds| any | -| encoding| string | -| timeout| number | -| maxBuffer| number | -| killSignal| string | +| encoding| String | +| timeout| Number | +| maxBuffer| Number | +| killSignal| String | @@ -467,17 +454,17 @@ File permission is fixed — allow execute for all if owner can, allow read for -### `electron-builder-util.computeDefaultAppDirectory(projectDir, userAppDir)` ⇒ Promise<string> +### `electron-builder-util.computeDefaultAppDirectory(projectDir, userAppDir)` ⇒ Promise<String> **Kind**: method of [electron-builder-util](#module_electron-builder-util) | Param | Type | | --- | --- | -| projectDir | string | -| userAppDir | string \| null \| undefined | +| projectDir | String | +| userAppDir | String \| null \| undefined | -### `electron-builder-util.debug7zArgs(command)` ⇒ Array<string> +### `electron-builder-util.debug7zArgs(command)` ⇒ Array<String> **Kind**: method of [electron-builder-util](#module_electron-builder-util) | Param | Type | @@ -491,55 +478,55 @@ File permission is fixed — allow execute for all if owner can, allow read for | Param | Type | | --- | --- | -| command | string | -| args | Array<string> | +| command | String | +| args | Array<String> | | options | module:child_process.SpawnOptions | | pipeInput | Boolean | -### `electron-builder-util.exec(file, args, options)` ⇒ Promise<string> +### `electron-builder-util.exec(file, args, options)` ⇒ Promise<String> **Kind**: method of [electron-builder-util](#module_electron-builder-util) | Param | Type | | --- | --- | -| file | string | -| args | Array<string> \| null | +| file | String | +| args | Array<String> \| null | | options | [ExecOptions](#ExecOptions) | -### `electron-builder-util.execWine(file, args, options)` ⇒ Promise<string> +### `electron-builder-util.execWine(file, args, options)` ⇒ Promise<String> **Kind**: method of [electron-builder-util](#module_electron-builder-util) | Param | Type | | --- | --- | -| file | string | -| args | Array<string> | +| file | String | +| args | Array<String> | | options | [ExecOptions](#ExecOptions) | -### `electron-builder-util.getCacheDirectory()` ⇒ string +### `electron-builder-util.getCacheDirectory()` ⇒ String **Kind**: method of [electron-builder-util](#module_electron-builder-util) -### `electron-builder-util.getPlatformIconFileName(value, isMac)` ⇒ undefined \| null \| string +### `electron-builder-util.getPlatformIconFileName(value, isMac)` ⇒ undefined \| null \| String **Kind**: method of [electron-builder-util](#module_electron-builder-util) | Param | Type | | --- | --- | -| value | string \| null \| undefined | -| isMac | boolean | +| value | String \| null \| undefined | +| isMac | Boolean | -### `electron-builder-util.getTempName(prefix)` ⇒ string +### `electron-builder-util.getTempName(prefix)` ⇒ String **Kind**: method of [electron-builder-util](#module_electron-builder-util) | Param | Type | | --- | --- | -| prefix | string \| null \| undefined | +| prefix | String \| null \| undefined | @@ -548,20 +535,20 @@ File permission is fixed — allow execute for all if owner can, allow read for | Param | Type | | --- | --- | -| event | string | +| event | String | | childProcess | module:child_process.ChildProcess | -| command | string | +| command | String | | resolve | module:electron-builder-util.__type \| null | | reject | callback | -### `electron-builder-util.isEmptyOrSpaces(s)` ⇒ boolean +### `electron-builder-util.isEmptyOrSpaces(s)` ⇒ Boolean **Kind**: method of [electron-builder-util](#module_electron-builder-util) | Param | Type | | --- | --- | -| s | string \| null \| undefined | +| s | String \| null \| undefined | @@ -569,51 +556,51 @@ File permission is fixed — allow execute for all if owner can, allow read for **Kind**: method of [electron-builder-util](#module_electron-builder-util) -### `electron-builder-util.prepareArgs(args, exePath)` ⇒ Array<string> +### `electron-builder-util.prepareArgs(args, exePath)` ⇒ Array<String> **Kind**: method of [electron-builder-util](#module_electron-builder-util) | Param | Type | | --- | --- | -| args | Array<string> | -| exePath | string | +| args | Array<String> | +| exePath | String | -### `electron-builder-util.removePassword(input)` ⇒ string +### `electron-builder-util.removePassword(input)` ⇒ String **Kind**: method of [electron-builder-util](#module_electron-builder-util) | Param | Type | | --- | --- | -| input | string | +| input | String | -### `electron-builder-util.replaceDefault(inList, defaultList)` ⇒ Array<string> +### `electron-builder-util.replaceDefault(inList, defaultList)` ⇒ Array<String> **Kind**: method of [electron-builder-util](#module_electron-builder-util) | Param | Type | | --- | --- | -| inList | Array<string> \| null \| undefined | -| defaultList | Array<string> | +| inList | Array<String> \| null \| undefined | +| defaultList | Array<String> | -### `electron-builder-util.safeStringifyJson(data, skippedNames)` ⇒ string +### `electron-builder-util.safeStringifyJson(data, skippedNames)` ⇒ String **Kind**: method of [electron-builder-util](#module_electron-builder-util) | Param | Type | | --- | --- | | data | any | -| skippedNames | Set<string> | +| skippedNames | Set<String> | -### `electron-builder-util.smarten(s)` ⇒ string +### `electron-builder-util.smarten(s)` ⇒ String **Kind**: method of [electron-builder-util](#module_electron-builder-util) | Param | Type | | --- | --- | -| s | string | +| s | String | @@ -622,8 +609,8 @@ File permission is fixed — allow execute for all if owner can, allow read for | Param | Type | | --- | --- | -| command | string | -| args | Array<string> \| null | +| command | String | +| args | Array<String> \| null | | options | module:child_process.SpawnOptions | diff --git a/docs/api/electron-builder.md b/docs/api/electron-builder.md index 041ef966e3f..c7d9df3ac43 100644 --- a/docs/api/electron-builder.md +++ b/docs/api/electron-builder.md @@ -1,6 +1,6 @@ -Developer API only. See [[Options]] for user documentation. - - + Developer API only. See [[Options]] for user documentation. + + ## Modules
@@ -12,16 +12,10 @@ Developer API only. See [[Options]] for user documentation.
electron-builder/out/codeSign
-
electron-builder/out/forge/forge-maker
-
electron-builder/out/linuxPackager
electron-builder/out/macPackager
-
electron-builder/out/options/linuxOptions
-
-
electron-builder/out/options/winOptions
-
electron-builder/out/packager/mac
electron-builder/out/packager
@@ -52,8 +46,6 @@ Developer API only. See [[Options]] for user documentation.
electron-builder/out/targets/WebInstallerTarget
-
electron-builder/out/util/readPackageJson
-
electron-builder/out/windowsCodeSign
electron-builder/out/winPackager
@@ -71,15 +63,20 @@ Developer API only. See [[Options]] for user documentation. * [`.afterPack(context)`](#module_electron-builder.BuildInfo+afterPack) ⇒ Promise<void> * [`.dispatchArtifactCreated(event)`](#module_electron-builder.BuildInfo+dispatchArtifactCreated) * [`.BuildResult`](#BuildResult) + * [`.CommonLinuxOptions`](#CommonLinuxOptions) + * [`.CommonNsisOptions`](#CommonNsisOptions) + * [`.ForgeOptions`](#ForgeOptions) + * [`.LinuxTargetSpecificOptions`](#LinuxTargetSpecificOptions) ⇐ [CommonLinuxOptions](#CommonLinuxOptions) + * [`.PlatformSpecificBuildOptions`](#PlatformSpecificBuildOptions) ⇐ [TargetSpecificOptions](electron-builder-core#TargetSpecificOptions) * [.Packager](#Packager) ⇐ [BuildInfo](#BuildInfo) * [`.addAfterPackHandler(handler)`](#module_electron-builder.Packager+addAfterPackHandler) * [`.afterPack(context)`](#module_electron-builder.Packager+afterPack) ⇒ Promise<void> * [`.artifactCreated(handler)`](#module_electron-builder.Packager+artifactCreated) ⇒ [Packager](#Packager) * [`.build()`](#module_electron-builder.Packager+build) ⇒ Promise<[BuildResult](#BuildResult)> * [`.dispatchArtifactCreated(event)`](#module_electron-builder.Packager+dispatchArtifactCreated) - * [`.build(rawOptions)`](#module_electron-builder.build) ⇒ Promise<Array<string>> - * [`.buildForge(forgeOptions, options)`](#module_electron-builder.buildForge) ⇒ Promise<Array<string>> - * [`.createTargets(platforms, type, arch)`](#module_electron-builder.createTargets) ⇒ Map<[Platform](electron-builder-core#Platform) \| Map<[Arch](electron-builder-core#Arch) \| Array<string>>> + * [`.build(rawOptions)`](#module_electron-builder.build) ⇒ Promise<Array<String>> + * [`.buildForge(forgeOptions, options)`](#module_electron-builder.buildForge) ⇒ Promise<Array<String>> + * [`.createTargets(platforms, type, arch)`](#module_electron-builder.createTargets) ⇒ Map<[Platform](electron-builder-core#Platform) \| Map<[Arch](electron-builder-core#Arch) \| Array<String>>> @@ -89,9 +86,9 @@ Developer API only. See [[Options]] for user documentation. | Name | Type | | --- | --- | -| **appOutDir**| string | +| **appOutDir**| String | | **packager**| [PlatformPackager](#PlatformPackager)<any> | -| **electronPlatformName**| string | +| **electronPlatformName**| String | | **arch**| [Arch](electron-builder-core#Arch) | | **targets**| Array<[Target](electron-builder-core#Target)> | @@ -106,9 +103,9 @@ Developer API only. See [[Options]] for user documentation. | **packager**| [PlatformPackager](#PlatformPackager)<any> | | target| [Target](electron-builder-core#Target) \| null | | arch| [Arch](electron-builder-core#Arch) \| null | -| file| string | +| file| String | | data| Buffer | -| safeArtifactName| string | +| safeArtifactName| String | | publishConfig| [PublishConfiguration](Publishing-Artifacts#PublishConfiguration) | @@ -123,16 +120,16 @@ Developer API only. See [[Options]] for user documentation. | **metadata**| [Metadata](Options#Metadata) | | **devMetadata**| [Metadata](Options#Metadata) | | **config**| [Config](Options#Config) | -| **projectDir**| string | -| **appDir**| string | -| **electronVersion**| string | -| muonVersion| string \| null | -| **isTwoPackageJsonProjectLayoutUsed**| boolean | +| **projectDir**| String | +| **appDir**| String | +| **electronVersion**| String | +| muonVersion| String \| null | +| **isTwoPackageJsonProjectLayoutUsed**| Boolean | | **appInfo**| [AppInfo](#AppInfo) | | **tempDirManager**| [TmpDir](electron-builder-util#TmpDir) | | **repositoryInfo**| Promise< \| [SourceRepositoryInfo](electron-builder-core#SourceRepositoryInfo)> | -| **isPrepackedAppAsar**| boolean | -| prepackaged| string \| null | +| **isPrepackedAppAsar**| Boolean | +| prepackaged| String \| null | | **cancellationToken**| [CancellationToken](electron-builder-http#CancellationToken) | @@ -166,9 +163,80 @@ Developer API only. See [[Options]] for user documentation. | Name | Type | | --- | --- | -| **outDir**| string | +| **outDir**| String | | **platformToTargets**| Map<[Platform](electron-builder-core#Platform) \| Map<String \| [Target](electron-builder-core#Target)>> | + + +### `CommonLinuxOptions` +**Kind**: interface of [electron-builder](Options#module_electron-builder) +**Properties** + +| Name | Type | +| --- | --- | +| synopsis| String \| null | +| description| String \| null | +| category| String \| null | +| packageCategory| String \| null | +| desktop| Object<String, any> \| null | +| vendor| String \| null | +| maintainer| String \| null | +| afterInstall| String \| null | +| afterRemove| String \| null | + + + +### `CommonNsisOptions` +**Kind**: interface of [electron-builder](Options#module_electron-builder) +**Properties** + +| Name | Type | +| --- | --- | +| unicode| Boolean | +| guid| String \| null | +| warningsAsErrors| Boolean | + + + +### `ForgeOptions` +**Kind**: interface of [electron-builder](Options#module_electron-builder) +**Properties** + +| Name | Type | +| --- | --- | +| **dir**| String | + + + +### `LinuxTargetSpecificOptions` ⇐ [CommonLinuxOptions](#CommonLinuxOptions) +**Kind**: interface of [electron-builder](Options#module_electron-builder) +**Extends**: [CommonLinuxOptions](#CommonLinuxOptions) +**Properties** + +| Name | Type | Description | +| --- | --- | --- | +| depends| Array<String> \| null | Package dependencies. | +| icon| String | | + + + +### `PlatformSpecificBuildOptions` ⇐ [TargetSpecificOptions](electron-builder-core#TargetSpecificOptions) +**Kind**: interface of [electron-builder](Options#module_electron-builder) +**Extends**: [TargetSpecificOptions](electron-builder-core#TargetSpecificOptions) +**Properties** + +| Name | Type | +| --- | --- | +| files| Array<String> \| String \| null | +| extraFiles| Array<String \| [FilePattern](electron-builder-core#FilePattern)> \| [FilePattern](electron-builder-core#FilePattern) \| String \| null | +| extraResources| Array<String \| [FilePattern](electron-builder-core#FilePattern)> \| [FilePattern](electron-builder-core#FilePattern) \| String \| null | +| asarUnpack| Array<String> \| String \| null | +| asar| [AsarOptions](Options#AsarOptions) \| Boolean \| null | +| target| Array<String \| [TargetConfig](electron-builder-core#TargetConfig)> \| String \| [TargetConfig](electron-builder-core#TargetConfig) \| null | +| icon| String \| null | +| fileAssociations| Array<[FileAssociation](Options#FileAssociation)> \| [FileAssociation](Options#FileAssociation) | +| forceCodeSigning| Boolean | + ### Packager ⇐ [BuildInfo](#BuildInfo) @@ -178,17 +246,17 @@ Developer API only. See [[Options]] for user documentation. | Name | Type | | --- | --- | -| projectDir| string | -| **appDir**| string | +| projectDir| String | +| **appDir**| String | | **metadata**| [Metadata](Options#Metadata) | | **devMetadata**| [Metadata](Options#Metadata) | -| isTwoPackageJsonProjectLayoutUsed = true| boolean | -| **electronVersion**| string | -| muonVersion| string \| null | +| isTwoPackageJsonProjectLayoutUsed = true| Boolean | +| **electronVersion**| String | +| muonVersion| String \| null | | eventEmitter = new EventEmitter()| internal:EventEmitter | | **appInfo**| [AppInfo](#AppInfo) | | tempDirManager = new TmpDir()| [TmpDir](electron-builder-util#TmpDir) | -| prepackaged| string \| null | +| prepackaged| String \| null | * [.Packager](#Packager) ⇐ [BuildInfo](#BuildInfo) @@ -242,7 +310,7 @@ Developer API only. See [[Options]] for user documentation. -### `electron-builder.build(rawOptions)` ⇒ Promise<Array<string>> +### `electron-builder.build(rawOptions)` ⇒ Promise<Array<String>> **Kind**: method of [electron-builder](Options#module_electron-builder) | Param | Type | @@ -251,7 +319,7 @@ Developer API only. See [[Options]] for user documentation. -### `electron-builder.buildForge(forgeOptions, options)` ⇒ Promise<Array<string>> +### `electron-builder.buildForge(forgeOptions, options)` ⇒ Promise<Array<String>> **Kind**: method of [electron-builder](Options#module_electron-builder) | Param | Type | @@ -261,14 +329,14 @@ Developer API only. See [[Options]] for user documentation. -### `electron-builder.createTargets(platforms, type, arch)` ⇒ Map<[Platform](electron-builder-core#Platform) \| Map<[Arch](electron-builder-core#Arch) \| Array<string>>> +### `electron-builder.createTargets(platforms, type, arch)` ⇒ Map<[Platform](electron-builder-core#Platform) \| Map<[Arch](electron-builder-core#Arch) \| Array<String>>> **Kind**: method of [electron-builder](Options#module_electron-builder) | Param | Type | | --- | --- | | platforms | Array<[Platform](electron-builder-core#Platform)> | -| type | string \| null | -| arch | string \| null | +| type | String \| null | +| arch | String \| null | @@ -276,7 +344,7 @@ Developer API only. See [[Options]] for user documentation. * [electron-builder/out/appInfo](#module_electron-builder/out/appInfo) * [.AppInfo](#AppInfo) - * [`.computePackageUrl()`](#module_electron-builder/out/appInfo.AppInfo+computePackageUrl) ⇒ Promise< \| string> + * [`.computePackageUrl()`](#module_electron-builder/out/appInfo.AppInfo+computePackageUrl) ⇒ Promise< \| String> @@ -286,29 +354,20 @@ Developer API only. See [[Options]] for user documentation. | Name | Type | | --- | --- | -| description = "smarten(this.metadata.description || \"\")"| string | -| version| string | -| buildNumber| string | -| buildVersion| string | -| productName| string | -| productFilename| string | +| description = "smarten(this.metadata.description || \"\")"| String | +| version| String | +| buildNumber| String | +| buildVersion| String | +| productName| String | +| productFilename| String | -#### `appInfo.computePackageUrl()` ⇒ Promise< \| string> +#### `appInfo.computePackageUrl()` ⇒ Promise< \| String> **Kind**: instance method of [AppInfo](#AppInfo) ## electron-builder/out/builder - - -### `electron-builder/out/builder.normalizeOptions(args)` ⇒ [BuildOptions](Options#BuildOptions) -**Kind**: method of [electron-builder/out/builder](#module_electron-builder/out/builder) - -| Param | Type | -| --- | --- | -| args | [CliOptions](Options#CliOptions) | - ## electron-builder/out/codeSign @@ -316,10 +375,10 @@ Developer API only. See [[Options]] for user documentation. * [electron-builder/out/codeSign](#module_electron-builder/out/codeSign) * [`.CodeSigningInfo`](#CodeSigningInfo) * [`.CreateKeychainOptions`](#CreateKeychainOptions) - * [`.findIdentityRawResult`](#module_electron-builder/out/codeSign.findIdentityRawResult) : Promise<Array<string>> \| null + * [`.findIdentityRawResult`](#module_electron-builder/out/codeSign.findIdentityRawResult) : Promise<Array<String>> \| null * [`.createKeychain(undefined)`](#module_electron-builder/out/codeSign.createKeychain) ⇒ Promise<[CodeSigningInfo](#CodeSigningInfo)> - * [`.downloadCertificate(urlOrBase64, tmpDir, currentDir)`](#module_electron-builder/out/codeSign.downloadCertificate) ⇒ Promise<string> - * [`.findIdentity(certType, qualifier, keychain)`](#module_electron-builder/out/codeSign.findIdentity) ⇒ Promise< \| string> + * [`.downloadCertificate(urlOrBase64, tmpDir, currentDir)`](#module_electron-builder/out/codeSign.downloadCertificate) ⇒ Promise<String> + * [`.findIdentity(certType, qualifier, keychain)`](#module_electron-builder/out/codeSign.findIdentity) ⇒ Promise< \| String> * [`.sign(path, name, keychain)`](#module_electron-builder/out/codeSign.sign) ⇒ Promise<any> @@ -330,7 +389,7 @@ Developer API only. See [[Options]] for user documentation. | Name | Type | | --- | --- | -| keychainName| string \| null | +| keychainName| String \| null | @@ -341,15 +400,15 @@ Developer API only. See [[Options]] for user documentation. | Name | Type | | --- | --- | | **tmpDir**| [TmpDir](electron-builder-util#TmpDir) | -| **cscLink**| string | -| **cscKeyPassword**| string | -| cscILink| string \| null | -| cscIKeyPassword| string \| null | -| **currentDir**| string | +| **cscLink**| String | +| **cscKeyPassword**| String | +| cscILink| String \| null | +| cscIKeyPassword| String \| null | +| **currentDir**| String | -### `electron-builder/out/codeSign.findIdentityRawResult` : Promise<Array<string>> \| null +### `electron-builder/out/codeSign.findIdentityRawResult` : Promise<Array<String>> \| null **Kind**: property of [electron-builder/out/codeSign](#module_electron-builder/out/codeSign) @@ -362,25 +421,25 @@ Developer API only. See [[Options]] for user documentation. -### `electron-builder/out/codeSign.downloadCertificate(urlOrBase64, tmpDir, currentDir)` ⇒ Promise<string> +### `electron-builder/out/codeSign.downloadCertificate(urlOrBase64, tmpDir, currentDir)` ⇒ Promise<String> **Kind**: method of [electron-builder/out/codeSign](#module_electron-builder/out/codeSign) | Param | Type | | --- | --- | -| urlOrBase64 | string | +| urlOrBase64 | String | | tmpDir | [TmpDir](electron-builder-util#TmpDir) | -| currentDir | string | +| currentDir | String | -### `electron-builder/out/codeSign.findIdentity(certType, qualifier, keychain)` ⇒ Promise< \| string> +### `electron-builder/out/codeSign.findIdentity(certType, qualifier, keychain)` ⇒ Promise< \| String> **Kind**: method of [electron-builder/out/codeSign](#module_electron-builder/out/codeSign) | Param | Type | | --- | --- | | certType | "Developer ID Application" \| "Developer ID Installer" \| "3rd Party Mac Developer Application" \| "3rd Party Mac Developer Installer" \| "Mac Developer" | -| qualifier | string \| null | -| keychain | string \| null | +| qualifier | String \| null | +| keychain | String \| null | @@ -389,22 +448,9 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | -| path | string | -| name | string | -| keychain | string | - - - -## electron-builder/out/forge/forge-maker - - -### `ForgeOptions` -**Kind**: interface of [electron-builder/out/forge/forge-maker](#module_electron-builder/out/forge/forge-maker) -**Properties** - -| Name | Type | -| --- | --- | -| **dir**| string | +| path | String | +| name | String | +| keychain | String | @@ -413,27 +459,20 @@ Developer API only. See [[Options]] for user documentation. * [electron-builder/out/linuxPackager](#module_electron-builder/out/linuxPackager) * [.LinuxPackager](#LinuxPackager) ⇐ [PlatformPackager](#PlatformPackager) * [`.createTargets(targets, mapper, cleanupTasks)`](#module_electron-builder/out/linuxPackager.LinuxPackager+createTargets) - * [`.postInitApp(appOutDir)`](#module_electron-builder/out/linuxPackager.LinuxPackager+postInitApp) ⇒ Promise<any> - * [`.getDefaultIcon(ext)`](#module_electron-builder/out/platformPackager.PlatformPackager+getDefaultIcon) ⇒ Promise< \| string> + * [`.getDefaultIcon(ext)`](#module_electron-builder/out/platformPackager.PlatformPackager+getDefaultIcon) ⇒ Promise< \| String> * [`.dispatchArtifactCreated(file, target, arch, safeArtifactName)`](#module_electron-builder/out/platformPackager.PlatformPackager+dispatchArtifactCreated) - * [`.getElectronDestDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getElectronDestDir) ⇒ string - * [`.getElectronSrcDir(dist)`](#module_electron-builder/out/platformPackager.PlatformPackager+getElectronSrcDir) ⇒ string - * [`.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< \| string> - * [`.getMacOsResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getMacOsResourcesDir) ⇒ string + * [`.getElectronDestDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getElectronDestDir) ⇒ String + * [`.getElectronSrcDir(dist)`](#module_electron-builder/out/platformPackager.PlatformPackager+getElectronSrcDir) ⇒ String + * [`.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< \| String> + * [`.getMacOsResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getMacOsResourcesDir) ⇒ String * [`.pack(outDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+pack) ⇒ Promise<any> - * [`.getResource(custom, names)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResource) ⇒ Promise< \| string> - * [`.getResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResourcesDir) ⇒ string - * [`.getTempFile(suffix)`](#module_electron-builder/out/platformPackager.PlatformPackager+getTempFile) ⇒ Promise<string> - * [`.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<void> - * [`.packageInDistributableFormat(appOutDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+packageInDistributableFormat) - * [`.prepareAppInfo(appInfo)`](#module_electron-builder/out/platformPackager.PlatformPackager+prepareAppInfo) ⇒ [AppInfo](#AppInfo) + * [`.getResource(custom, names)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResource) ⇒ Promise< \| String> + * [`.getResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResourcesDir) ⇒ String + * [`.getTempFile(suffix)`](#module_electron-builder/out/platformPackager.PlatformPackager+getTempFile) ⇒ Promise<String> @@ -444,32 +483,25 @@ Developer API only. See [[Options]] for user documentation. | Name | Type | | --- | --- | -| executableName| string | +| executableName| String | * [.LinuxPackager](#LinuxPackager) ⇐ [PlatformPackager](#PlatformPackager) * [`.createTargets(targets, mapper, cleanupTasks)`](#module_electron-builder/out/linuxPackager.LinuxPackager+createTargets) - * [`.postInitApp(appOutDir)`](#module_electron-builder/out/linuxPackager.LinuxPackager+postInitApp) ⇒ Promise<any> - * [`.getDefaultIcon(ext)`](#module_electron-builder/out/platformPackager.PlatformPackager+getDefaultIcon) ⇒ Promise< \| string> + * [`.getDefaultIcon(ext)`](#module_electron-builder/out/platformPackager.PlatformPackager+getDefaultIcon) ⇒ Promise< \| String> * [`.dispatchArtifactCreated(file, target, arch, safeArtifactName)`](#module_electron-builder/out/platformPackager.PlatformPackager+dispatchArtifactCreated) - * [`.getElectronDestDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getElectronDestDir) ⇒ string - * [`.getElectronSrcDir(dist)`](#module_electron-builder/out/platformPackager.PlatformPackager+getElectronSrcDir) ⇒ string - * [`.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< \| string> - * [`.getMacOsResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getMacOsResourcesDir) ⇒ string + * [`.getElectronDestDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getElectronDestDir) ⇒ String + * [`.getElectronSrcDir(dist)`](#module_electron-builder/out/platformPackager.PlatformPackager+getElectronSrcDir) ⇒ String + * [`.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< \| String> + * [`.getMacOsResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getMacOsResourcesDir) ⇒ String * [`.pack(outDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+pack) ⇒ Promise<any> - * [`.getResource(custom, names)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResource) ⇒ Promise< \| string> - * [`.getResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResourcesDir) ⇒ string - * [`.getTempFile(suffix)`](#module_electron-builder/out/platformPackager.PlatformPackager+getTempFile) ⇒ Promise<string> - * [`.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<void> - * [`.packageInDistributableFormat(appOutDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+packageInDistributableFormat) - * [`.prepareAppInfo(appInfo)`](#module_electron-builder/out/platformPackager.PlatformPackager+prepareAppInfo) ⇒ [AppInfo](#AppInfo) + * [`.getResource(custom, names)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResource) ⇒ Promise< \| String> + * [`.getResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResourcesDir) ⇒ String + * [`.getTempFile(suffix)`](#module_electron-builder/out/platformPackager.PlatformPackager+getTempFile) ⇒ Promise<String> @@ -479,29 +511,18 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | -| targets | Array<string> | +| targets | Array<String> | | mapper | callback | | cleanupTasks | Array<module:electron-builder/out/linuxPackager.__type> | - - -#### `linuxPackager.postInitApp(appOutDir)` ⇒ Promise<any> -**Kind**: instance method of [LinuxPackager](#LinuxPackager) -**Overrides**: [postInitApp](#module_electron-builder/out/platformPackager.PlatformPackager+postInitApp) -**Access**: protected - -| Param | Type | -| --- | --- | -| appOutDir | string | - -#### `linuxPackager.getDefaultIcon(ext)` ⇒ Promise< \| string> +#### `linuxPackager.getDefaultIcon(ext)` ⇒ Promise< \| String> **Kind**: instance method of [LinuxPackager](#LinuxPackager) | Param | Type | | --- | --- | -| ext | string | +| ext | String | @@ -510,87 +531,87 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | -| file | string | +| file | String | | target | [Target](electron-builder-core#Target) \| null | | arch | [Arch](electron-builder-core#Arch) \| null | -| safeArtifactName | string | +| safeArtifactName | String | -#### `linuxPackager.getElectronDestDir(appOutDir)` ⇒ string +#### `linuxPackager.getElectronDestDir(appOutDir)` ⇒ String **Kind**: instance method of [LinuxPackager](#LinuxPackager) | Param | Type | | --- | --- | -| appOutDir | string | +| appOutDir | String | -#### `linuxPackager.getElectronSrcDir(dist)` ⇒ string +#### `linuxPackager.getElectronSrcDir(dist)` ⇒ String **Kind**: instance method of [LinuxPackager](#LinuxPackager) | Param | Type | | --- | --- | -| dist | string | +| dist | String | -#### `linuxPackager.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern)` ⇒ string +#### `linuxPackager.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern)` ⇒ String **Kind**: instance method of [LinuxPackager](#LinuxPackager) | Param | Type | | --- | --- | | targetSpecificOptions | [TargetSpecificOptions](electron-builder-core#TargetSpecificOptions) \| undefined \| null | -| ext | string | +| ext | String | | arch | [Arch](electron-builder-core#Arch) \| null | -| defaultPattern | string | +| defaultPattern | String | -#### `linuxPackager.expandMacro(pattern, arch, extra)` ⇒ string +#### `linuxPackager.expandMacro(pattern, arch, extra)` ⇒ String **Kind**: instance method of [LinuxPackager](#LinuxPackager) | Param | Type | | --- | --- | -| pattern | string | -| arch | string \| undefined \| null | +| pattern | String | +| arch | String \| undefined \| null | | extra | any | -#### `linuxPackager.generateName(ext, arch, deployment, classifier)` ⇒ string +#### `linuxPackager.generateName(ext, arch, deployment, classifier)` ⇒ String **Kind**: instance method of [LinuxPackager](#LinuxPackager) | Param | Type | | --- | --- | -| ext | string \| null | +| ext | String \| null | | arch | [Arch](electron-builder-core#Arch) | -| deployment | boolean | -| classifier | string \| null | +| deployment | Boolean | +| classifier | String \| null | -#### `linuxPackager.generateName2(ext, classifier, deployment)` ⇒ string +#### `linuxPackager.generateName2(ext, classifier, deployment)` ⇒ String **Kind**: instance method of [LinuxPackager](#LinuxPackager) | Param | Type | | --- | --- | -| ext | string \| null | -| classifier | string \| undefined \| null | -| deployment | boolean | +| ext | String \| null | +| classifier | String \| undefined \| null | +| deployment | Boolean | -#### `linuxPackager.getIconPath()` ⇒ Promise< \| string> +#### `linuxPackager.getIconPath()` ⇒ Promise< \| String> **Kind**: instance method of [LinuxPackager](#LinuxPackager) -#### `linuxPackager.getMacOsResourcesDir(appOutDir)` ⇒ string +#### `linuxPackager.getMacOsResourcesDir(appOutDir)` ⇒ String **Kind**: instance method of [LinuxPackager](#LinuxPackager) | Param | Type | | --- | --- | -| appOutDir | string | +| appOutDir | String | @@ -599,97 +620,38 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | -| outDir | string | +| outDir | String | | arch | [Arch](electron-builder-core#Arch) | | targets | Array<[Target](electron-builder-core#Target)> | | postAsyncTasks | Array<Promise<any>> | -#### `linuxPackager.getResource(custom, names)` ⇒ Promise< \| string> +#### `linuxPackager.getResource(custom, names)` ⇒ Promise< \| String> **Kind**: instance method of [LinuxPackager](#LinuxPackager) | Param | Type | | --- | --- | -| custom | string \| undefined \| null | -| names | Array<string> | +| custom | String \| undefined \| null | +| names | Array<String> | -#### `linuxPackager.getResourcesDir(appOutDir)` ⇒ string +#### `linuxPackager.getResourcesDir(appOutDir)` ⇒ String **Kind**: instance method of [LinuxPackager](#LinuxPackager) | Param | Type | | --- | --- | -| appOutDir | string | +| appOutDir | String | -#### `linuxPackager.getTempFile(suffix)` ⇒ Promise<string> -**Kind**: instance method of [LinuxPackager](#LinuxPackager) - -| Param | Type | -| --- | --- | -| suffix | string | - - - -#### `linuxPackager.computeAppOutDir(outDir, arch)` ⇒ string -**Kind**: instance method of [LinuxPackager](#LinuxPackager) -**Access**: protected - -| Param | Type | -| --- | --- | -| outDir | string | -| arch | [Arch](electron-builder-core#Arch) | - - - -#### `linuxPackager.getCscPassword()` ⇒ string -**Kind**: instance method of [LinuxPackager](#LinuxPackager) -**Access**: protected - - -#### `linuxPackager.doGetCscPassword()` ⇒ any -**Kind**: instance method of [LinuxPackager](#LinuxPackager) -**Access**: protected - - -#### `linuxPackager.doPack(outDir, appOutDir, platformName, arch, platformSpecificBuildOptions, targets)` ⇒ Promise<void> -**Kind**: instance method of [LinuxPackager](#LinuxPackager) -**Access**: protected - -| Param | Type | -| --- | --- | -| outDir | string | -| appOutDir | string | -| platformName | string | -| arch | [Arch](electron-builder-core#Arch) | -| platformSpecificBuildOptions | module:electron-builder/out/platformPackager.DC | -| targets | Array<[Target](electron-builder-core#Target)> | - - - -#### `linuxPackager.packageInDistributableFormat(appOutDir, arch, targets, postAsyncTasks)` -**Kind**: instance method of [LinuxPackager](#LinuxPackager) -**Access**: protected - -| Param | Type | -| --- | --- | -| appOutDir | string | -| arch | [Arch](electron-builder-core#Arch) | -| targets | Array<[Target](electron-builder-core#Target)> | -| postAsyncTasks | Array<Promise<any>> | - - - -#### `linuxPackager.prepareAppInfo(appInfo)` ⇒ [AppInfo](#AppInfo) +#### `linuxPackager.getTempFile(suffix)` ⇒ Promise<String> **Kind**: instance method of [LinuxPackager](#LinuxPackager) -**Access**: protected | Param | Type | | --- | --- | -| appInfo | [AppInfo](#AppInfo) | +| suffix | String | @@ -698,29 +660,20 @@ Developer API only. See [[Options]] for user documentation. * [electron-builder/out/macPackager](#module_electron-builder/out/macPackager) * [.MacPackager](#MacPackager) ⇐ [PlatformPackager](#PlatformPackager) * [`.createTargets(targets, mapper, cleanupTasks)`](#module_electron-builder/out/macPackager.MacPackager+createTargets) - * [`.getElectronDestDir(appOutDir)`](#module_electron-builder/out/macPackager.MacPackager+getElectronDestDir) ⇒ string - * [`.getElectronSrcDir(dist)`](#module_electron-builder/out/macPackager.MacPackager+getElectronSrcDir) ⇒ string - * [`.getIconPath()`](#module_electron-builder/out/macPackager.MacPackager+getIconPath) ⇒ Promise< \| string> + * [`.getElectronDestDir(appOutDir)`](#module_electron-builder/out/macPackager.MacPackager+getElectronDestDir) ⇒ String + * [`.getElectronSrcDir(dist)`](#module_electron-builder/out/macPackager.MacPackager+getElectronSrcDir) ⇒ String + * [`.getIconPath()`](#module_electron-builder/out/macPackager.MacPackager+getIconPath) ⇒ Promise< \| String> * [`.pack(outDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/macPackager.MacPackager+pack) ⇒ Promise<any> - * [`.doFlat(appPath, outFile, identity, keychain)`](#module_electron-builder/out/macPackager.MacPackager+doFlat) ⇒ Promise<any> - * [`.doSign(opts)`](#module_electron-builder/out/macPackager.MacPackager+doSign) ⇒ Promise<any> - * [`.prepareAppInfo(appInfo)`](#module_electron-builder/out/macPackager.MacPackager+prepareAppInfo) ⇒ [AppInfo](#AppInfo) - * [`.getDefaultIcon(ext)`](#module_electron-builder/out/platformPackager.PlatformPackager+getDefaultIcon) ⇒ Promise< \| string> + * [`.getDefaultIcon(ext)`](#module_electron-builder/out/platformPackager.PlatformPackager+getDefaultIcon) ⇒ Promise< \| String> * [`.dispatchArtifactCreated(file, target, arch, 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< \| string> - * [`.getResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResourcesDir) ⇒ string - * [`.getTempFile(suffix)`](#module_electron-builder/out/platformPackager.PlatformPackager+getTempFile) ⇒ Promise<string> - * [`.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<void> - * [`.packageInDistributableFormat(appOutDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+packageInDistributableFormat) - * [`.postInitApp(executableFile)`](#module_electron-builder/out/platformPackager.PlatformPackager+postInitApp) ⇒ Promise<any> + * [`.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< \| String> + * [`.getResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResourcesDir) ⇒ String + * [`.getTempFile(suffix)`](#module_electron-builder/out/platformPackager.PlatformPackager+getTempFile) ⇒ Promise<String> @@ -736,29 +689,20 @@ Developer API only. See [[Options]] for user documentation. * [.MacPackager](#MacPackager) ⇐ [PlatformPackager](#PlatformPackager) * [`.createTargets(targets, mapper, cleanupTasks)`](#module_electron-builder/out/macPackager.MacPackager+createTargets) - * [`.getElectronDestDir(appOutDir)`](#module_electron-builder/out/macPackager.MacPackager+getElectronDestDir) ⇒ string - * [`.getElectronSrcDir(dist)`](#module_electron-builder/out/macPackager.MacPackager+getElectronSrcDir) ⇒ string - * [`.getIconPath()`](#module_electron-builder/out/macPackager.MacPackager+getIconPath) ⇒ Promise< \| string> + * [`.getElectronDestDir(appOutDir)`](#module_electron-builder/out/macPackager.MacPackager+getElectronDestDir) ⇒ String + * [`.getElectronSrcDir(dist)`](#module_electron-builder/out/macPackager.MacPackager+getElectronSrcDir) ⇒ String + * [`.getIconPath()`](#module_electron-builder/out/macPackager.MacPackager+getIconPath) ⇒ Promise< \| String> * [`.pack(outDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/macPackager.MacPackager+pack) ⇒ Promise<any> - * [`.doFlat(appPath, outFile, identity, keychain)`](#module_electron-builder/out/macPackager.MacPackager+doFlat) ⇒ Promise<any> - * [`.doSign(opts)`](#module_electron-builder/out/macPackager.MacPackager+doSign) ⇒ Promise<any> - * [`.prepareAppInfo(appInfo)`](#module_electron-builder/out/macPackager.MacPackager+prepareAppInfo) ⇒ [AppInfo](#AppInfo) - * [`.getDefaultIcon(ext)`](#module_electron-builder/out/platformPackager.PlatformPackager+getDefaultIcon) ⇒ Promise< \| string> + * [`.getDefaultIcon(ext)`](#module_electron-builder/out/platformPackager.PlatformPackager+getDefaultIcon) ⇒ Promise< \| String> * [`.dispatchArtifactCreated(file, target, arch, 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< \| string> - * [`.getResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResourcesDir) ⇒ string - * [`.getTempFile(suffix)`](#module_electron-builder/out/platformPackager.PlatformPackager+getTempFile) ⇒ Promise<string> - * [`.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<void> - * [`.packageInDistributableFormat(appOutDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+packageInDistributableFormat) - * [`.postInitApp(executableFile)`](#module_electron-builder/out/platformPackager.PlatformPackager+postInitApp) ⇒ Promise<any> + * [`.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< \| String> + * [`.getResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResourcesDir) ⇒ String + * [`.getTempFile(suffix)`](#module_electron-builder/out/platformPackager.PlatformPackager+getTempFile) ⇒ Promise<String> @@ -768,33 +712,33 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | -| targets | Array<string> | +| targets | Array<String> | | mapper | callback | | cleanupTasks | Array<module:electron-builder/out/macPackager.__type> | -#### `macPackager.getElectronDestDir(appOutDir)` ⇒ string +#### `macPackager.getElectronDestDir(appOutDir)` ⇒ String **Kind**: instance method of [MacPackager](#MacPackager) **Overrides**: [getElectronDestDir](#module_electron-builder/out/platformPackager.PlatformPackager+getElectronDestDir) | Param | Type | | --- | --- | -| appOutDir | string | +| appOutDir | String | -#### `macPackager.getElectronSrcDir(dist)` ⇒ string +#### `macPackager.getElectronSrcDir(dist)` ⇒ String **Kind**: instance method of [MacPackager](#MacPackager) **Overrides**: [getElectronSrcDir](#module_electron-builder/out/platformPackager.PlatformPackager+getElectronSrcDir) | Param | Type | | --- | --- | -| dist | string | +| dist | String | -#### `macPackager.getIconPath()` ⇒ Promise< \| string> +#### `macPackager.getIconPath()` ⇒ Promise< \| String> **Kind**: instance method of [MacPackager](#MacPackager) **Overrides**: [getIconPath](#module_electron-builder/out/platformPackager.PlatformPackager+getIconPath) @@ -805,53 +749,19 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | -| outDir | string | +| outDir | String | | arch | [Arch](electron-builder-core#Arch) | | targets | Array<[Target](electron-builder-core#Target)> | | postAsyncTasks | Array<Promise<any>> | - - -#### `macPackager.doFlat(appPath, outFile, identity, keychain)` ⇒ Promise<any> -**Kind**: instance method of [MacPackager](#MacPackager) -**Access**: protected - -| Param | Type | -| --- | --- | -| appPath | string | -| outFile | string | -| identity | string | -| keychain | string \| undefined \| null | - - - -#### `macPackager.doSign(opts)` ⇒ Promise<any> -**Kind**: instance method of [MacPackager](#MacPackager) -**Access**: protected - -| Param | Type | -| --- | --- | -| opts | module:electron-osx-sign.SignOptions | - - - -#### `macPackager.prepareAppInfo(appInfo)` ⇒ [AppInfo](#AppInfo) -**Kind**: instance method of [MacPackager](#MacPackager) -**Overrides**: [prepareAppInfo](#module_electron-builder/out/platformPackager.PlatformPackager+prepareAppInfo) -**Access**: protected - -| Param | Type | -| --- | --- | -| appInfo | [AppInfo](#AppInfo) | - -#### `macPackager.getDefaultIcon(ext)` ⇒ Promise< \| string> +#### `macPackager.getDefaultIcon(ext)` ⇒ Promise< \| String> **Kind**: instance method of [MacPackager](#MacPackager) | Param | Type | | --- | --- | -| ext | string | +| ext | String | @@ -860,205 +770,93 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | -| file | string | +| file | String | | target | [Target](electron-builder-core#Target) \| null | | arch | [Arch](electron-builder-core#Arch) \| null | -| safeArtifactName | string | +| safeArtifactName | String | -#### `macPackager.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern)` ⇒ string +#### `macPackager.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern)` ⇒ String **Kind**: instance method of [MacPackager](#MacPackager) | Param | Type | | --- | --- | | targetSpecificOptions | [TargetSpecificOptions](electron-builder-core#TargetSpecificOptions) \| undefined \| null | -| ext | string | +| ext | String | | arch | [Arch](electron-builder-core#Arch) \| null | -| defaultPattern | string | +| defaultPattern | String | -#### `macPackager.expandMacro(pattern, arch, extra)` ⇒ string +#### `macPackager.expandMacro(pattern, arch, extra)` ⇒ String **Kind**: instance method of [MacPackager](#MacPackager) | Param | Type | | --- | --- | -| pattern | string | -| arch | string \| undefined \| null | +| pattern | String | +| arch | String \| undefined \| null | | extra | any | -#### `macPackager.generateName(ext, arch, deployment, classifier)` ⇒ string +#### `macPackager.generateName(ext, arch, deployment, classifier)` ⇒ String **Kind**: instance method of [MacPackager](#MacPackager) | Param | Type | | --- | --- | -| ext | string \| null | +| ext | String \| null | | arch | [Arch](electron-builder-core#Arch) | -| deployment | boolean | -| classifier | string \| null | +| deployment | Boolean | +| classifier | String \| null | -#### `macPackager.generateName2(ext, classifier, deployment)` ⇒ string +#### `macPackager.generateName2(ext, classifier, deployment)` ⇒ String **Kind**: instance method of [MacPackager](#MacPackager) | Param | Type | | --- | --- | -| ext | string \| null | -| classifier | string \| undefined \| null | -| deployment | boolean | +| ext | String \| null | +| classifier | String \| undefined \| null | +| deployment | Boolean | -#### `macPackager.getMacOsResourcesDir(appOutDir)` ⇒ string +#### `macPackager.getMacOsResourcesDir(appOutDir)` ⇒ String **Kind**: instance method of [MacPackager](#MacPackager) | Param | Type | | --- | --- | -| appOutDir | string | +| appOutDir | String | -#### `macPackager.getResource(custom, names)` ⇒ Promise< \| string> +#### `macPackager.getResource(custom, names)` ⇒ Promise< \| String> **Kind**: instance method of [MacPackager](#MacPackager) | Param | Type | | --- | --- | -| custom | string \| undefined \| null | -| names | Array<string> | +| custom | String \| undefined \| null | +| names | Array<String> | -#### `macPackager.getResourcesDir(appOutDir)` ⇒ string +#### `macPackager.getResourcesDir(appOutDir)` ⇒ String **Kind**: instance method of [MacPackager](#MacPackager) | Param | Type | | --- | --- | -| appOutDir | string | +| appOutDir | String | -#### `macPackager.getTempFile(suffix)` ⇒ Promise<string> -**Kind**: instance method of [MacPackager](#MacPackager) - -| Param | Type | -| --- | --- | -| suffix | string | - - - -#### `macPackager.computeAppOutDir(outDir, arch)` ⇒ string -**Kind**: instance method of [MacPackager](#MacPackager) -**Access**: protected - -| Param | Type | -| --- | --- | -| outDir | string | -| arch | [Arch](electron-builder-core#Arch) | - - - -#### `macPackager.getCscPassword()` ⇒ string -**Kind**: instance method of [MacPackager](#MacPackager) -**Access**: protected - - -#### `macPackager.doGetCscPassword()` ⇒ any -**Kind**: instance method of [MacPackager](#MacPackager) -**Access**: protected - - -#### `macPackager.doPack(outDir, appOutDir, platformName, arch, platformSpecificBuildOptions, targets)` ⇒ Promise<void> +#### `macPackager.getTempFile(suffix)` ⇒ Promise<String> **Kind**: instance method of [MacPackager](#MacPackager) -**Access**: protected | Param | Type | | --- | --- | -| outDir | string | -| appOutDir | string | -| platformName | string | -| arch | [Arch](electron-builder-core#Arch) | -| platformSpecificBuildOptions | module:electron-builder/out/platformPackager.DC | -| targets | Array<[Target](electron-builder-core#Target)> | - - - -#### `macPackager.packageInDistributableFormat(appOutDir, arch, targets, postAsyncTasks)` -**Kind**: instance method of [MacPackager](#MacPackager) -**Access**: protected - -| Param | Type | -| --- | --- | -| appOutDir | string | -| arch | [Arch](electron-builder-core#Arch) | -| targets | Array<[Target](electron-builder-core#Target)> | -| postAsyncTasks | Array<Promise<any>> | - - - -#### `macPackager.postInitApp(executableFile)` ⇒ Promise<any> -**Kind**: instance method of [MacPackager](#MacPackager) -**Access**: protected - -| Param | Type | -| --- | --- | -| executableFile | string | - - - -## electron-builder/out/options/linuxOptions - -* [electron-builder/out/options/linuxOptions](#module_electron-builder/out/options/linuxOptions) - * [`.CommonLinuxOptions`](#CommonLinuxOptions) - * [`.LinuxTargetSpecificOptions`](#LinuxTargetSpecificOptions) ⇐ [CommonLinuxOptions](#CommonLinuxOptions) - - - -### `CommonLinuxOptions` -**Kind**: interface of [electron-builder/out/options/linuxOptions](#module_electron-builder/out/options/linuxOptions) -**Properties** - -| Name | Type | -| --- | --- | -| synopsis| string \| null | -| description| string \| null | -| category| string \| null | -| packageCategory| string \| null | -| desktop| Object<string, any> \| null | -| vendor| string \| null | -| maintainer| string \| null | -| afterInstall| string \| null | -| afterRemove| string \| null | - - - -### `LinuxTargetSpecificOptions` ⇐ [CommonLinuxOptions](#CommonLinuxOptions) -**Kind**: interface of [electron-builder/out/options/linuxOptions](#module_electron-builder/out/options/linuxOptions) -**Extends**: [CommonLinuxOptions](#CommonLinuxOptions) -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| depends| Array<string> \| null | Package dependencies. | -| icon| string | | - - - -## electron-builder/out/options/winOptions - - -### `CommonNsisOptions` -**Kind**: interface of [electron-builder/out/options/winOptions](#module_electron-builder/out/options/winOptions) -**Properties** - -| Name | Type | -| --- | --- | -| unicode| boolean | -| guid| string \| null | -| warningsAsErrors| boolean | +| suffix | String | @@ -1066,7 +864,7 @@ Developer API only. See [[Options]] for user documentation. * [electron-builder/out/packager/mac](#module_electron-builder/out/packager/mac) * [`.createApp(packager, appOutDir, asarIntegrity)`](#module_electron-builder/out/packager/mac.createApp) ⇒ Promise<void> - * [`.filterCFBundleIdentifier(identifier)`](#module_electron-builder/out/packager/mac.filterCFBundleIdentifier) ⇒ string + * [`.filterCFBundleIdentifier(identifier)`](#module_electron-builder/out/packager/mac.filterCFBundleIdentifier) ⇒ String @@ -1076,17 +874,17 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | | packager | [PlatformPackager](#PlatformPackager)<any> | -| appOutDir | string | +| appOutDir | String | | asarIntegrity | module:asar-integrity.AsarIntegrity | -### `electron-builder/out/packager/mac.filterCFBundleIdentifier(identifier)` ⇒ 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 | +| identifier | String | @@ -1098,7 +896,7 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | -| rawPlatforms | Array<string \| [Platform](electron-builder-core#Platform)> \| string \| [Platform](electron-builder-core#Platform) \| undefined \| null | +| rawPlatforms | Array<String \| [Platform](electron-builder-core#Platform)> \| String \| [Platform](electron-builder-core#Platform) \| undefined \| null | @@ -1107,28 +905,21 @@ Developer API only. See [[Options]] for user documentation. * [electron-builder/out/platformPackager](#module_electron-builder/out/platformPackager) * [.PlatformPackager](#PlatformPackager) * [`.createTargets(targets, mapper, cleanupTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+createTargets) - * [`.getDefaultIcon(ext)`](#module_electron-builder/out/platformPackager.PlatformPackager+getDefaultIcon) ⇒ Promise< \| string> + * [`.getDefaultIcon(ext)`](#module_electron-builder/out/platformPackager.PlatformPackager+getDefaultIcon) ⇒ Promise< \| String> * [`.dispatchArtifactCreated(file, target, arch, safeArtifactName)`](#module_electron-builder/out/platformPackager.PlatformPackager+dispatchArtifactCreated) - * [`.getElectronDestDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getElectronDestDir) ⇒ string - * [`.getElectronSrcDir(dist)`](#module_electron-builder/out/platformPackager.PlatformPackager+getElectronSrcDir) ⇒ string - * [`.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< \| string> - * [`.getMacOsResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getMacOsResourcesDir) ⇒ string + * [`.getElectronDestDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getElectronDestDir) ⇒ String + * [`.getElectronSrcDir(dist)`](#module_electron-builder/out/platformPackager.PlatformPackager+getElectronSrcDir) ⇒ String + * [`.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< \| String> + * [`.getMacOsResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getMacOsResourcesDir) ⇒ String * [`.pack(outDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+pack) ⇒ Promise<any> - * [`.getResource(custom, names)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResource) ⇒ Promise< \| string> - * [`.getResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResourcesDir) ⇒ string - * [`.getTempFile(suffix)`](#module_electron-builder/out/platformPackager.PlatformPackager+getTempFile) ⇒ Promise<string> - * [`.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<void> - * [`.packageInDistributableFormat(appOutDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+packageInDistributableFormat) - * [`.postInitApp(executableFile)`](#module_electron-builder/out/platformPackager.PlatformPackager+postInitApp) ⇒ Promise<any> - * [`.prepareAppInfo(appInfo)`](#module_electron-builder/out/platformPackager.PlatformPackager+prepareAppInfo) ⇒ [AppInfo](#AppInfo) - * [`.normalizeExt(ext)`](#module_electron-builder/out/platformPackager.normalizeExt) ⇒ string + * [`.getResource(custom, names)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResource) ⇒ Promise< \| String> + * [`.getResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResourcesDir) ⇒ String + * [`.getTempFile(suffix)`](#module_electron-builder/out/platformPackager.PlatformPackager+getTempFile) ⇒ Promise<String> + * [`.normalizeExt(ext)`](#module_electron-builder/out/platformPackager.normalizeExt) ⇒ String @@ -1139,8 +930,8 @@ Developer API only. See [[Options]] for user documentation. | Name | Type | | --- | --- | | packagerOptions| [PackagerOptions](Options#PackagerOptions) | -| projectDir| string | -| buildResourcesDir| string | +| projectDir| String | +| buildResourcesDir| String | | config| [Config](Options#Config) | | platformSpecificBuildOptions| module:electron-builder/out/platformPackager.DC | | appInfo| [AppInfo](#AppInfo) | @@ -1148,27 +939,20 @@ Developer API only. See [[Options]] for user documentation. * [.PlatformPackager](#PlatformPackager) * [`.createTargets(targets, mapper, cleanupTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+createTargets) - * [`.getDefaultIcon(ext)`](#module_electron-builder/out/platformPackager.PlatformPackager+getDefaultIcon) ⇒ Promise< \| string> + * [`.getDefaultIcon(ext)`](#module_electron-builder/out/platformPackager.PlatformPackager+getDefaultIcon) ⇒ Promise< \| String> * [`.dispatchArtifactCreated(file, target, arch, safeArtifactName)`](#module_electron-builder/out/platformPackager.PlatformPackager+dispatchArtifactCreated) - * [`.getElectronDestDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getElectronDestDir) ⇒ string - * [`.getElectronSrcDir(dist)`](#module_electron-builder/out/platformPackager.PlatformPackager+getElectronSrcDir) ⇒ string - * [`.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< \| string> - * [`.getMacOsResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getMacOsResourcesDir) ⇒ string + * [`.getElectronDestDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getElectronDestDir) ⇒ String + * [`.getElectronSrcDir(dist)`](#module_electron-builder/out/platformPackager.PlatformPackager+getElectronSrcDir) ⇒ String + * [`.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< \| String> + * [`.getMacOsResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getMacOsResourcesDir) ⇒ String * [`.pack(outDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+pack) ⇒ Promise<any> - * [`.getResource(custom, names)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResource) ⇒ Promise< \| string> - * [`.getResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResourcesDir) ⇒ string - * [`.getTempFile(suffix)`](#module_electron-builder/out/platformPackager.PlatformPackager+getTempFile) ⇒ Promise<string> - * [`.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<void> - * [`.packageInDistributableFormat(appOutDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+packageInDistributableFormat) - * [`.postInitApp(executableFile)`](#module_electron-builder/out/platformPackager.PlatformPackager+postInitApp) ⇒ Promise<any> - * [`.prepareAppInfo(appInfo)`](#module_electron-builder/out/platformPackager.PlatformPackager+prepareAppInfo) ⇒ [AppInfo](#AppInfo) + * [`.getResource(custom, names)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResource) ⇒ Promise< \| String> + * [`.getResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResourcesDir) ⇒ String + * [`.getTempFile(suffix)`](#module_electron-builder/out/platformPackager.PlatformPackager+getTempFile) ⇒ Promise<String> @@ -1177,18 +961,18 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | -| targets | Array<string> | +| targets | Array<String> | | mapper | callback | | cleanupTasks | Array<module:electron-builder/out/platformPackager.__type> | -#### `platformPackager.getDefaultIcon(ext)` ⇒ Promise< \| string> +#### `platformPackager.getDefaultIcon(ext)` ⇒ Promise< \| String> **Kind**: instance method of [PlatformPackager](#PlatformPackager) | Param | Type | | --- | --- | -| ext | string | +| ext | String | @@ -1197,87 +981,87 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | -| file | string | +| file | String | | target | [Target](electron-builder-core#Target) \| null | | arch | [Arch](electron-builder-core#Arch) \| null | -| safeArtifactName | string | +| safeArtifactName | String | -#### `platformPackager.getElectronDestDir(appOutDir)` ⇒ string +#### `platformPackager.getElectronDestDir(appOutDir)` ⇒ String **Kind**: instance method of [PlatformPackager](#PlatformPackager) | Param | Type | | --- | --- | -| appOutDir | string | +| appOutDir | String | -#### `platformPackager.getElectronSrcDir(dist)` ⇒ string +#### `platformPackager.getElectronSrcDir(dist)` ⇒ String **Kind**: instance method of [PlatformPackager](#PlatformPackager) | Param | Type | | --- | --- | -| dist | string | +| dist | String | -#### `platformPackager.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern)` ⇒ string +#### `platformPackager.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern)` ⇒ String **Kind**: instance method of [PlatformPackager](#PlatformPackager) | Param | Type | | --- | --- | | targetSpecificOptions | [TargetSpecificOptions](electron-builder-core#TargetSpecificOptions) \| undefined \| null | -| ext | string | +| ext | String | | arch | [Arch](electron-builder-core#Arch) \| null | -| defaultPattern | string | +| defaultPattern | String | -#### `platformPackager.expandMacro(pattern, arch, extra)` ⇒ string +#### `platformPackager.expandMacro(pattern, arch, extra)` ⇒ String **Kind**: instance method of [PlatformPackager](#PlatformPackager) | Param | Type | | --- | --- | -| pattern | string | -| arch | string \| undefined \| null | +| pattern | String | +| arch | String \| undefined \| null | | extra | any | -#### `platformPackager.generateName(ext, arch, deployment, classifier)` ⇒ string +#### `platformPackager.generateName(ext, arch, deployment, classifier)` ⇒ String **Kind**: instance method of [PlatformPackager](#PlatformPackager) | Param | Type | | --- | --- | -| ext | string \| null | +| ext | String \| null | | arch | [Arch](electron-builder-core#Arch) | -| deployment | boolean | -| classifier | string \| null | +| deployment | Boolean | +| classifier | String \| null | -#### `platformPackager.generateName2(ext, classifier, deployment)` ⇒ string +#### `platformPackager.generateName2(ext, classifier, deployment)` ⇒ String **Kind**: instance method of [PlatformPackager](#PlatformPackager) | Param | Type | | --- | --- | -| ext | string \| null | -| classifier | string \| undefined \| null | -| deployment | boolean | +| ext | String \| null | +| classifier | String \| undefined \| null | +| deployment | Boolean | -#### `platformPackager.getIconPath()` ⇒ Promise< \| string> +#### `platformPackager.getIconPath()` ⇒ Promise< \| String> **Kind**: instance method of [PlatformPackager](#PlatformPackager) -#### `platformPackager.getMacOsResourcesDir(appOutDir)` ⇒ string +#### `platformPackager.getMacOsResourcesDir(appOutDir)` ⇒ String **Kind**: instance method of [PlatformPackager](#PlatformPackager) | Param | Type | | --- | --- | -| appOutDir | string | +| appOutDir | String | @@ -1286,116 +1070,47 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | -| outDir | string | +| outDir | String | | arch | [Arch](electron-builder-core#Arch) | | targets | Array<[Target](electron-builder-core#Target)> | | postAsyncTasks | Array<Promise<any>> | -#### `platformPackager.getResource(custom, names)` ⇒ Promise< \| string> +#### `platformPackager.getResource(custom, names)` ⇒ Promise< \| String> **Kind**: instance method of [PlatformPackager](#PlatformPackager) | Param | Type | | --- | --- | -| custom | string \| undefined \| null | -| names | Array<string> | +| custom | String \| undefined \| null | +| names | Array<String> | -#### `platformPackager.getResourcesDir(appOutDir)` ⇒ string +#### `platformPackager.getResourcesDir(appOutDir)` ⇒ String **Kind**: instance method of [PlatformPackager](#PlatformPackager) | Param | Type | | --- | --- | -| appOutDir | string | +| appOutDir | String | -#### `platformPackager.getTempFile(suffix)` ⇒ Promise<string> -**Kind**: instance method of [PlatformPackager](#PlatformPackager) - -| Param | Type | -| --- | --- | -| suffix | string | - - - -#### `platformPackager.computeAppOutDir(outDir, arch)` ⇒ string -**Kind**: instance method of [PlatformPackager](#PlatformPackager) -**Access**: protected - -| Param | Type | -| --- | --- | -| outDir | string | -| arch | [Arch](electron-builder-core#Arch) | - - - -#### `platformPackager.getCscPassword()` ⇒ string -**Kind**: instance method of [PlatformPackager](#PlatformPackager) -**Access**: protected - - -#### `platformPackager.doGetCscPassword()` ⇒ any -**Kind**: instance method of [PlatformPackager](#PlatformPackager) -**Access**: protected - - -#### `platformPackager.doPack(outDir, appOutDir, platformName, arch, platformSpecificBuildOptions, targets)` ⇒ Promise<void> -**Kind**: instance method of [PlatformPackager](#PlatformPackager) -**Access**: protected - -| Param | Type | -| --- | --- | -| outDir | string | -| appOutDir | string | -| platformName | string | -| arch | [Arch](electron-builder-core#Arch) | -| platformSpecificBuildOptions | module:electron-builder/out/platformPackager.DC | -| targets | Array<[Target](electron-builder-core#Target)> | - - - -#### `platformPackager.packageInDistributableFormat(appOutDir, arch, targets, postAsyncTasks)` -**Kind**: instance method of [PlatformPackager](#PlatformPackager) -**Access**: protected - -| Param | Type | -| --- | --- | -| appOutDir | string | -| arch | [Arch](electron-builder-core#Arch) | -| targets | Array<[Target](electron-builder-core#Target)> | -| postAsyncTasks | Array<Promise<any>> | - - - -#### `platformPackager.postInitApp(executableFile)` ⇒ Promise<any> -**Kind**: instance method of [PlatformPackager](#PlatformPackager) -**Access**: protected - -| Param | Type | -| --- | --- | -| executableFile | string | - - - -#### `platformPackager.prepareAppInfo(appInfo)` ⇒ [AppInfo](#AppInfo) +#### `platformPackager.getTempFile(suffix)` ⇒ Promise<String> **Kind**: instance method of [PlatformPackager](#PlatformPackager) -**Access**: protected | Param | Type | | --- | --- | -| appInfo | [AppInfo](#AppInfo) | +| suffix | String | -### `electron-builder/out/platformPackager.normalizeExt(ext)` ⇒ string +### `electron-builder/out/platformPackager.normalizeExt(ext)` ⇒ String **Kind**: method of [electron-builder/out/platformPackager](#module_electron-builder/out/platformPackager) | Param | Type | | --- | --- | -| ext | string | +| ext | String | @@ -1405,7 +1120,7 @@ Developer API only. See [[Options]] for user documentation. * [.PublishManager](#PublishManager) ⇐ [PublishContext](electron-publish#PublishContext) * [`.awaitTasks()`](#module_electron-builder/out/publish/PublishManager.PublishManager+awaitTasks) ⇒ Promise<void> * [`.cancelTasks()`](#module_electron-builder/out/publish/PublishManager.PublishManager+cancelTasks) - * [`.computeDownloadUrl(publishConfig, fileName, packager)`](#module_electron-builder/out/publish/PublishManager.computeDownloadUrl) ⇒ string + * [`.computeDownloadUrl(publishConfig, fileName, packager)`](#module_electron-builder/out/publish/PublishManager.computeDownloadUrl) ⇒ String * [`.createPublisher(context, version, publishConfig, options)`](#module_electron-builder/out/publish/PublishManager.createPublisher) ⇒ null \| [Publisher](electron-publish#Publisher) * [`.getPublishConfigs(packager, targetSpecificOptions, arch)`](#module_electron-builder/out/publish/PublishManager.getPublishConfigs) ⇒ Promise< \| Array> * [`.getPublishConfigsForUpdateInfo(packager, publishConfigs, arch)`](#module_electron-builder/out/publish/PublishManager.getPublishConfigsForUpdateInfo) ⇒ Promise< \| Array> @@ -1437,13 +1152,13 @@ Developer API only. See [[Options]] for user documentation. **Kind**: instance method of [PublishManager](#PublishManager) -### `electron-builder/out/publish/PublishManager.computeDownloadUrl(publishConfig, fileName, packager)` ⇒ string +### `electron-builder/out/publish/PublishManager.computeDownloadUrl(publishConfig, fileName, packager)` ⇒ String **Kind**: method of [electron-builder/out/publish/PublishManager](#module_electron-builder/out/publish/PublishManager) | Param | Type | | --- | --- | | publishConfig | [PublishConfiguration](Publishing-Artifacts#PublishConfiguration) | -| fileName | string \| null | +| fileName | String \| null | | packager | [PlatformPackager](#PlatformPackager)<any> | @@ -1454,7 +1169,7 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | | context | [PublishContext](electron-publish#PublishContext) | -| version | string | +| version | String | | publishConfig | [PublishConfiguration](Publishing-Artifacts#PublishConfiguration) | | options | [PublishOptions](electron-publish#PublishOptions) | @@ -1466,7 +1181,7 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | | packager | [PlatformPackager](#PlatformPackager)<any> | -| targetSpecificOptions | [PlatformSpecificBuildOptions](electron-builder-core#PlatformSpecificBuildOptions) \| null \| undefined | +| targetSpecificOptions | [PlatformSpecificBuildOptions](#PlatformSpecificBuildOptions) \| null \| undefined | | arch | [Arch](electron-builder-core#Arch) \| null | @@ -1506,7 +1221,7 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | -| appOutDir | string | +| appOutDir | String | | arch | [Arch](electron-builder-core#Arch) | @@ -1535,7 +1250,7 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | -| appOutDir | string | +| appOutDir | String | | arch | [Arch](electron-builder-core#Arch) | @@ -1564,7 +1279,7 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | -| appOutDir | string | +| appOutDir | String | | arch | [Arch](electron-builder-core#Arch) | @@ -1575,7 +1290,7 @@ Developer API only. See [[Options]] for user documentation. * [.DmgTarget](#DmgTarget) ⇐ [Target](electron-builder-core#Target) * [`.build(appPath, arch)`](#module_electron-builder/out/targets/dmg.DmgTarget+build) ⇒ Promise<void> * [`.computeDmgOptions()`](#module_electron-builder/out/targets/dmg.DmgTarget+computeDmgOptions) ⇒ Promise<[DmgOptions](Options#DmgOptions)> - * [`.computeVolumeName(custom)`](#module_electron-builder/out/targets/dmg.DmgTarget+computeVolumeName) ⇒ string + * [`.computeVolumeName(custom)`](#module_electron-builder/out/targets/dmg.DmgTarget+computeVolumeName) ⇒ String * [`.attachAndExecute(dmgPath, readWrite, task)`](#module_electron-builder/out/targets/dmg.attachAndExecute) ⇒ Promise<any> @@ -1593,7 +1308,7 @@ Developer API only. See [[Options]] for user documentation. * [.DmgTarget](#DmgTarget) ⇐ [Target](electron-builder-core#Target) * [`.build(appPath, arch)`](#module_electron-builder/out/targets/dmg.DmgTarget+build) ⇒ Promise<void> * [`.computeDmgOptions()`](#module_electron-builder/out/targets/dmg.DmgTarget+computeDmgOptions) ⇒ Promise<[DmgOptions](Options#DmgOptions)> - * [`.computeVolumeName(custom)`](#module_electron-builder/out/targets/dmg.DmgTarget+computeVolumeName) ⇒ string + * [`.computeVolumeName(custom)`](#module_electron-builder/out/targets/dmg.DmgTarget+computeVolumeName) ⇒ String @@ -1602,7 +1317,7 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | -| appPath | string | +| appPath | String | | arch | [Arch](electron-builder-core#Arch) | @@ -1611,12 +1326,12 @@ Developer API only. See [[Options]] for user documentation. **Kind**: instance method of [DmgTarget](#DmgTarget) -#### `dmgTarget.computeVolumeName(custom)` ⇒ string +#### `dmgTarget.computeVolumeName(custom)` ⇒ String **Kind**: instance method of [DmgTarget](#DmgTarget) | Param | Type | | --- | --- | -| custom | string \| null | +| custom | String \| null | @@ -1625,8 +1340,8 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | -| dmgPath | string | -| readWrite | boolean | +| dmgPath | String | +| readWrite | Boolean | | task | callback | @@ -1655,7 +1370,7 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | -| appOutDir | string | +| appOutDir | String | | arch | [Arch](electron-builder-core#Arch) | @@ -1664,8 +1379,8 @@ Developer API only. See [[Options]] for user documentation. * [electron-builder/out/targets/LinuxTargetHelper](#module_electron-builder/out/targets/LinuxTargetHelper) * [.LinuxTargetHelper](#LinuxTargetHelper) - * [`.computeDesktopEntry(targetSpecificOptions, exec, destination, extra)`](#module_electron-builder/out/targets/LinuxTargetHelper.LinuxTargetHelper+computeDesktopEntry) ⇒ Promise<string> - * [`.getDescription(options)`](#module_electron-builder/out/targets/LinuxTargetHelper.LinuxTargetHelper+getDescription) ⇒ string + * [`.computeDesktopEntry(targetSpecificOptions, exec, destination, extra)`](#module_electron-builder/out/targets/LinuxTargetHelper.LinuxTargetHelper+computeDesktopEntry) ⇒ Promise<String> + * [`.getDescription(options)`](#module_electron-builder/out/targets/LinuxTargetHelper.LinuxTargetHelper+getDescription) ⇒ String @@ -1675,29 +1390,29 @@ Developer API only. See [[Options]] for user documentation. | Name | Type | | --- | --- | -| icons| Promise<Array<Array<string>>> | -| maxIconPath| string \| null | +| icons| Promise<Array<Array<String>>> | +| maxIconPath| String \| null | * [.LinuxTargetHelper](#LinuxTargetHelper) - * [`.computeDesktopEntry(targetSpecificOptions, exec, destination, extra)`](#module_electron-builder/out/targets/LinuxTargetHelper.LinuxTargetHelper+computeDesktopEntry) ⇒ Promise<string> - * [`.getDescription(options)`](#module_electron-builder/out/targets/LinuxTargetHelper.LinuxTargetHelper+getDescription) ⇒ string + * [`.computeDesktopEntry(targetSpecificOptions, exec, destination, extra)`](#module_electron-builder/out/targets/LinuxTargetHelper.LinuxTargetHelper+computeDesktopEntry) ⇒ Promise<String> + * [`.getDescription(options)`](#module_electron-builder/out/targets/LinuxTargetHelper.LinuxTargetHelper+getDescription) ⇒ String -#### `linuxTargetHelper.computeDesktopEntry(targetSpecificOptions, exec, destination, extra)` ⇒ Promise<string> +#### `linuxTargetHelper.computeDesktopEntry(targetSpecificOptions, exec, destination, extra)` ⇒ Promise<String> **Kind**: instance method of [LinuxTargetHelper](#LinuxTargetHelper) | Param | Type | | --- | --- | | targetSpecificOptions | [LinuxTargetSpecificOptions](#LinuxTargetSpecificOptions) | -| exec | string | -| destination | string \| null | -| extra | Object<string, any> | +| exec | String | +| destination | String \| null | +| extra | Object<String, any> | -#### `linuxTargetHelper.getDescription(options)` ⇒ string +#### `linuxTargetHelper.getDescription(options)` ⇒ String **Kind**: instance method of [LinuxTargetHelper](#LinuxTargetHelper) | Param | Type | @@ -1711,12 +1426,10 @@ Developer API only. See [[Options]] for user documentation. * [electron-builder/out/targets/nsis](#module_electron-builder/out/targets/nsis) * [.AppPackageHelper](#AppPackageHelper) * [`.finishBuild()`](#module_electron-builder/out/targets/nsis.AppPackageHelper+finishBuild) ⇒ Promise<any> - * [`.packArch(arch, target)`](#module_electron-builder/out/targets/nsis.AppPackageHelper+packArch) ⇒ Promise<string> + * [`.packArch(arch, target)`](#module_electron-builder/out/targets/nsis.AppPackageHelper+packArch) ⇒ Promise<String> * [.NsisTarget](#NsisTarget) ⇐ [Target](electron-builder-core#Target) * [`.build(appOutDir, arch)`](#module_electron-builder/out/targets/nsis.NsisTarget+build) ⇒ Promise<void> * [`.finishBuild()`](#module_electron-builder/out/targets/nsis.NsisTarget+finishBuild) ⇒ Promise<any> - * [`.configureDefines(oneClick, defines)`](#module_electron-builder/out/targets/nsis.NsisTarget+configureDefines) ⇒ Promise<void> - * [`.generateGitHubInstallerName()`](#module_electron-builder/out/targets/nsis.NsisTarget+generateGitHubInstallerName) ⇒ string @@ -1725,7 +1438,7 @@ Developer API only. See [[Options]] for user documentation. * [.AppPackageHelper](#AppPackageHelper) * [`.finishBuild()`](#module_electron-builder/out/targets/nsis.AppPackageHelper+finishBuild) ⇒ Promise<any> - * [`.packArch(arch, target)`](#module_electron-builder/out/targets/nsis.AppPackageHelper+packArch) ⇒ Promise<string> + * [`.packArch(arch, target)`](#module_electron-builder/out/targets/nsis.AppPackageHelper+packArch) ⇒ Promise<String> @@ -1733,7 +1446,7 @@ Developer API only. See [[Options]] for user documentation. **Kind**: instance method of [AppPackageHelper](#AppPackageHelper) -#### `appPackageHelper.packArch(arch, target)` ⇒ Promise<string> +#### `appPackageHelper.packArch(arch, target)` ⇒ Promise<String> **Kind**: instance method of [AppPackageHelper](#AppPackageHelper) | Param | Type | @@ -1756,8 +1469,6 @@ Developer API only. See [[Options]] for user documentation. * [.NsisTarget](#NsisTarget) ⇐ [Target](electron-builder-core#Target) * [`.build(appOutDir, arch)`](#module_electron-builder/out/targets/nsis.NsisTarget+build) ⇒ Promise<void> * [`.finishBuild()`](#module_electron-builder/out/targets/nsis.NsisTarget+finishBuild) ⇒ Promise<any> - * [`.configureDefines(oneClick, defines)`](#module_electron-builder/out/targets/nsis.NsisTarget+configureDefines) ⇒ Promise<void> - * [`.generateGitHubInstallerName()`](#module_electron-builder/out/targets/nsis.NsisTarget+generateGitHubInstallerName) ⇒ string @@ -1766,29 +1477,13 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | -| appOutDir | string | +| appOutDir | String | | arch | [Arch](electron-builder-core#Arch) | #### `nsisTarget.finishBuild()` ⇒ Promise<any> **Kind**: instance method of [NsisTarget](#NsisTarget) - - -#### `nsisTarget.configureDefines(oneClick, defines)` ⇒ Promise<void> -**Kind**: instance method of [NsisTarget](#NsisTarget) -**Access**: protected - -| Param | Type | -| --- | --- | -| oneClick | boolean | -| defines | any | - - - -#### `nsisTarget.generateGitHubInstallerName()` ⇒ string -**Kind**: instance method of [NsisTarget](#NsisTarget) -**Access**: protected ## electron-builder/out/targets/pkg @@ -1796,7 +1491,7 @@ Developer API only. See [[Options]] for user documentation. * [electron-builder/out/targets/pkg](#module_electron-builder/out/targets/pkg) * [.PkgTarget](#PkgTarget) ⇐ [Target](electron-builder-core#Target) * [`.build(appPath, arch)`](#module_electron-builder/out/targets/pkg.PkgTarget+build) ⇒ Promise<any> - * [`.prepareProductBuildArgs(identity, keychain)`](#module_electron-builder/out/targets/pkg.prepareProductBuildArgs) ⇒ Array<string> + * [`.prepareProductBuildArgs(identity, keychain)`](#module_electron-builder/out/targets/pkg.prepareProductBuildArgs) ⇒ Array<String> @@ -1816,18 +1511,18 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | -| appPath | string | +| appPath | String | | arch | [Arch](electron-builder-core#Arch) | -### `electron-builder/out/targets/pkg.prepareProductBuildArgs(identity, keychain)` ⇒ Array<string> +### `electron-builder/out/targets/pkg.prepareProductBuildArgs(identity, keychain)` ⇒ Array<String> **Kind**: method of [electron-builder/out/targets/pkg](#module_electron-builder/out/targets/pkg) | Param | Type | | --- | --- | -| identity | string \| undefined \| null | -| keychain | string \| undefined \| null | +| identity | String \| undefined \| null | +| keychain | String \| undefined \| null | @@ -1855,7 +1550,7 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | -| appOutDir | string | +| appOutDir | String | | arch | [Arch](electron-builder-core#Arch) | @@ -1865,7 +1560,7 @@ Developer API only. See [[Options]] for user documentation. * [electron-builder/out/targets/targetFactory](#module_electron-builder/out/targets/targetFactory) * [.NoOpTarget](#NoOpTarget) ⇐ [Target](electron-builder-core#Target) * [`.build(appOutDir, arch)`](#module_electron-builder/out/targets/targetFactory.NoOpTarget+build) ⇒ Promise<any> - * [`.computeArchToTargetNamesMap(raw, options, platform)`](#module_electron-builder/out/targets/targetFactory.computeArchToTargetNamesMap) ⇒ Map<[Arch](electron-builder-core#Arch) \| Array<string>> + * [`.computeArchToTargetNamesMap(raw, options, platform)`](#module_electron-builder/out/targets/targetFactory.computeArchToTargetNamesMap) ⇒ Map<[Arch](electron-builder-core#Arch) \| Array<String>> * [`.createCommonTarget(target, outDir, packager)`](#module_electron-builder/out/targets/targetFactory.createCommonTarget) ⇒ [Target](electron-builder-core#Target) * [`.createTargets(nameToTarget, rawList, outDir, packager, cleanupTasks)`](#module_electron-builder/out/targets/targetFactory.createTargets) ⇒ Array<[Target](electron-builder-core#Target)> @@ -1887,18 +1582,18 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | -| appOutDir | string | +| appOutDir | String | | arch | [Arch](electron-builder-core#Arch) | -### `electron-builder/out/targets/targetFactory.computeArchToTargetNamesMap(raw, options, platform)` ⇒ Map<[Arch](electron-builder-core#Arch) \| Array<string>> +### `electron-builder/out/targets/targetFactory.computeArchToTargetNamesMap(raw, options, platform)` ⇒ Map<[Arch](electron-builder-core#Arch) \| Array<String>> **Kind**: method of [electron-builder/out/targets/targetFactory](#module_electron-builder/out/targets/targetFactory) | Param | Type | | --- | --- | -| raw | Map<[Arch](electron-builder-core#Arch) \| Array<string>> | -| options | [PlatformSpecificBuildOptions](electron-builder-core#PlatformSpecificBuildOptions) | +| raw | Map<[Arch](electron-builder-core#Arch) \| Array<String>> | +| options | [PlatformSpecificBuildOptions](#PlatformSpecificBuildOptions) | | platform | [Platform](electron-builder-core#Platform) | @@ -1908,8 +1603,8 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | -| target | string | -| outDir | string | +| target | String | +| outDir | String | | packager | [PlatformPackager](#PlatformPackager)<any> | @@ -1920,8 +1615,8 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | | nameToTarget | Map<String \| [Target](electron-builder-core#Target)> | -| rawList | Array<string> | -| outDir | string | +| rawList | Array<String> | +| outDir | String | | packager | [PlatformPackager](#PlatformPackager)<any> | | cleanupTasks | Array<module:electron-builder/out/targets/targetFactory.__type> | @@ -1931,8 +1626,6 @@ Developer API only. See [[Options]] for user documentation. * [electron-builder/out/targets/WebInstallerTarget](#module_electron-builder/out/targets/WebInstallerTarget) * [.WebInstallerTarget](#WebInstallerTarget) ⇐ [NsisTarget](#NsisTarget) - * [`.configureDefines(oneClick, defines)`](#module_electron-builder/out/targets/WebInstallerTarget.WebInstallerTarget+configureDefines) ⇒ Promise<void> - * [`.generateGitHubInstallerName()`](#module_electron-builder/out/targets/WebInstallerTarget.WebInstallerTarget+generateGitHubInstallerName) ⇒ string * [`.build(appOutDir, arch)`](#module_electron-builder/out/targets/nsis.NsisTarget+build) ⇒ Promise<void> * [`.finishBuild()`](#module_electron-builder/out/targets/nsis.NsisTarget+finishBuild) ⇒ Promise<any> @@ -1943,29 +1636,9 @@ Developer API only. See [[Options]] for user documentation. **Extends**: [NsisTarget](#NsisTarget) * [.WebInstallerTarget](#WebInstallerTarget) ⇐ [NsisTarget](#NsisTarget) - * [`.configureDefines(oneClick, defines)`](#module_electron-builder/out/targets/WebInstallerTarget.WebInstallerTarget+configureDefines) ⇒ Promise<void> - * [`.generateGitHubInstallerName()`](#module_electron-builder/out/targets/WebInstallerTarget.WebInstallerTarget+generateGitHubInstallerName) ⇒ string * [`.build(appOutDir, arch)`](#module_electron-builder/out/targets/nsis.NsisTarget+build) ⇒ Promise<void> * [`.finishBuild()`](#module_electron-builder/out/targets/nsis.NsisTarget+finishBuild) ⇒ Promise<any> - - -#### `webInstallerTarget.configureDefines(oneClick, defines)` ⇒ Promise<void> -**Kind**: instance method of [WebInstallerTarget](#WebInstallerTarget) -**Overrides**: [configureDefines](#module_electron-builder/out/targets/nsis.NsisTarget+configureDefines) -**Access**: protected - -| Param | Type | -| --- | --- | -| oneClick | boolean | -| defines | any | - - - -#### `webInstallerTarget.generateGitHubInstallerName()` ⇒ string -**Kind**: instance method of [WebInstallerTarget](#WebInstallerTarget) -**Overrides**: [generateGitHubInstallerName](#module_electron-builder/out/targets/nsis.NsisTarget+generateGitHubInstallerName) -**Access**: protected #### `webInstallerTarget.build(appOutDir, arch)` ⇒ Promise<void> @@ -1973,72 +1646,13 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | -| appOutDir | string | +| appOutDir | String | | arch | [Arch](electron-builder-core#Arch) | #### `webInstallerTarget.finishBuild()` ⇒ Promise<any> **Kind**: instance method of [WebInstallerTarget](#WebInstallerTarget) - - -## 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<any> - * [`.getElectronVersion(config, projectDir, projectMetadata)`](#module_electron-builder/out/util/readPackageJson.getElectronVersion) ⇒ Promise<string> - * [`.loadConfig(projectDir)`](#module_electron-builder/out/util/readPackageJson.loadConfig) ⇒ Promise< \| [Config](Options#Config)> - * [`.readPackageJson(file)`](#module_electron-builder/out/util/readPackageJson.readPackageJson) ⇒ Promise<any> - * [`.validateConfig(config)`](#module_electron-builder/out/util/readPackageJson.validateConfig) ⇒ Promise<void> - - - -### `electron-builder/out/util/readPackageJson.doLoadConfig(configFile, projectDir)` ⇒ Promise<any> -**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<string> -**Kind**: method of [electron-builder/out/util/readPackageJson](#module_electron-builder/out/util/readPackageJson) - -| Param | Type | -| --- | --- | -| config | [Config](Options#Config) \| null \| undefined | -| projectDir | string | -| projectMetadata | any \| null | - - - -### `electron-builder/out/util/readPackageJson.loadConfig(projectDir)` ⇒ Promise< \| [Config](Options#Config)> -**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<any> -**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<void> -**Kind**: method of [electron-builder/out/util/readPackageJson](#module_electron-builder/out/util/readPackageJson) - -| Param | Type | -| --- | --- | -| config | [Config](Options#Config) | - ## electron-builder/out/windowsCodeSign @@ -2046,8 +1660,8 @@ Developer API only. See [[Options]] for user documentation. * [electron-builder/out/windowsCodeSign](#module_electron-builder/out/windowsCodeSign) * [`.FileCodeSigningInfo`](#FileCodeSigningInfo) * [`.SignOptions`](#SignOptions) - * [`.getSignVendorPath()`](#module_electron-builder/out/windowsCodeSign.getSignVendorPath) ⇒ Promise<string> - * [`.getToolPath()`](#module_electron-builder/out/windowsCodeSign.getToolPath) ⇒ Promise<string> + * [`.getSignVendorPath()`](#module_electron-builder/out/windowsCodeSign.getSignVendorPath) ⇒ Promise<String> + * [`.getToolPath()`](#module_electron-builder/out/windowsCodeSign.getToolPath) ⇒ Promise<String> * [`.sign(options)`](#module_electron-builder/out/windowsCodeSign.sign) ⇒ Promise<void> @@ -2058,10 +1672,10 @@ Developer API only. See [[Options]] for user documentation. | Name | Type | | --- | --- | -| file| string \| null | -| password| string \| null | -| subjectName| string \| null | -| certificateSha1| string \| null | +| file| String \| null | +| password| String \| null | +| subjectName| String \| null | +| certificateSha1| String \| null | @@ -2071,20 +1685,20 @@ Developer API only. See [[Options]] for user documentation. | Name | Type | | --- | --- | -| **path**| string | -| cert| string \| null | -| name| string \| null | -| password| string \| null | -| site| string \| null | +| **path**| String | +| cert| String \| null | +| name| String \| null | +| password| String \| null | +| site| String \| null | | **options**| [WinBuildOptions](Options#WinBuildOptions) | -### `electron-builder/out/windowsCodeSign.getSignVendorPath()` ⇒ Promise<string> +### `electron-builder/out/windowsCodeSign.getSignVendorPath()` ⇒ Promise<String> **Kind**: method of [electron-builder/out/windowsCodeSign](#module_electron-builder/out/windowsCodeSign) -### `electron-builder/out/windowsCodeSign.getToolPath()` ⇒ Promise<string> +### `electron-builder/out/windowsCodeSign.getToolPath()` ⇒ Promise<String> **Kind**: method of [electron-builder/out/windowsCodeSign](#module_electron-builder/out/windowsCodeSign) @@ -2102,30 +1716,22 @@ Developer API only. See [[Options]] for user documentation. * [electron-builder/out/winPackager](#module_electron-builder/out/winPackager) * [.WinPackager](#WinPackager) ⇐ [PlatformPackager](#PlatformPackager) * [`.createTargets(targets, mapper, cleanupTasks)`](#module_electron-builder/out/winPackager.WinPackager+createTargets) - * [`.getIconPath()`](#module_electron-builder/out/winPackager.WinPackager+getIconPath) ⇒ Promise<string> + * [`.getIconPath()`](#module_electron-builder/out/winPackager.WinPackager+getIconPath) ⇒ Promise<String> * [`.sign(file, logMessagePrefix)`](#module_electron-builder/out/winPackager.WinPackager+sign) ⇒ Promise<void> * [`.signAndEditResources(file)`](#module_electron-builder/out/winPackager.WinPackager+signAndEditResources) ⇒ Promise<void> - * [`.doGetCscPassword()`](#module_electron-builder/out/winPackager.WinPackager+doGetCscPassword) ⇒ string - * [`.doSign(options)`](#module_electron-builder/out/winPackager.WinPackager+doSign) ⇒ Promise<void> - * [`.postInitApp(appOutDir)`](#module_electron-builder/out/winPackager.WinPackager+postInitApp) ⇒ Promise<void> - * [`.getDefaultIcon(ext)`](#module_electron-builder/out/platformPackager.PlatformPackager+getDefaultIcon) ⇒ Promise< \| string> + * [`.getDefaultIcon(ext)`](#module_electron-builder/out/platformPackager.PlatformPackager+getDefaultIcon) ⇒ Promise< \| String> * [`.dispatchArtifactCreated(file, target, arch, safeArtifactName)`](#module_electron-builder/out/platformPackager.PlatformPackager+dispatchArtifactCreated) - * [`.getElectronDestDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getElectronDestDir) ⇒ string - * [`.getElectronSrcDir(dist)`](#module_electron-builder/out/platformPackager.PlatformPackager+getElectronSrcDir) ⇒ string - * [`.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 + * [`.getElectronDestDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getElectronDestDir) ⇒ String + * [`.getElectronSrcDir(dist)`](#module_electron-builder/out/platformPackager.PlatformPackager+getElectronSrcDir) ⇒ String + * [`.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<any> - * [`.getResource(custom, names)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResource) ⇒ Promise< \| string> - * [`.getResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResourcesDir) ⇒ string - * [`.getTempFile(suffix)`](#module_electron-builder/out/platformPackager.PlatformPackager+getTempFile) ⇒ Promise<string> - * [`.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<void> - * [`.packageInDistributableFormat(appOutDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+packageInDistributableFormat) - * [`.prepareAppInfo(appInfo)`](#module_electron-builder/out/platformPackager.PlatformPackager+prepareAppInfo) ⇒ [AppInfo](#AppInfo) + * [`.getResource(custom, names)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResource) ⇒ Promise< \| String> + * [`.getResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResourcesDir) ⇒ String + * [`.getTempFile(suffix)`](#module_electron-builder/out/platformPackager.PlatformPackager+getTempFile) ⇒ Promise<String> @@ -2202,30 +1808,22 @@ Developer API only. See [[Options]] for user documentation. * [.WinPackager](#WinPackager) ⇐ [PlatformPackager](#PlatformPackager) * [`.createTargets(targets, mapper, cleanupTasks)`](#module_electron-builder/out/winPackager.WinPackager+createTargets) - * [`.getIconPath()`](#module_electron-builder/out/winPackager.WinPackager+getIconPath) ⇒ Promise<string> + * [`.getIconPath()`](#module_electron-builder/out/winPackager.WinPackager+getIconPath) ⇒ Promise<String> * [`.sign(file, logMessagePrefix)`](#module_electron-builder/out/winPackager.WinPackager+sign) ⇒ Promise<void> * [`.signAndEditResources(file)`](#module_electron-builder/out/winPackager.WinPackager+signAndEditResources) ⇒ Promise<void> - * [`.doGetCscPassword()`](#module_electron-builder/out/winPackager.WinPackager+doGetCscPassword) ⇒ string - * [`.doSign(options)`](#module_electron-builder/out/winPackager.WinPackager+doSign) ⇒ Promise<void> - * [`.postInitApp(appOutDir)`](#module_electron-builder/out/winPackager.WinPackager+postInitApp) ⇒ Promise<void> - * [`.getDefaultIcon(ext)`](#module_electron-builder/out/platformPackager.PlatformPackager+getDefaultIcon) ⇒ Promise< \| string> + * [`.getDefaultIcon(ext)`](#module_electron-builder/out/platformPackager.PlatformPackager+getDefaultIcon) ⇒ Promise< \| String> * [`.dispatchArtifactCreated(file, target, arch, safeArtifactName)`](#module_electron-builder/out/platformPackager.PlatformPackager+dispatchArtifactCreated) - * [`.getElectronDestDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getElectronDestDir) ⇒ string - * [`.getElectronSrcDir(dist)`](#module_electron-builder/out/platformPackager.PlatformPackager+getElectronSrcDir) ⇒ string - * [`.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 + * [`.getElectronDestDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getElectronDestDir) ⇒ String + * [`.getElectronSrcDir(dist)`](#module_electron-builder/out/platformPackager.PlatformPackager+getElectronSrcDir) ⇒ String + * [`.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<any> - * [`.getResource(custom, names)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResource) ⇒ Promise< \| string> - * [`.getResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResourcesDir) ⇒ string - * [`.getTempFile(suffix)`](#module_electron-builder/out/platformPackager.PlatformPackager+getTempFile) ⇒ Promise<string> - * [`.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<void> - * [`.packageInDistributableFormat(appOutDir, arch, targets, postAsyncTasks)`](#module_electron-builder/out/platformPackager.PlatformPackager+packageInDistributableFormat) - * [`.prepareAppInfo(appInfo)`](#module_electron-builder/out/platformPackager.PlatformPackager+prepareAppInfo) ⇒ [AppInfo](#AppInfo) + * [`.getResource(custom, names)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResource) ⇒ Promise< \| String> + * [`.getResourcesDir(appOutDir)`](#module_electron-builder/out/platformPackager.PlatformPackager+getResourcesDir) ⇒ String + * [`.getTempFile(suffix)`](#module_electron-builder/out/platformPackager.PlatformPackager+getTempFile) ⇒ Promise<String> @@ -2235,13 +1833,13 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | -| targets | Array<string> | +| targets | Array<String> | | mapper | callback | | cleanupTasks | Array<module:electron-builder/out/winPackager.__type> | -#### `winPackager.getIconPath()` ⇒ Promise<string> +#### `winPackager.getIconPath()` ⇒ Promise<String> **Kind**: instance method of [WinPackager](#WinPackager) **Overrides**: [getIconPath](#module_electron-builder/out/platformPackager.PlatformPackager+getIconPath) @@ -2251,8 +1849,8 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | -| file | string | -| logMessagePrefix | string | +| file | String | +| logMessagePrefix | String | @@ -2261,43 +1859,16 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | -| file | string | - - - -#### `winPackager.doGetCscPassword()` ⇒ string -**Kind**: instance method of [WinPackager](#WinPackager) -**Overrides**: [doGetCscPassword](#module_electron-builder/out/platformPackager.PlatformPackager+doGetCscPassword) -**Access**: protected - - -#### `winPackager.doSign(options)` ⇒ Promise<void> -**Kind**: instance method of [WinPackager](#WinPackager) -**Access**: protected - -| Param | Type | -| --- | --- | -| options | [SignOptions](#SignOptions) | - - - -#### `winPackager.postInitApp(appOutDir)` ⇒ Promise<void> -**Kind**: instance method of [WinPackager](#WinPackager) -**Overrides**: [postInitApp](#module_electron-builder/out/platformPackager.PlatformPackager+postInitApp) -**Access**: protected - -| Param | Type | -| --- | --- | -| appOutDir | string | +| file | String | -#### `winPackager.getDefaultIcon(ext)` ⇒ Promise< \| string> +#### `winPackager.getDefaultIcon(ext)` ⇒ Promise< \| String> **Kind**: instance method of [WinPackager](#WinPackager) | Param | Type | | --- | --- | -| ext | string | +| ext | String | @@ -2306,83 +1877,83 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | -| file | string | +| file | String | | target | [Target](electron-builder-core#Target) \| null | | arch | [Arch](electron-builder-core#Arch) \| null | -| safeArtifactName | string | +| safeArtifactName | String | -#### `winPackager.getElectronDestDir(appOutDir)` ⇒ string +#### `winPackager.getElectronDestDir(appOutDir)` ⇒ String **Kind**: instance method of [WinPackager](#WinPackager) | Param | Type | | --- | --- | -| appOutDir | string | +| appOutDir | String | -#### `winPackager.getElectronSrcDir(dist)` ⇒ string +#### `winPackager.getElectronSrcDir(dist)` ⇒ String **Kind**: instance method of [WinPackager](#WinPackager) | Param | Type | | --- | --- | -| dist | string | +| dist | String | -#### `winPackager.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern)` ⇒ string +#### `winPackager.expandArtifactNamePattern(targetSpecificOptions, ext, arch, defaultPattern)` ⇒ String **Kind**: instance method of [WinPackager](#WinPackager) | Param | Type | | --- | --- | | targetSpecificOptions | [TargetSpecificOptions](electron-builder-core#TargetSpecificOptions) \| undefined \| null | -| ext | string | +| ext | String | | arch | [Arch](electron-builder-core#Arch) \| null | -| defaultPattern | string | +| defaultPattern | String | -#### `winPackager.expandMacro(pattern, arch, extra)` ⇒ string +#### `winPackager.expandMacro(pattern, arch, extra)` ⇒ String **Kind**: instance method of [WinPackager](#WinPackager) | Param | Type | | --- | --- | -| pattern | string | -| arch | string \| undefined \| null | +| pattern | String | +| arch | String \| undefined \| null | | extra | any | -#### `winPackager.generateName(ext, arch, deployment, classifier)` ⇒ string +#### `winPackager.generateName(ext, arch, deployment, classifier)` ⇒ String **Kind**: instance method of [WinPackager](#WinPackager) | Param | Type | | --- | --- | -| ext | string \| null | +| ext | String \| null | | arch | [Arch](electron-builder-core#Arch) | -| deployment | boolean | -| classifier | string \| null | +| deployment | Boolean | +| classifier | String \| null | -#### `winPackager.generateName2(ext, classifier, deployment)` ⇒ string +#### `winPackager.generateName2(ext, classifier, deployment)` ⇒ String **Kind**: instance method of [WinPackager](#WinPackager) | Param | Type | | --- | --- | -| ext | string \| null | -| classifier | string \| undefined \| null | -| deployment | boolean | +| ext | String \| null | +| classifier | String \| undefined \| null | +| deployment | Boolean | -#### `winPackager.getMacOsResourcesDir(appOutDir)` ⇒ string +#### `winPackager.getMacOsResourcesDir(appOutDir)` ⇒ String **Kind**: instance method of [WinPackager](#WinPackager) | Param | Type | | --- | --- | -| appOutDir | string | +| appOutDir | String | @@ -2391,92 +1962,38 @@ Developer API only. See [[Options]] for user documentation. | Param | Type | | --- | --- | -| outDir | string | +| outDir | String | | arch | [Arch](electron-builder-core#Arch) | | targets | Array<[Target](electron-builder-core#Target)> | | postAsyncTasks | Array<Promise<any>> | -#### `winPackager.getResource(custom, names)` ⇒ Promise< \| string> +#### `winPackager.getResource(custom, names)` ⇒ Promise< \| String> **Kind**: instance method of [WinPackager](#WinPackager) | Param | Type | | --- | --- | -| custom | string \| undefined \| null | -| names | Array<string> | +| custom | String \| undefined \| null | +| names | Array<String> | -#### `winPackager.getResourcesDir(appOutDir)` ⇒ string +#### `winPackager.getResourcesDir(appOutDir)` ⇒ String **Kind**: instance method of [WinPackager](#WinPackager) | Param | Type | | --- | --- | -| appOutDir | string | +| appOutDir | String | -#### `winPackager.getTempFile(suffix)` ⇒ Promise<string> -**Kind**: instance method of [WinPackager](#WinPackager) - -| Param | Type | -| --- | --- | -| suffix | string | - - - -#### `winPackager.computeAppOutDir(outDir, arch)` ⇒ string -**Kind**: instance method of [WinPackager](#WinPackager) -**Access**: protected - -| Param | Type | -| --- | --- | -| outDir | string | -| arch | [Arch](electron-builder-core#Arch) | - - - -#### `winPackager.getCscPassword()` ⇒ string -**Kind**: instance method of [WinPackager](#WinPackager) -**Access**: protected - - -#### `winPackager.doPack(outDir, appOutDir, platformName, arch, platformSpecificBuildOptions, targets)` ⇒ Promise<void> -**Kind**: instance method of [WinPackager](#WinPackager) -**Access**: protected - -| Param | Type | -| --- | --- | -| outDir | string | -| appOutDir | string | -| platformName | string | -| arch | [Arch](electron-builder-core#Arch) | -| platformSpecificBuildOptions | module:electron-builder/out/platformPackager.DC | -| targets | Array<[Target](electron-builder-core#Target)> | - - - -#### `winPackager.packageInDistributableFormat(appOutDir, arch, targets, postAsyncTasks)` -**Kind**: instance method of [WinPackager](#WinPackager) -**Access**: protected - -| Param | Type | -| --- | --- | -| appOutDir | string | -| arch | [Arch](electron-builder-core#Arch) | -| targets | Array<[Target](electron-builder-core#Target)> | -| postAsyncTasks | Array<Promise<any>> | - - - -#### `winPackager.prepareAppInfo(appInfo)` ⇒ [AppInfo](#AppInfo) +#### `winPackager.getTempFile(suffix)` ⇒ Promise<String> **Kind**: instance method of [WinPackager](#WinPackager) -**Access**: protected | Param | Type | | --- | --- | -| appInfo | [AppInfo](#AppInfo) | +| suffix | String | \ No newline at end of file diff --git a/docs/api/electron-publish.md b/docs/api/electron-publish.md index 50f4e3010f7..f217a4de29e 100644 --- a/docs/api/electron-publish.md +++ b/docs/api/electron-publish.md @@ -20,12 +20,9 @@ * [electron-publish/out/BintrayPublisher](#module_electron-publish/out/BintrayPublisher) * [.BintrayPublisher](#BintrayPublisher) ⇐ [HttpPublisher](#HttpPublisher) * [`.deleteRelease()`](#module_electron-publish/out/BintrayPublisher.BintrayPublisher+deleteRelease) ⇒ Promise<any> - * [`.toString()`](#module_electron-publish/out/BintrayPublisher.BintrayPublisher+toString) ⇒ string - * [`.doUpload(fileName, dataLength, requestProcessor)`](#module_electron-publish/out/BintrayPublisher.BintrayPublisher+doUpload) ⇒ Promise<any> + * [`.toString()`](#module_electron-publish/out/BintrayPublisher.BintrayPublisher+toString) ⇒ String * [`.upload(file, safeArtifactName)`](#module_electron-publish.HttpPublisher+upload) ⇒ Promise<any> * [`.uploadData(data, fileName)`](#module_electron-publish.HttpPublisher+uploadData) ⇒ Promise<any> - * [`.createProgressBar(fileName, fileStat)`](#module_electron-publish.Publisher+createProgressBar) ⇒ null \| [ProgressBar](#ProgressBar) - * [`.createReadStreamAndProgressBar(file, fileStat, progressBar, reject)`](#module_electron-publish.Publisher+createReadStreamAndProgressBar) ⇒ NodeJS:ReadableStream @@ -41,12 +38,9 @@ * [.BintrayPublisher](#BintrayPublisher) ⇐ [HttpPublisher](#HttpPublisher) * [`.deleteRelease()`](#module_electron-publish/out/BintrayPublisher.BintrayPublisher+deleteRelease) ⇒ Promise<any> - * [`.toString()`](#module_electron-publish/out/BintrayPublisher.BintrayPublisher+toString) ⇒ string - * [`.doUpload(fileName, dataLength, requestProcessor)`](#module_electron-publish/out/BintrayPublisher.BintrayPublisher+doUpload) ⇒ Promise<any> + * [`.toString()`](#module_electron-publish/out/BintrayPublisher.BintrayPublisher+toString) ⇒ String * [`.upload(file, safeArtifactName)`](#module_electron-publish.HttpPublisher+upload) ⇒ Promise<any> * [`.uploadData(data, fileName)`](#module_electron-publish.HttpPublisher+uploadData) ⇒ Promise<any> - * [`.createProgressBar(fileName, fileStat)`](#module_electron-publish.Publisher+createProgressBar) ⇒ null \| [ProgressBar](#ProgressBar) - * [`.createReadStreamAndProgressBar(file, fileStat, progressBar, reject)`](#module_electron-publish.Publisher+createReadStreamAndProgressBar) ⇒ NodeJS:ReadableStream @@ -54,22 +48,9 @@ **Kind**: instance method of [BintrayPublisher](#BintrayPublisher) -#### `bintrayPublisher.toString()` ⇒ string +#### `bintrayPublisher.toString()` ⇒ String **Kind**: instance method of [BintrayPublisher](#BintrayPublisher) **Overrides**: [toString](#module_electron-publish.Publisher+toString) - - -#### `bintrayPublisher.doUpload(fileName, dataLength, requestProcessor)` ⇒ Promise<any> -**Kind**: instance method of [BintrayPublisher](#BintrayPublisher) -**Overrides**: [doUpload](#module_electron-publish.HttpPublisher+doUpload) -**Access**: protected - -| Param | Type | -| --- | --- | -| fileName | string | -| dataLength | number | -| requestProcessor | callback | - #### `bintrayPublisher.upload(file, safeArtifactName)` ⇒ Promise<any> @@ -77,8 +58,8 @@ | Param | Type | | --- | --- | -| file | string | -| safeArtifactName | string | +| file | String | +| safeArtifactName | String | @@ -88,31 +69,7 @@ | Param | Type | | --- | --- | | data | Buffer | -| fileName | string | - - - -#### `bintrayPublisher.createProgressBar(fileName, fileStat)` ⇒ null \| [ProgressBar](#ProgressBar) -**Kind**: instance method of [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](#BintrayPublisher) -**Access**: protected - -| Param | Type | -| --- | --- | -| file | string | -| fileStat | module:fs.Stats | -| progressBar | [ProgressBar](#ProgressBar) \| null | -| reject | callback | +| fileName | String | @@ -123,12 +80,9 @@ * [.GitHubPublisher](#GitHubPublisher) ⇐ [HttpPublisher](#HttpPublisher) * [`.deleteRelease()`](#module_electron-publish/out/gitHubPublisher.GitHubPublisher+deleteRelease) ⇒ Promise<any> * [`.getRelease()`](#module_electron-publish/out/gitHubPublisher.GitHubPublisher+getRelease) ⇒ Promise<any> - * [`.toString()`](#module_electron-publish/out/gitHubPublisher.GitHubPublisher+toString) ⇒ string - * [`.doUpload(fileName, dataLength, requestProcessor)`](#module_electron-publish/out/gitHubPublisher.GitHubPublisher+doUpload) ⇒ Promise<void> + * [`.toString()`](#module_electron-publish/out/gitHubPublisher.GitHubPublisher+toString) ⇒ String * [`.upload(file, safeArtifactName)`](#module_electron-publish.HttpPublisher+upload) ⇒ Promise<any> * [`.uploadData(data, fileName)`](#module_electron-publish.HttpPublisher+uploadData) ⇒ Promise<any> - * [`.createProgressBar(fileName, fileStat)`](#module_electron-publish.Publisher+createProgressBar) ⇒ null \| [ProgressBar](#ProgressBar) - * [`.createReadStreamAndProgressBar(file, fileStat, progressBar, reject)`](#module_electron-publish.Publisher+createReadStreamAndProgressBar) ⇒ NodeJS:ReadableStream @@ -138,12 +92,12 @@ | Name | Type | | --- | --- | -| **id**| number | -| **tag_name**| string | -| **draft**| boolean | -| **prerelease**| boolean | -| **published_at**| string | -| **upload_url**| string | +| **id**| Number | +| **tag_name**| String | +| **draft**| Boolean | +| **prerelease**| Boolean | +| **published_at**| String | +| **upload_url**| String | @@ -160,12 +114,9 @@ * [.GitHubPublisher](#GitHubPublisher) ⇐ [HttpPublisher](#HttpPublisher) * [`.deleteRelease()`](#module_electron-publish/out/gitHubPublisher.GitHubPublisher+deleteRelease) ⇒ Promise<any> * [`.getRelease()`](#module_electron-publish/out/gitHubPublisher.GitHubPublisher+getRelease) ⇒ Promise<any> - * [`.toString()`](#module_electron-publish/out/gitHubPublisher.GitHubPublisher+toString) ⇒ string - * [`.doUpload(fileName, dataLength, requestProcessor)`](#module_electron-publish/out/gitHubPublisher.GitHubPublisher+doUpload) ⇒ Promise<void> + * [`.toString()`](#module_electron-publish/out/gitHubPublisher.GitHubPublisher+toString) ⇒ String * [`.upload(file, safeArtifactName)`](#module_electron-publish.HttpPublisher+upload) ⇒ Promise<any> * [`.uploadData(data, fileName)`](#module_electron-publish.HttpPublisher+uploadData) ⇒ Promise<any> - * [`.createProgressBar(fileName, fileStat)`](#module_electron-publish.Publisher+createProgressBar) ⇒ null \| [ProgressBar](#ProgressBar) - * [`.createReadStreamAndProgressBar(file, fileStat, progressBar, reject)`](#module_electron-publish.Publisher+createReadStreamAndProgressBar) ⇒ NodeJS:ReadableStream @@ -177,22 +128,9 @@ **Kind**: instance method of [GitHubPublisher](#GitHubPublisher) -#### `gitHubPublisher.toString()` ⇒ string +#### `gitHubPublisher.toString()` ⇒ String **Kind**: instance method of [GitHubPublisher](#GitHubPublisher) **Overrides**: [toString](#module_electron-publish.Publisher+toString) - - -#### `gitHubPublisher.doUpload(fileName, dataLength, requestProcessor)` ⇒ Promise<void> -**Kind**: instance method of [GitHubPublisher](#GitHubPublisher) -**Overrides**: [doUpload](#module_electron-publish.HttpPublisher+doUpload) -**Access**: protected - -| Param | Type | -| --- | --- | -| fileName | string | -| dataLength | number | -| requestProcessor | callback | - #### `gitHubPublisher.upload(file, safeArtifactName)` ⇒ Promise<any> @@ -200,8 +138,8 @@ | Param | Type | | --- | --- | -| file | string | -| safeArtifactName | string | +| file | String | +| safeArtifactName | String | @@ -211,31 +149,7 @@ | Param | Type | | --- | --- | | data | Buffer | -| fileName | string | - - - -#### `gitHubPublisher.createProgressBar(fileName, fileStat)` ⇒ null \| [ProgressBar](#ProgressBar) -**Kind**: instance method of [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](#GitHubPublisher) -**Access**: protected - -| Param | Type | -| --- | --- | -| file | string | -| fileStat | module:fs.Stats | -| progressBar | [ProgressBar](#ProgressBar) \| null | -| reject | callback | +| fileName | String | @@ -262,7 +176,7 @@ | Param | Type | | --- | --- | -| format | string | +| format | String | | options | any | @@ -291,7 +205,7 @@ | Name | Type | | --- | --- | -| total| number | +| total| Number | * [.ProgressBar](#ProgressBar) @@ -310,7 +224,7 @@ | Param | Type | | --- | --- | -| message | string | +| message | String | @@ -329,7 +243,7 @@ | Param | Type | | --- | --- | -| delta | number | +| delta | Number | @@ -346,7 +260,7 @@ A ratio of 0.5 will attempt to set the progress to halfway. | Param | Type | | --- | --- | -| ratio | number | +| ratio | Number | @@ -359,8 +273,8 @@ A ratio of 0.5 will attempt to set the progress to halfway. | Param | Type | | --- | --- | -| transferred | number | -| total | number | +| transferred | Number | +| total | Number | @@ -372,15 +286,10 @@ A ratio of 0.5 will attempt to set the progress to halfway. * [.HttpPublisher](#HttpPublisher) ⇐ [Publisher](#Publisher) * [`.upload(file, safeArtifactName)`](#module_electron-publish.HttpPublisher+upload) ⇒ Promise<any> * [`.uploadData(data, fileName)`](#module_electron-publish.HttpPublisher+uploadData) ⇒ Promise<any> - * [`.doUpload(fileName, dataLength, requestProcessor, file)`](#module_electron-publish.HttpPublisher+doUpload) ⇒ Promise<any> - * [`.toString()`](#module_electron-publish.Publisher+toString) ⇒ string - * [`.createProgressBar(fileName, fileStat)`](#module_electron-publish.Publisher+createProgressBar) ⇒ null \| [ProgressBar](#ProgressBar) - * [`.createReadStreamAndProgressBar(file, fileStat, progressBar, reject)`](#module_electron-publish.Publisher+createReadStreamAndProgressBar) ⇒ NodeJS:ReadableStream + * [`.toString()`](#module_electron-publish.Publisher+toString) ⇒ String * [.Publisher](#Publisher) - * [`.toString()`](#module_electron-publish.Publisher+toString) ⇒ string + * [`.toString()`](#module_electron-publish.Publisher+toString) ⇒ String * [`.upload(file, safeArtifactName)`](#module_electron-publish.Publisher+upload) ⇒ Promise<any> - * [`.createProgressBar(fileName, fileStat)`](#module_electron-publish.Publisher+createProgressBar) ⇒ null \| [ProgressBar](#ProgressBar) - * [`.createReadStreamAndProgressBar(file, fileStat, progressBar, reject)`](#module_electron-publish.Publisher+createReadStreamAndProgressBar) ⇒ NodeJS:ReadableStream @@ -402,8 +311,8 @@ A ratio of 0.5 will attempt to set the progress to halfway. | Name | Type | | --- | --- | | publish| "onTag" \| "onTagOrDraft" \| "always" \| "never" \| null | -| draft| boolean | -| prerelease| boolean | +| draft| Boolean | +| prerelease| Boolean | @@ -414,10 +323,7 @@ A ratio of 0.5 will attempt to set the progress to halfway. * [.HttpPublisher](#HttpPublisher) ⇐ [Publisher](#Publisher) * [`.upload(file, safeArtifactName)`](#module_electron-publish.HttpPublisher+upload) ⇒ Promise<any> * [`.uploadData(data, fileName)`](#module_electron-publish.HttpPublisher+uploadData) ⇒ Promise<any> - * [`.doUpload(fileName, dataLength, requestProcessor, file)`](#module_electron-publish.HttpPublisher+doUpload) ⇒ Promise<any> - * [`.toString()`](#module_electron-publish.Publisher+toString) ⇒ string - * [`.createProgressBar(fileName, fileStat)`](#module_electron-publish.Publisher+createProgressBar) ⇒ null \| [ProgressBar](#ProgressBar) - * [`.createReadStreamAndProgressBar(file, fileStat, progressBar, reject)`](#module_electron-publish.Publisher+createReadStreamAndProgressBar) ⇒ NodeJS:ReadableStream + * [`.toString()`](#module_electron-publish.Publisher+toString) ⇒ String @@ -427,8 +333,8 @@ A ratio of 0.5 will attempt to set the progress to halfway. | Param | Type | | --- | --- | -| file | string | -| safeArtifactName | string | +| file | String | +| safeArtifactName | String | @@ -438,63 +344,24 @@ A ratio of 0.5 will attempt to set the progress to halfway. | Param | Type | | --- | --- | | data | Buffer | -| fileName | string | - - - -#### `httpPublisher.doUpload(fileName, dataLength, requestProcessor, file)` ⇒ Promise<any> -**Kind**: instance method of [HttpPublisher](#HttpPublisher) -**Access**: protected - -| Param | Type | -| --- | --- | -| fileName | string | -| dataLength | number | -| requestProcessor | callback | -| file | string | +| fileName | String | -#### `httpPublisher.toString()` ⇒ string -**Kind**: instance method of [HttpPublisher](#HttpPublisher) - - -#### `httpPublisher.createProgressBar(fileName, fileStat)` ⇒ null \| [ProgressBar](#ProgressBar) -**Kind**: instance method of [HttpPublisher](#HttpPublisher) -**Access**: protected - -| Param | Type | -| --- | --- | -| fileName | string | -| fileStat | module:fs.Stats | - - - -#### `httpPublisher.createReadStreamAndProgressBar(file, fileStat, progressBar, reject)` ⇒ NodeJS:ReadableStream +#### `httpPublisher.toString()` ⇒ String **Kind**: instance method of [HttpPublisher](#HttpPublisher) -**Access**: protected - -| Param | Type | -| --- | --- | -| file | string | -| fileStat | module:fs.Stats | -| progressBar | [ProgressBar](#ProgressBar) \| null | -| reject | callback | - ### Publisher **Kind**: class of [electron-publish](#module_electron-publish) * [.Publisher](#Publisher) - * [`.toString()`](#module_electron-publish.Publisher+toString) ⇒ string + * [`.toString()`](#module_electron-publish.Publisher+toString) ⇒ String * [`.upload(file, safeArtifactName)`](#module_electron-publish.Publisher+upload) ⇒ Promise<any> - * [`.createProgressBar(fileName, fileStat)`](#module_electron-publish.Publisher+createProgressBar) ⇒ null \| [ProgressBar](#ProgressBar) - * [`.createReadStreamAndProgressBar(file, fileStat, progressBar, reject)`](#module_electron-publish.Publisher+createReadStreamAndProgressBar) ⇒ NodeJS:ReadableStream -#### `publisher.toString()` ⇒ string +#### `publisher.toString()` ⇒ String **Kind**: instance method of [Publisher](#Publisher) @@ -503,30 +370,6 @@ A ratio of 0.5 will attempt to set the progress to halfway. | Param | Type | | --- | --- | -| file | string | -| safeArtifactName | string | - - - -#### `publisher.createProgressBar(fileName, fileStat)` ⇒ null \| [ProgressBar](#ProgressBar) -**Kind**: instance method of [Publisher](#Publisher) -**Access**: protected - -| Param | Type | -| --- | --- | -| fileName | string | -| fileStat | module:fs.Stats | - - - -#### `publisher.createReadStreamAndProgressBar(file, fileStat, progressBar, reject)` ⇒ NodeJS:ReadableStream -**Kind**: instance method of [Publisher](#Publisher) -**Access**: protected - -| Param | Type | -| --- | --- | -| file | string | -| fileStat | module:fs.Stats | -| progressBar | [ProgressBar](#ProgressBar) \| null | -| reject | callback | +| file | String | +| safeArtifactName | String | diff --git a/docs/api/electron-updater.md b/docs/api/electron-updater.md index 9288cbef0e8..262b15a0880 100644 --- a/docs/api/electron-updater.md +++ b/docs/api/electron-updater.md @@ -60,7 +60,7 @@ Developer API only. See [[Auto Update]] for user documentation. * [.ElectronHttpExecutor](#ElectronHttpExecutor) ⇐ [HttpExecutor](electron-builder-http#HttpExecutor) * [`.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+doApiRequest) ⇒ Promise<module:electron-updater/out/electronHttpExecutor.T> * [`.doRequest(options, callback)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+doRequest) ⇒ any - * [`.download(url, destination, options)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+download) ⇒ Promise<string> + * [`.download(url, destination, options)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+download) ⇒ Promise<String> @@ -71,7 +71,7 @@ Developer API only. See [[Auto Update]] for user documentation. * [.ElectronHttpExecutor](#ElectronHttpExecutor) ⇐ [HttpExecutor](electron-builder-http#HttpExecutor) * [`.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+doApiRequest) ⇒ Promise<module:electron-updater/out/electronHttpExecutor.T> * [`.doRequest(options, callback)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+doRequest) ⇒ any - * [`.download(url, destination, options)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+download) ⇒ Promise<string> + * [`.download(url, destination, options)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+download) ⇒ Promise<String> @@ -83,7 +83,7 @@ Developer API only. See [[Auto Update]] for user documentation. | options | any | | cancellationToken | [CancellationToken](electron-builder-http#CancellationToken) | | requestProcessor | callback | -| redirectCount | number | +| redirectCount | Number | @@ -97,13 +97,13 @@ Developer API only. See [[Auto Update]] for user documentation. -#### `electronHttpExecutor.download(url, destination, options)` ⇒ Promise<string> +#### `electronHttpExecutor.download(url, destination, options)` ⇒ Promise<String> **Kind**: instance method of [ElectronHttpExecutor](#ElectronHttpExecutor) | Param | Type | | --- | --- | -| url | string | -| destination | string | +| url | String | +| destination | String | | options | [DownloadOptions](electron-builder-http#DownloadOptions) | @@ -153,12 +153,6 @@ Developer API only. See [[Auto Update]] for user documentation. ### BaseGitHubProvider ⇐ [Provider](Auto-Update#Provider) **Kind**: class of [electron-updater/out/GitHubProvider](#module_electron-updater/out/GitHubProvider) **Extends**: [Provider](Auto-Update#Provider) -**Properties** - -| Name | Type | -| --- | --- | -| baseUrl| module:http.RequestOptions | - ### GitHubProvider ⇐ [BaseGitHubProvider](#BaseGitHubProvider) @@ -189,34 +183,16 @@ Developer API only. See [[Auto Update]] for user documentation. * [electron-updater/out/MacUpdater](#module_electron-updater/out/MacUpdater) * [.MacUpdater](#MacUpdater) ⇐ [AppUpdater](Auto-Update#AppUpdater) * [`.quitAndInstall()`](#module_electron-updater/out/MacUpdater.MacUpdater+quitAndInstall) - * [`.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)`](#module_electron-updater/out/MacUpdater.MacUpdater+doDownloadUpdate) ⇒ module:bluebird-lst.Bluebird<void> ### MacUpdater ⇐ [AppUpdater](Auto-Update#AppUpdater) **Kind**: class of [electron-updater/out/MacUpdater](#module_electron-updater/out/MacUpdater) **Extends**: [AppUpdater](Auto-Update#AppUpdater) - -* [.MacUpdater](#MacUpdater) ⇐ [AppUpdater](Auto-Update#AppUpdater) - * [`.quitAndInstall()`](#module_electron-updater/out/MacUpdater.MacUpdater+quitAndInstall) - * [`.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)`](#module_electron-updater/out/MacUpdater.MacUpdater+doDownloadUpdate) ⇒ module:bluebird-lst.Bluebird<void> - #### `macUpdater.quitAndInstall()` **Kind**: instance method of [MacUpdater](#MacUpdater) - - -#### `macUpdater.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)` ⇒ module:bluebird-lst.Bluebird<void> -**Kind**: instance method of [MacUpdater](#MacUpdater) -**Access**: protected - -| Param | Type | -| --- | --- | -| versionInfo | [VersionInfo](Publishing-Artifacts#VersionInfo) | -| fileInfo | [FileInfo](Auto-Update#FileInfo) | -| cancellationToken | [CancellationToken](electron-builder-http#CancellationToken) | - ## electron-updater/out/NsisUpdater @@ -237,7 +213,7 @@ Developer API only. See [[Auto Update]] for user documentation. | Param | Type | | --- | --- | -| isSilent | boolean | +| isSilent | Boolean | @@ -258,8 +234,8 @@ Developer API only. See [[Auto Update]] for user documentation. | Name | Type | | --- | --- | -| **name**| string | -| **url**| string | +| **name**| String | +| **url**| String | diff --git a/jsdoc/helpers.js b/jsdoc/helpers.js index 1c50f18e33b..91a658fb189 100644 --- a/jsdoc/helpers.js +++ b/jsdoc/helpers.js @@ -1,6 +1,7 @@ "use strict" const dmdHelpers = require("dmd/helpers/ddata") +const dmdHelper = require("dmd/helpers/helpers") const catharsis = require("catharsis") exports.propertyAnchor = function (propertyName, parentName) { @@ -11,8 +12,104 @@ exports.exampleAnchor = function (caption, parentName) { return `` } -exports.listTypes = function (types, delimiter, root) { - return types == null ? "" : types.map(it => "" + link2(catharsis.parse(it, {jsdoc: true}), delimiter, root) + "").join(delimiter) +function renderTypeNames(types, delimiter, root, isTypeAsCode, isSkipNull) { + if (types == null) { + return "" + } + + const tagOpen = isTypeAsCode ? "" : "" + const tagClose = isTypeAsCode ? "" : "" + + if (isSkipNull) { + types = types.filter(it => !isSkipNull || it !== "null") + } + return types + .map(it => tagOpen + link2(catharsis.parse(it, {jsdoc: true}), delimiter, root, isSkipNull) + tagClose) + .join(delimiter) +} + +exports.listTypes = renderTypeNames +exports.renderProperties = function (properties, root) { + return renderProperties(properties, root, 0) +} + +function renderMemberListDescription(text, indent) { + return dmdHelper.inlineLinks(text) + .replace(/
/g, "\n") + .replace(/\n/g, "\n" + indent) +} + +function getInlinedChild(types) { + if (types == null) { + return null + } + + const arrayTypePrefix = "Array.<" + types = types.filter(it => it !== "null" && !isPrimitiveType(it) && !(it.startsWith(arrayTypePrefix) && types.includes(it.substring(arrayTypePrefix.length, it.indexOf(">"))))) + return types.length === 1 ? resolveById(types[0]) : null +} + +function isPrimitiveType(name) { + return name === "string" || name === "boolean" +} + +function renderProperties(object, root, level) { + let result = "" + const first = object.properties[0] + for (const member of object.properties) { + if (member !== first) { + result += "\n" + } + + let indent = "" + for (let d = 0; d < level; d++) { + indent += " " + } + result += indent + "*" + + result += " " + renderMemberName(member, object) + + const types = member.type.names + let child = getInlinedChild(types) + if (child != null && !child.inlined) { + child = null + } + + if (child == null || types.some(it => it.startsWith("Array.<") || isPrimitiveType(it))) { + result += " " + renderTypeNames(types, " \| ", root, false, true) + } + + if (child != null) { + result += `` + } + + let description = member.description + if (child != null && !description) { + description = child.description + } + + if (description) { + result += " - " + renderMemberListDescription(description, indent + " ") + } + + if (child != null) { + child.inlined = true + result += "\n" + result += renderProperties(child, root, level + 1) + } + } + return result +} + +function renderMemberName(member, object) { + let result = `` + + const wrap = member.optional ? "" : "**" + result += wrap + "`" + member.name + "`" + wrap + if (member.defaultvalue != null) { + result += " = `" + member.defaultvalue + "`" + } + return result } function link(longname, options) { @@ -83,7 +180,7 @@ function _link(input, options) { } -function link2(type, delimiter, root) { +function link2(type, delimiter, root, isSkipNull) { switch (type.type) { case "NameExpression": return identifierToLink(type.name, root) @@ -98,6 +195,7 @@ function link2(type, delimiter, root) { case "TypeUnion": return type.elements .map(it => link2(it, delimiter, root)) + .filter(it => !isSkipNull || it !== "null") .join(delimiter) case "TypeApplication": @@ -109,6 +207,16 @@ function link2(type, delimiter, root) { } function identifierToLink(id, root) { + if (id === "string") { + return "String" + } + if (id === "boolean") { + return "Boolean" + } + if (id === "number") { + return "Number" + } + let linked = resolveById(id) if (!linked) { if (id.startsWith("module") && diff --git a/jsdoc/properties-list.hbs b/jsdoc/properties-list.hbs index 123f5f4721d..a85df8fb8d8 100644 --- a/jsdoc/properties-list.hbs +++ b/jsdoc/properties-list.hbs @@ -1,7 +1,2 @@ {{#if properties}}**Properties** - -{{#each properties~}} -{{#if (regexp-test name "\w+\.\w+")}} {{/if}}- `{{{name}}}`{{#if defaultvalue}} = {{>defaultvalue}}{{/if~}} {{>linked-type-list types=type.names delimiter=" \| " ~}}{{#if description}} - {{{inlineLinks description}}}{{/if}} -{{/each}} - -{{/if~}} \ No newline at end of file +{{{renderProperties . @root}}}{{/if~}} \ No newline at end of file diff --git a/package.json b/package.json index 84b403a214f..0a7cc122f81 100644 --- a/package.json +++ b/package.json @@ -31,7 +31,7 @@ "ajv": "^5.1.5", "ajv-keywords": "^2.1.0", "archiver": "^1.3.0", - "aws-sdk": "^2.64.0", + "aws-sdk": "^2.65.0", "bluebird-lst": "^1.0.2", "chalk": "^1.1.3", "chromium-pickle-js": "^0.2.0", @@ -57,11 +57,11 @@ "sanitize-filename": "^1.6.1", "semver": "^5.3.0", "stat-mode": "^0.2.2", - "ts-jsdoc": "^1.2.3", + "ts-jsdoc": "^1.3.0", "tunnel-agent": "^0.6.0", "update-notifier": "^2.2.0", "uuid-1345": "^0.99.6", - "xelement": "^1.0.14", + "xelement": "^1.0.16", "yargs": "^8.0.1" }, "devDependencies": { diff --git a/packages/electron-builder-core/src/core.ts b/packages/electron-builder-core/src/core.ts index c13c832abca..41eb4c34e61 100644 --- a/packages/electron-builder-core/src/core.ts +++ b/packages/electron-builder-core/src/core.ts @@ -1,4 +1,3 @@ -import { AsarIntegrityOptions } from "asar-integrity" import { Publish } from "electron-builder-http/out/publishOptions" export enum Arch { @@ -123,50 +122,17 @@ export interface TargetSpecificOptions { readonly publish?: Publish } -export interface PlatformSpecificBuildOptions extends TargetSpecificOptions { - readonly files?: Array | string | null - readonly extraFiles?: Array | FilePattern | string | null - readonly extraResources?: Array | FilePattern | string | null - - readonly asarUnpack?: Array | string | null - - readonly asar?: AsarOptions | boolean | null - - readonly target?: Array | string | TargetConfig | null - - readonly icon?: string | null - - readonly fileAssociations?: Array | FileAssociation - - readonly forceCodeSigning?: boolean -} - export const DEFAULT_TARGET = "default" 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 extends AsarIntegrityOptions { - smartUnpack?: boolean - - ordering?: string | null -} - export interface BeforeBuildContext { readonly appDir: string readonly electronVersion: string @@ -174,69 +140,6 @@ export interface BeforeBuildContext { readonly arch: string } -/** - * 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. - * - * On Windows works only if [nsis.perMachine](https://github.com/electron-userland/electron-builder/wiki/Options#NsisOptions-perMachine) is set to `true`. - */ -export interface FileAssociation { - /** - * The extension (minus the leading period). e.g. `png`. - */ - readonly ext: string | Array - - /** - * The name. e.g. `PNG`. Defaults to `ext`. - */ - readonly name?: string | null - - /** - * *windows-only.* The description. - */ - readonly description?: string | null - - /** - * 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. - */ - readonly icon?: string | null - - /** - * *macOS-only* The app’s role with respect to the type. The value can be `Editor`, `Viewer`, `Shell`, or `None`. Corresponds to `CFBundleTypeRole`. - * @default Editor - */ - readonly role?: string - - /** - * *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`. - */ - readonly isPackage?: boolean -} - -/** - * 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). - */ -export interface Protocol { - /** - * The name. e.g. `IRC server URL`. - */ - readonly name: string - - /** - * *macOS-only* The app’s role with respect to the type. - * @default Editor - */ - readonly role?: "Editor" | "Viewer" | "Shell" | "None" - - /** - * The schemes. e.g. `["irc", "ircs"]`. - */ - readonly schemes: Array -} - export interface SourceRepositoryInfo { type: string domain: string diff --git a/packages/electron-builder-core/tsconfig.json b/packages/electron-builder-core/tsconfig.json index d4821d60b3a..2660ecda0c2 100644 --- a/packages/electron-builder-core/tsconfig.json +++ b/packages/electron-builder-core/tsconfig.json @@ -3,7 +3,10 @@ "compilerOptions": { "outDir": "out" }, - "jsdoc": "../../jsdoc/out/core", + "jsdoc": { + "out": "../../jsdoc/out/core", + "access": "public" + }, "declaration": true, "include": [ "src/**/*.ts" diff --git a/packages/electron-builder-http/tsconfig.json b/packages/electron-builder-http/tsconfig.json index 0adc8580b0d..439ab46b444 100644 --- a/packages/electron-builder-http/tsconfig.json +++ b/packages/electron-builder-http/tsconfig.json @@ -6,7 +6,8 @@ "declaration": true, "jsdoc": { "out": "../../jsdoc/out/http", - "examples": "../../jsdoc/examples" + "examples": "../../jsdoc/examples", + "access": "public" }, "include": [ "src/**/*.ts" diff --git a/packages/electron-builder-util/tsconfig.json b/packages/electron-builder-util/tsconfig.json index 67c710c6bdf..1480d0c0517 100644 --- a/packages/electron-builder-util/tsconfig.json +++ b/packages/electron-builder-util/tsconfig.json @@ -4,7 +4,10 @@ "outDir": "out" }, "declaration": true, - "jsdoc": "../../jsdoc/out/util", + "jsdoc": { + "out": "../../jsdoc/out/util", + "access": "public" + }, "include": [ "src/**/*.ts" ], diff --git a/packages/electron-builder/src/asarUtil.ts b/packages/electron-builder/src/asarUtil.ts index e356922004a..12fe3886946 100644 --- a/packages/electron-builder/src/asarUtil.ts +++ b/packages/electron-builder/src/asarUtil.ts @@ -1,5 +1,4 @@ import BluebirdPromise from "bluebird-lst" -import { AsarOptions } from "electron-builder-core" import { debug } from "electron-builder-util" import { CONCURRENCY, FileCopier, FileTransformer, Filter, MAX_FILE_REQUESTS, statOrNull, walk } from "electron-builder-util/out/fs" import { log } from "electron-builder-util/out/log" @@ -7,6 +6,7 @@ import { createReadStream, createWriteStream, emptyDir, ensureDir, readFile, rea import * as path from "path" import { AsarFilesystem, Node, readAsar } from "./asar" import { createElectronCompilerHost } from "./fileTransformer" +import { AsarOptions } from "./metadata" const isBinaryFile: any = BluebirdPromise.promisify(require("isbinaryfile")) const pickle = require ("chromium-pickle-js") diff --git a/packages/electron-builder/src/builder.ts b/packages/electron-builder/src/builder.ts index 0d769326e23..7dcbb70cf69 100644 --- a/packages/electron-builder/src/builder.ts +++ b/packages/electron-builder/src/builder.ts @@ -30,6 +30,7 @@ export interface CliOptions extends PackagerOptions, PublishOptions { project?: string } +/** @private */ export function normalizeOptions(args: CliOptions): BuildOptions { if (args.targets != null) { return args diff --git a/packages/electron-builder/src/fileMatcher.ts b/packages/electron-builder/src/fileMatcher.ts index f8881fd30e4..ce49c4a788d 100644 --- a/packages/electron-builder/src/fileMatcher.ts +++ b/packages/electron-builder/src/fileMatcher.ts @@ -1,12 +1,12 @@ import BluebirdPromise from "bluebird-lst" -import { FilePattern, PlatformSpecificBuildOptions } from "electron-builder-core" +import { FilePattern } from "electron-builder-core" import { asArray, debug } from "electron-builder-util" import { copyDir, copyFile, Filter, statOrNull } from "electron-builder-util/out/fs" import { warn } from "electron-builder-util/out/log" import { mkdirs } from "fs-extra-p" import { Minimatch } from "minimatch" import * as path from "path" -import { Config } from "./metadata" +import { Config, PlatformSpecificBuildOptions } from "./metadata" import { BuildInfo } from "./packagerApi" import { createFilter, hasMagic } from "./util/filter" diff --git a/packages/electron-builder/src/index.ts b/packages/electron-builder/src/index.ts index 055b54ec387..9bb5f00769d 100644 --- a/packages/electron-builder/src/index.ts +++ b/packages/electron-builder/src/index.ts @@ -2,8 +2,8 @@ export { Packager, BuildResult } from "./packager" export { PackagerOptions, ArtifactCreated, BuildInfo } from "./packagerApi" export { getArchSuffix, Platform, Arch, archFromString, Target, DIR_TARGET } from "electron-builder-core" export { BuildOptions, build, CliOptions, createTargets } from "./builder" -export { Metadata, Config, AfterPackContext, MetadataDirectories } from "./metadata" +export { Metadata, Config, AfterPackContext, MetadataDirectories, Protocol, FileAssociation, PlatformSpecificBuildOptions, AuthorMetadata, RepositoryInfo, AsarOptions } from "./metadata" export { MacOptions, DmgOptions, MasBuildOptions, MacOsTargetName, PkgOptions, DmgContent, DmgWindow } from "./options/macOptions" -export { WinBuildOptions, NsisOptions, SquirrelWindowsOptions, AppXOptions, NsisWebOptions, PortableOptions } from "./options/winOptions" -export { LinuxBuildOptions, DebOptions, SnapOptions } from "./options/linuxOptions" -export { buildForge } from "./forge/forge-maker" \ No newline at end of file +export { WinBuildOptions, NsisOptions, SquirrelWindowsOptions, AppXOptions, NsisWebOptions, PortableOptions, CommonNsisOptions } from "./options/winOptions" +export { LinuxBuildOptions, DebOptions, SnapOptions, CommonLinuxOptions, LinuxTargetSpecificOptions } from "./options/linuxOptions" +export { buildForge, ForgeOptions } from "./forge/forge-maker" \ No newline at end of file diff --git a/packages/electron-builder/src/metadata.ts b/packages/electron-builder/src/metadata.ts index 14cb110eff0..7d06514873e 100644 --- a/packages/electron-builder/src/metadata.ts +++ b/packages/electron-builder/src/metadata.ts @@ -1,4 +1,5 @@ -import { Arch, AsarOptions, AuthorMetadata, BeforeBuildContext, CompressionLevel, FileAssociation, FilePattern, PlatformSpecificBuildOptions, Protocol, RepositoryInfo, Target } from "electron-builder-core" +import { AsarIntegrityOptions } from "asar-integrity" +import { Arch, BeforeBuildContext, CompressionLevel, FilePattern, Target, TargetConfig, TargetSpecificOptions } from "electron-builder-core" import { Publish } from "electron-builder-http/out/publishOptions" import { DebOptions, LinuxBuildOptions, LinuxTargetSpecificOptions, SnapOptions } from "./options/linuxOptions" import { DmgOptions, MacOptions, MasBuildOptions, PkgOptions } from "./options/macOptions" @@ -6,33 +7,20 @@ import { AppXOptions, NsisOptions, NsisWebOptions, PortableOptions, SquirrelWind import { PlatformPackager } from "./platformPackager" /** - * Fields in the package.json * Some standard fields should be defined in the `package.json`. */ export interface Metadata { - readonly repository?: string | RepositoryInfo | null - - readonly dependencies?: { [key: string]: string } - - readonly version?: string - /** * The application name. * @required */ readonly name?: string - readonly productName?: string | null - /** * The application description. */ readonly description?: string - readonly main?: string | null - - readonly author?: AuthorMetadata - /** * The url to the project [homepage](https://docs.npmjs.com/files/package.json#homepage) (NuGet Package `projectUrl` (optional) or Linux Package URL (required)). * @@ -41,11 +29,36 @@ export interface Metadata { readonly homepage?: string | null /** - *linux-only.* The [license](https://docs.npmjs.com/files/package.json#license) name. + * *linux-only.* The [license](https://docs.npmjs.com/files/package.json#license) name. */ readonly license?: string | null + readonly author?: AuthorMetadata + + /** + * The [repository](https://docs.npmjs.com/files/package.json#repository). + */ + readonly repository?: string | RepositoryInfo | null + readonly build?: Config + + /** @private */ + readonly dependencies?: { [key: string]: string } + /** @private */ + readonly version?: string + /** @private */ + readonly productName?: string | null + /** @private */ + readonly main?: string | null +} + +export interface AuthorMetadata { + readonly name: string + readonly email?: string +} + +export interface RepositoryInfo { + readonly url: string } /** @@ -54,30 +67,29 @@ export interface Metadata { export interface Config extends PlatformSpecificBuildOptions { /** * 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. + * [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). It is strongly recommended that an explicit ID be set. + * @default com.electron.${name} */ readonly appId?: string | null /** - * The human-readable copyright line for the app. Defaults to `Copyright © year author`. + * The human-readable copyright line for the app. + * @default Copyright © year ${author} */ readonly copyright?: 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}). + * As [name](#Metadata-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}). */ readonly productName?: 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](#file-patterns). + * A [glob patterns](#file-patterns) relative to the [app directory](#MetadataDirectories-app), which specifies which files to include when copying files to create the package. */ readonly files?: Array | 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). + * A [glob patterns](#file-patterns) 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). */ @@ -94,10 +106,10 @@ export interface Config extends PlatformSpecificBuildOptions { * 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. * @default true */ - readonly asar?: AsarOptions | boolean | null + readonly asar?: boolean | AsarOptions | 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. + * A [glob patterns](#file-patterns) 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. */ readonly asarUnpack?: Array | string | null @@ -205,12 +217,33 @@ export interface Config extends PlatformSpecificBuildOptions { * @default true */ readonly detectUpdateChannel?: boolean - + + /** + * macOS options. + */ readonly mac?: MacOptions | null + + /** + * MAS (Mac Application Store) options. + */ readonly mas?: MasBuildOptions | null + + /** + * macOS DMG options. + * + * To add license to DMG, create file `license_LANG_CODE.txt` in the build resources. Multiple license files in different languages are supported — use lang postfix (e.g. `_de`, `_ru`)). For example, create files `license_de.txt` and `license_en.txt` in the build resources. + * If OS language is german, `license_de.txt` will be displayed. See map of [language code to name](https://github.com/meikidd/iso-639-1/blob/master/src/data.js). + */ readonly dmg?: DmgOptions | null + + /** + * macOS product archive options. + */ readonly pkg?: PkgOptions | null + /** + * Windows options. + */ readonly win?: WinBuildOptions | null readonly nsis?: NsisOptions | null readonly nsisWeb?: NsisWebOptions | null @@ -218,8 +251,17 @@ export interface Config extends PlatformSpecificBuildOptions { readonly appx?: AppXOptions | null readonly squirrelWindows?: SquirrelWindowsOptions | null + /** + * Linux options. + */ readonly linux?: LinuxBuildOptions | null + /** + * Debian package specific options. + */ readonly deb?: DebOptions | null + /** + * [Snap](http://snapcraft.io) options. + */ readonly snap?: SnapOptions | null readonly appimage?: LinuxTargetSpecificOptions | null readonly pacman?: LinuxTargetSpecificOptions | null @@ -242,11 +284,6 @@ export interface AfterPackContext { readonly targets: Array } -/** - * `directories` - * - * @typicalname directories - */ export interface MetadataDirectories { /** * The path to build resources. @@ -264,4 +301,95 @@ export interface MetadataDirectories { * The application directory (containing the application package.json), defaults to `app`, `www` or working directory. */ readonly app?: string | null +} + +/** + * 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). + */ +export interface Protocol { + /** + * The name. e.g. `IRC server URL`. + */ + readonly name: string + + /** + * The schemes. e.g. `["irc", "ircs"]`. + */ + readonly schemes: Array + + /** + * *macOS-only* The app’s role with respect to the type. + * @default Editor + */ + readonly role?: "Editor" | "Viewer" | "Shell" | "None" +} + +/** + * 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. + * + * On Windows works only if [nsis.perMachine](https://github.com/electron-userland/electron-builder/wiki/Options#NsisOptions-perMachine) is set to `true`. + */ +export interface FileAssociation { + /** + * The extension (minus the leading period). e.g. `png`. + */ + readonly ext: string | Array + + /** + * The name. e.g. `PNG`. Defaults to `ext`. + */ + readonly name?: string | null + + /** + * *windows-only.* The description. + */ + readonly description?: string | null + + /** + * 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. + */ + readonly icon?: string | null + + /** + * *macOS-only* The app’s role with respect to the type. The value can be `Editor`, `Viewer`, `Shell`, or `None`. Corresponds to `CFBundleTypeRole`. + * @default Editor + */ + readonly role?: string + + /** + * *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`. + */ + readonly isPackage?: boolean +} + +export interface PlatformSpecificBuildOptions extends TargetSpecificOptions { + readonly files?: Array | string | null + readonly extraFiles?: Array | FilePattern | string | null + readonly extraResources?: Array | FilePattern | string | null + + readonly asarUnpack?: Array | string | null + + readonly asar?: AsarOptions | boolean | null + + readonly target?: Array | string | TargetConfig | null + + readonly icon?: string | null + + readonly fileAssociations?: Array | FileAssociation + + readonly forceCodeSigning?: boolean +} + +export interface AsarOptions extends AsarIntegrityOptions { + /** + * Whether to automatically unpack executables files. + * @default true + */ + smartUnpack?: boolean + + ordering?: string | null } \ No newline at end of file diff --git a/packages/electron-builder/src/options/linuxOptions.ts b/packages/electron-builder/src/options/linuxOptions.ts index 9cb429092f1..50dd2258325 100644 --- a/packages/electron-builder/src/options/linuxOptions.ts +++ b/packages/electron-builder/src/options/linuxOptions.ts @@ -1,9 +1,7 @@ -import { PlatformSpecificBuildOptions, TargetConfigType, TargetSpecificOptions } from "electron-builder-core" +import { TargetConfigType, TargetSpecificOptions } from "electron-builder-core" +import { PlatformSpecificBuildOptions } from "../metadata" -/** - * Linux Options - */ -export interface LinuxBuildOptions extends PlatformSpecificBuildOptions, CommonLinuxOptions { +export interface LinuxBuildOptions extends CommonLinuxOptions, PlatformSpecificBuildOptions { /** * The [application category](https://specifications.freedesktop.org/menu-spec/latest/apa.html#main-category-registry). */ @@ -15,7 +13,7 @@ export interface LinuxBuildOptions extends PlatformSpecificBuildOptions, CommonL readonly packageCategory?: string | null /** - * As [description](#AppMetadata-description) from application package.json, but allows you to specify different for Linux. + * As [description](#Metadata-description) from application package.json, but allows you to specify different for Linux. */ readonly description?: string | null @@ -30,12 +28,12 @@ export interface LinuxBuildOptions extends PlatformSpecificBuildOptions, CommonL readonly target?: TargetConfigType /** - * The maintainer. Defaults to [author](#AppMetadata-author). + * The maintainer. Defaults to [author](#Metadata-author). */ readonly maintainer?: string | null /** - * The vendor. Defaults to [author](#AppMetadata-author). + * The vendor. Defaults to [author](#Metadata-author). */ readonly vendor?: string | null @@ -99,9 +97,6 @@ export interface LinuxTargetSpecificOptions extends TargetSpecificOptions, Commo readonly icon?: string } -/** - * Debian Package Specific Options - */ export interface DebOptions extends LinuxTargetSpecificOptions { /** * The compression type. @@ -120,9 +115,6 @@ export interface DebOptions extends LinuxTargetSpecificOptions { readonly depends?: string[] | null } -/** - * [Snap](http://snapcraft.io) Options - */ export interface SnapOptions extends LinuxBuildOptions { /** * The type of [confinement](https://snapcraft.io/docs/reference/confinement) supported by the snap. @@ -131,7 +123,7 @@ export interface SnapOptions extends LinuxBuildOptions { readonly confinement?: "devmode" | "strict" | "classic" | null /** - * The 78 character long summary. Defaults to [productName](#AppMetadata-productName). + * The 78 character long summary. Defaults to [productName](#Config-productName). */ readonly summary?: string | null diff --git a/packages/electron-builder/src/options/macOptions.ts b/packages/electron-builder/src/options/macOptions.ts index ffd8ff99d9f..7cd595f97da 100644 --- a/packages/electron-builder/src/options/macOptions.ts +++ b/packages/electron-builder/src/options/macOptions.ts @@ -1,10 +1,8 @@ -import { PlatformSpecificBuildOptions, TargetConfig, TargetSpecificOptions } from "electron-builder-core" +import { TargetConfig, TargetSpecificOptions } from "electron-builder-core" +import { PlatformSpecificBuildOptions } from "../metadata" export type MacOsTargetName = "default" | "dmg" | "mas" | "mas-dev" | "pkg" | "7z" | "zip" | "tar.xz" | "tar.lz" | "tar.gz" | "tar.bz2" | "dir" -/** - * macOS Options ([mac](#Config-mac)). - */ export interface MacOptions extends PlatformSpecificBuildOptions { /** * The application category type, as shown in the Finder via *View -> Arrange by Application Category* when viewing the Applications directory. @@ -79,9 +77,6 @@ export interface MacOptions extends PlatformSpecificBuildOptions { readonly requirements?: string | null } -/** - * macOS Product Archive Options ([pkg](#Config-pkg)). - */ export interface PkgOptions extends TargetSpecificOptions { /** * The scripts directory, relative to `build` (build resources directory). @@ -107,14 +102,6 @@ export interface PkgOptions extends TargetSpecificOptions { readonly identity?: string | null } -/** - * macOS DMG Options ([dmg](#Config-dmg)). - * - * To add license to DMG, create file `license_LANG_CODE.txt` in the build resources. Multiple license files in different languages are supported — use lang postfix (e.g. `_de`, `_ru`)). For example, create files `license_de.txt` and `license_en.txt` in the build resources. - * If OS language is german, `license_de.txt` will be displayed. See map of [language code to name](https://github.com/meikidd/iso-639-1/blob/master/src/data.js). - * - * @typicalname dmg - */ export interface DmgOptions extends TargetSpecificOptions { /** * 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. @@ -166,14 +153,11 @@ export interface DmgOptions extends TargetSpecificOptions { readonly format?: "UDRW" | "UDRO" | "UDCO" | "UDZO" | "UDBZ" | "ULFO" /** - * The DMG windows position and size. See [dmg.window](#DmgWindow). + * The DMG windows position and size. */ window?: DmgWindow } -/** - * DMG Windows Position and Size - */ export interface DmgWindow { /** * The X position relative to left of the screen. @@ -211,9 +195,6 @@ export interface DmgContent { path?: string } -/** - * MAS (Mac Application Store) Options ([mas](#Config-mas)). - */ export interface MasBuildOptions extends MacOptions { /** * 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). diff --git a/packages/electron-builder/src/options/winOptions.ts b/packages/electron-builder/src/options/winOptions.ts index 839df748684..fae42e16f82 100644 --- a/packages/electron-builder/src/options/winOptions.ts +++ b/packages/electron-builder/src/options/winOptions.ts @@ -1,21 +1,20 @@ -import { PlatformSpecificBuildOptions, TargetConfigType, TargetSpecificOptions } from "electron-builder-core" +import { TargetConfigType, TargetSpecificOptions } from "electron-builder-core" +import { PlatformSpecificBuildOptions } from "../metadata" -/** - * Windows Specific Options ([win](#Config-win)). - */ export interface WinBuildOptions extends PlatformSpecificBuildOptions { /** - * 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`. + * 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`. * AppX package can be built only on Windows 10. * * To use Squirrel.Windows please install `electron-builder-squirrel-windows` dependency. + * + * @default nsis */ readonly target?: TargetConfigType /** - * Array of signing algorithms used. Defaults to `['sha1', 'sha256']` - * - * For AppX `sha256` is always used. + * Array of signing algorithms used. For AppX `sha256` is always used. + * @default ['sha1', 'sha256'] */ readonly signingHashAlgorithms?: Array<"sha1" | "sha256"> | null @@ -58,12 +57,14 @@ export interface WinBuildOptions extends PlatformSpecificBuildOptions { readonly additionalCertificateFile?: string /** - * The URL of the RFC 3161 time stamp server. Defaults to `http://timestamp.comodoca.com/rfc3161`. + * The URL of the RFC 3161 time stamp server. + * @default http://timestamp.comodoca.com/rfc3161 */ readonly rfc3161TimeStampServer?: string /** - * The URL of the time stamp server. Defaults to `http://timestamp.verisign.com/scripts/timstamp.dll`. + * The URL of the time stamp server. + * @default http://timestamp.verisign.com/scripts/timstamp.dll */ readonly timeStampServer?: string @@ -89,9 +90,7 @@ export interface CommonNsisOptions { } /** - * NSIS specific options ([nsis](#Config-nsis)). - * - * See [NSIS target notes](https://github.com/electron-userland/electron-builder/wiki/NSIS). + * NSIS options. See [NSIS target notes](https://github.com/electron-userland/electron-builder/wiki/NSIS). */ export interface NsisOptions extends CommonNsisOptions, TargetSpecificOptions { /** @@ -235,7 +234,7 @@ export interface NsisOptions extends CommonNsisOptions, TargetSpecificOptions { } /** - * Portable Specific Options ([portable](#Config-portable)). + * Portable specific options. */ export interface PortableOptions extends TargetSpecificOptions, CommonNsisOptions { /** @@ -246,7 +245,7 @@ export interface PortableOptions extends TargetSpecificOptions, CommonNsisOption } /** - * Web Installer Specific Options ([nsisWeb](#Config-nsisWeb)). + * Web Installer specific options. */ export interface NsisWebOptions extends NsisOptions { /** @@ -265,7 +264,7 @@ export interface NsisWebOptions extends NsisOptions { } /** - * Squirrel.Windows Options ([squirrelWindows](#Config-squirrelWindows)). + * Squirrel.Windows options. * * To use Squirrel.Windows please install `electron-builder-squirrel-windows` dependency. Squirrel.Windows target is maintained, but deprecated. Please use `nsis` instead. */ @@ -308,8 +307,7 @@ export interface SquirrelWindowsOptions extends WinBuildOptions { } /** - * AppX Options ([appx](#Config-appx)). - * @see [Windows AppX docs](https://msdn.microsoft.com/en-us/library/windows/apps/br211453.aspx). + * AppX options. See [Windows AppX docs](https://msdn.microsoft.com/en-us/library/windows/apps/br211453.aspx). */ export interface AppXOptions { /** diff --git a/packages/electron-builder/src/packagerApi.ts b/packages/electron-builder/src/packagerApi.ts index f23fe093428..67869b2906c 100644 --- a/packages/electron-builder/src/packagerApi.ts +++ b/packages/electron-builder/src/packagerApi.ts @@ -27,7 +27,7 @@ export interface PackagerOptions { readonly config?: Config | string | null /** - * The same as [application package.json](https://github.com/electron-userland/electron-builder/wiki/Options#AppMetadata). + * The same as [application package.json](https://github.com/electron-userland/electron-builder/wiki/Options#Metadata). * * Application `package.json` will be still read, but options specified in this object will override. */ diff --git a/packages/electron-builder/src/platformPackager.ts b/packages/electron-builder/src/platformPackager.ts index 408bf2dc5f9..96d47712479 100644 --- a/packages/electron-builder/src/platformPackager.ts +++ b/packages/electron-builder/src/platformPackager.ts @@ -1,6 +1,6 @@ import { computeData } from "asar-integrity" import BluebirdPromise from "bluebird-lst" -import { Arch, AsarOptions, FileAssociation, getArchSuffix, Platform, PlatformSpecificBuildOptions, Target, TargetSpecificOptions } from "electron-builder-core" +import { Arch, 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" @@ -12,7 +12,7 @@ import { AppInfo } from "./appInfo" import { AsarPackager, checkFileInArchive } from "./asarUtil" import { copyFiles, createFileMatcher, FileMatcher, getFileMatchers } from "./fileMatcher" import { createTransformer, isElectronCompileUsed } from "./fileTransformer" -import { Config } from "./metadata" +import { AsarOptions, Config, FileAssociation, PlatformSpecificBuildOptions } from "./metadata" import { unpackElectron, unpackMuon } from "./packager/dirPackager" import { BuildInfo, PackagerOptions } from "./packagerApi" import { readInstalled } from "./readInstalled" diff --git a/packages/electron-builder/src/publish/PublishManager.ts b/packages/electron-builder/src/publish/PublishManager.ts index 7014f0b7b96..a9cbfe20582 100644 --- a/packages/electron-builder/src/publish/PublishManager.ts +++ b/packages/electron-builder/src/publish/PublishManager.ts @@ -1,6 +1,6 @@ import { hashFile } from "asar-integrity" import BluebirdPromise from "bluebird-lst" -import { Arch, Platform, PlatformSpecificBuildOptions, Target } from "electron-builder-core" +import { Arch, Platform, Target } from "electron-builder-core" import { CancellationToken } from "electron-builder-http/out/CancellationToken" import { BintrayOptions, GenericServerOptions, GithubOptions, githubUrl, PublishConfiguration, PublishProvider, S3Options, s3Url, UpdateInfo, VersionInfo } from "electron-builder-http/out/publishOptions" import { asArray, debug, isEmptyOrSpaces, isPullRequest, Lazy, safeStringifyJson } from "electron-builder-util" @@ -17,6 +17,7 @@ import * as path from "path" import { prerelease } from "semver" import { WriteStream as TtyWriteStream } from "tty" import * as url from "url" +import { PlatformSpecificBuildOptions } from "../metadata" import { Packager } from "../packager" import { ArtifactCreated, BuildInfo } from "../packagerApi" import { PlatformPackager } from "../platformPackager" diff --git a/packages/electron-builder/src/repositoryInfo.ts b/packages/electron-builder/src/repositoryInfo.ts index 04951925f83..486e3212153 100644 --- a/packages/electron-builder/src/repositoryInfo.ts +++ b/packages/electron-builder/src/repositoryInfo.ts @@ -1,8 +1,7 @@ -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 } from "./metadata" +import { Metadata, RepositoryInfo } from "./metadata" export interface RepositorySlug { user: string diff --git a/packages/electron-builder/src/targets/fpm.ts b/packages/electron-builder/src/targets/fpm.ts index ab6775a6884..b80813b2d9c 100644 --- a/packages/electron-builder/src/targets/fpm.ts +++ b/packages/electron-builder/src/targets/fpm.ts @@ -90,7 +90,7 @@ export default class FpmTarget extends Target { const projectUrl = await appInfo.computePackageUrl() if (projectUrl == null) { - throw new Error("Please specify project homepage, see https://github.com/electron-userland/electron-builder/wiki/Options#AppMetadata-homepage") + throw new Error("Please specify project homepage, see https://github.com/electron-userland/electron-builder/wiki/Options#Metadata-homepage") } const options = this.options diff --git a/packages/electron-builder/src/targets/targetFactory.ts b/packages/electron-builder/src/targets/targetFactory.ts index dde23b85927..c3b99511809 100644 --- a/packages/electron-builder/src/targets/targetFactory.ts +++ b/packages/electron-builder/src/targets/targetFactory.ts @@ -1,5 +1,6 @@ -import { Arch, archFromString, DEFAULT_TARGET, DIR_TARGET, Platform, PlatformSpecificBuildOptions, Target, TargetConfig } from "electron-builder-core" +import { Arch, archFromString, DEFAULT_TARGET, DIR_TARGET, Platform, Target, TargetConfig } from "electron-builder-core" import { addValue, asArray } from "electron-builder-util" +import { PlatformSpecificBuildOptions } from "../metadata" import { PlatformPackager } from "../platformPackager" import { ArchiveTarget } from "./ArchiveTarget" diff --git a/packages/electron-builder/tsconfig.json b/packages/electron-builder/tsconfig.json index 0126278e2c0..4a6e10c199e 100644 --- a/packages/electron-builder/tsconfig.json +++ b/packages/electron-builder/tsconfig.json @@ -6,7 +6,8 @@ "declaration": true, "jsdoc": { "out": "../../jsdoc/out/builder", - "examples": "../../jsdoc/examples" + "examples": "../../jsdoc/examples", + "access": "public" }, "include": [ "src/**/*.ts", diff --git a/packages/electron-publish/tsconfig.json b/packages/electron-publish/tsconfig.json index e21ce0441e7..c010af2f5b9 100644 --- a/packages/electron-publish/tsconfig.json +++ b/packages/electron-publish/tsconfig.json @@ -4,7 +4,10 @@ "outDir": "out" }, "declaration": true, - "jsdoc": "../../jsdoc/out/publisher", + "jsdoc": { + "out": "../../jsdoc/out/publisher", + "access": "public" + }, "include": [ "src/**/*.ts" ], diff --git a/packages/electron-publisher-s3/package.json b/packages/electron-publisher-s3/package.json index 7998a02ac73..34e6c6c1839 100644 --- a/packages/electron-publisher-s3/package.json +++ b/packages/electron-publisher-s3/package.json @@ -12,7 +12,7 @@ ], "dependencies": { "fs-extra-p": "^4.3.0", - "aws-sdk": "^2.64.0", + "aws-sdk": "^2.65.0", "mime": "^1.3.6", "electron-publish": "~0.0.0-semantic-release", "electron-builder-util": "~0.0.0-semantic-release" diff --git a/packages/electron-updater/package.json b/packages/electron-updater/package.json index 0f6b3145b18..1f8a0236c78 100644 --- a/packages/electron-updater/package.json +++ b/packages/electron-updater/package.json @@ -19,7 +19,7 @@ "source-map-support": "^0.4.15", "electron-builder-http": "~0.0.0-semantic-release", "electron-is-dev": "^0.1.2", - "xelement": "^1.0.14", + "xelement": "^1.0.16", "debug": "^2.6.8" }, "typings": "./out/electron-updater.d.ts" diff --git a/packages/electron-updater/src/AppUpdater.ts b/packages/electron-updater/src/AppUpdater.ts index cb6b678b908..677e8d94489 100644 --- a/packages/electron-updater/src/AppUpdater.ts +++ b/packages/electron-updater/src/AppUpdater.ts @@ -57,7 +57,6 @@ export abstract class AppUpdater extends EventEmitter { this._appUpdateConfigPath = value } - /*** @private */ protected updateAvailable = false private clientPromise: Promise> | null @@ -65,16 +64,13 @@ export abstract class AppUpdater extends EventEmitter { private readonly untilAppReady: Promise private checkForUpdatesPromise: Promise | null - /*** @private */ protected readonly app: Electron.App - /*** @private */ protected versionInfo: VersionInfo | null private fileInfo: FileInfo | null private currentVersion: string - /*** @private */ protected readonly httpExecutor: ElectronHttpExecutor constructor(options: PublishConfiguration | null | undefined, app?: any) { @@ -221,7 +217,6 @@ export abstract class AppUpdater extends EventEmitter { } } - /*** @private */ protected onUpdateAvailable(versionInfo: VersionInfo, fileInfo: FileInfo) { if (this.logger != null) { this.logger.info(`Found version ${versionInfo.version} (url: ${fileInfo.url})`) @@ -256,12 +251,10 @@ export abstract class AppUpdater extends EventEmitter { } } - /*** @private */ protected dispatchError(e: Error) { this.emit("error", e, (e.stack || e).toString()) } - /*** @private */ protected async abstract doDownloadUpdate(versionInfo: VersionInfo, fileInfo: FileInfo, cancellationToken: CancellationToken): Promise /** @@ -271,7 +264,7 @@ export abstract class AppUpdater extends EventEmitter { * **Note:** `autoUpdater.quitAndInstall()` will close all application windows first and only emit `before-quit` event on `app` after that. * This is different from the normal quit event sequence. * - * @param [isSilent] *windows-only* Runs the installer in silent mode. + * @param isSilent *windows-only* Runs the installer in silent mode. */ abstract quitAndInstall(isSilent?: boolean): void diff --git a/packages/electron-updater/tsconfig.json b/packages/electron-updater/tsconfig.json index 656d605e298..cf92a483d14 100644 --- a/packages/electron-updater/tsconfig.json +++ b/packages/electron-updater/tsconfig.json @@ -6,7 +6,8 @@ "declaration": true, "jsdoc": { "out": "../../jsdoc/out/updater", - "examples": "../../jsdoc/examples" + "examples": "../../jsdoc/examples", + "access": "public" }, "files": [ "../../typings/semver.d.ts", diff --git a/packages/jsdoc2md.js b/packages/jsdoc2md.js index ece01d728ea..4e14cf9f73f 100644 --- a/packages/jsdoc2md.js +++ b/packages/jsdoc2md.js @@ -62,6 +62,7 @@ async function main() { "!***/*-yarn.js", "!***/*-dmgLicense.js", "!***/*-repositoryInfo.js", + "!***/*-readPackageJson.js", ], {cwd: source})) .filter(it => !userFiles.includes(it)) @@ -69,7 +70,7 @@ async function main() { const partials = (await globby(["*.hbs"], {cwd: partialDir})).map(it => path.resolve(partialDir, it)) const pages = [ - {page: "Options.md", pageUrl: "Options", mainHeader: "API", files: userFiles}, + {page: "Options.md", pageUrl: "Options", mainHeader: null, files: userFiles}, {page: "api/electron-builder.md", pageUrl: "electron-builder", files: developerFiles}, {page: "Auto Update.md", pageUrl: "Auto-Update", mainHeader: "API", files: appUpdateFiles}, {page: "Publishing Artifacts.md", pageUrl: "Publishing-Artifacts", mainHeader: "API", files: publishOptionsFiles}, @@ -105,9 +106,14 @@ async function render(pages, jsdoc2MdOptions) { page.dataMap = map } + function isOptionMember(member) { + return member.name.endsWith("Options") || member.name === "Protocol" || member.name === "FileAssociation" || member.name === "AuthorMetadata" || member.name === "RepositoryInfo" + } + const filtered = [] pages[0].data = pages[0].data.filter(member => { - if (member.name.endsWith("Options") || member.kind === "module" || member.name === "Config" || member.name.startsWith("Metadata") || member.name.startsWith("Dmg")) { + const excluded = new Set(["CommonLinuxOptions", "CommonNsisOptions", "LinuxTargetSpecificOptions", "PlatformSpecificBuildOptions", "ForgeOptions"]) + if (!excluded.has(member.name) && (isOptionMember(member) || member.kind === "module" || member.name === "Config" || member.name.startsWith("Metadata") || member.name.startsWith("Dmg"))) { return true } @@ -118,13 +124,25 @@ async function render(pages, jsdoc2MdOptions) { return false }) + pages[0].data = pages[0].data.filter(member => { + const isInlined = member.name.endsWith("MetadataDirectories") || member.id.includes(".Dmg") || isOptionMember(member) + if (isInlined) { + member.inlined = true + } + return !isInlined + }) + pages[1].data = filtered.concat(pages[1].data) pages[1].data.unshift(pages[0].data[0]) for (const page of pages) { - let content = await jsdoc2md.render(Object.assign({ - data: page.data, - }, jsdoc2MdOptions)) + const finalOptions = Object.assign({data: page.data, "property-list-format": page === pages[0] ? "list" : "table"}, jsdoc2MdOptions) + + if (page === pages[0]) { + finalOptions["heading-depth"] = 1 + } + + let content = await jsdoc2md.render(finalOptions) if (page.mainHeader != null && content.startsWith("## Modules")) { content = "## API" + content.substring("## Modules".length) @@ -132,6 +150,9 @@ async function render(pages, jsdoc2MdOptions) { if (page.mainHeader != null) { content = "## API" + content.substring(content.indexOf("\n", content.indexOf("##"))) } + if (page.mainHeader === null) { + content = content.substring(content.indexOf("")) + } await writeDocFile(path.join(__dirname, "..", "docs", page.page), content) } diff --git a/yarn.lock b/yarn.lock index 68114002619..09f79cd1b4e 100644 --- a/yarn.lock +++ b/yarn.lock @@ -39,8 +39,8 @@ resolved "https://registry.yarnpkg.com/@types/node-forge/-/node-forge-0.6.9.tgz#38e0e00de8e6f3ff0bb1f4cddcad43e7b580733a" "@types/node@*": - version "7.0.28" - resolved "https://registry.yarnpkg.com/@types/node/-/node-7.0.28.tgz#3a8c62b718a73bbb89ede4aba5ab12c8f822c36e" + version "7.0.29" + resolved "https://registry.yarnpkg.com/@types/node/-/node-7.0.29.tgz#ccfcec5b7135c7caf6c4ffb8c7f33102340d99df" "@types/source-map-support@^0.4.0": version "0.4.0" @@ -265,9 +265,9 @@ asynckit@^0.4.0: version "0.4.0" resolved "https://registry.yarnpkg.com/asynckit/-/asynckit-0.4.0.tgz#c79ed97f7f34cb8f2ba1bc9790bcc366474b4b79" -aws-sdk@^2.64.0: - version "2.64.0" - resolved "https://registry.yarnpkg.com/aws-sdk/-/aws-sdk-2.64.0.tgz#365da7d8c7f3ed64c220d5f73afd78620c4923a3" +aws-sdk@^2.65.0: + version "2.65.0" + resolved "https://registry.yarnpkg.com/aws-sdk/-/aws-sdk-2.65.0.tgz#fb3ee1d565114f69a1a9bb2311b829b59c7c6e8f" dependencies: buffer "5.0.6" crypto-browserify "1.0.9" @@ -1380,8 +1380,8 @@ glob@^7.0.0, glob@^7.0.3, glob@^7.0.5, glob@^7.1.0, glob@^7.1.1, glob@~7.1.1: path-is-absolute "^1.0.0" globals@^9.0.0: - version "9.17.0" - resolved "https://registry.yarnpkg.com/globals/-/globals-9.17.0.tgz#0c0ca696d9b9bb694d2e5470bd37777caad50286" + version "9.18.0" + resolved "https://registry.yarnpkg.com/globals/-/globals-9.18.0.tgz#aa3896b3e69b487f17e31ed2143d69a8e30c2d8a" globby@^6.1.0: version "6.1.0" @@ -1961,12 +1961,6 @@ jmespath@0.15.0: version "0.15.0" resolved "https://registry.yarnpkg.com/jmespath/-/jmespath-0.15.0.tgz#a3f222a9aae9f966f5d27c796510e28091764217" -jodid25519@^1.0.0: - version "1.0.2" - resolved "https://registry.yarnpkg.com/jodid25519/-/jodid25519-1.0.2.tgz#06d4912255093419477d425633606e0e90782967" - dependencies: - jsbn "~0.1.0" - js-tokens@^3.0.0: version "3.0.1" resolved "https://registry.yarnpkg.com/js-tokens/-/js-tokens-3.0.1.tgz#08e9f132484a2c45a30907e9dc4d5567b7f114d7" @@ -2819,8 +2813,8 @@ registry-url@^3.0.3: rc "^1.0.1" remove-trailing-separator@^1.0.1: - version "1.0.1" - resolved "https://registry.yarnpkg.com/remove-trailing-separator/-/remove-trailing-separator-1.0.1.tgz#615ebb96af559552d4bf4057c8436d486ab63cc4" + version "1.0.2" + resolved "https://registry.yarnpkg.com/remove-trailing-separator/-/remove-trailing-separator-1.0.2.tgz#69b062d978727ad14dc6b56ba4ab772fd8d70511" repeat-element@^1.1.2: version "1.1.2" @@ -3043,8 +3037,8 @@ sprintf-js@~1.0.2: resolved "https://registry.yarnpkg.com/sprintf-js/-/sprintf-js-1.0.3.tgz#04e6926f662895354f3dd015203633b857297e2c" sshpk@^1.7.0: - version "1.13.0" - resolved "https://registry.yarnpkg.com/sshpk/-/sshpk-1.13.0.tgz#ff2a3e4fd04497555fed97b39a0fd82fafb3a33c" + version "1.13.1" + resolved "https://registry.yarnpkg.com/sshpk/-/sshpk-1.13.1.tgz#512df6da6287144316dc4c18fe1cf1d940739be3" dependencies: asn1 "~0.2.3" assert-plus "^1.0.0" @@ -3053,7 +3047,6 @@ sshpk@^1.7.0: optionalDependencies: bcrypt-pbkdf "^1.0.0" ecc-jsbn "~0.1.1" - jodid25519 "^1.0.0" jsbn "~0.1.0" tweetnacl "~0.14.0" @@ -3297,9 +3290,9 @@ ts-babel@^3.0.1: fs-extra-p "^4.3.0" source-map-support "^0.4.15" -ts-jsdoc@^1.2.3: - version "1.2.3" - resolved "https://registry.yarnpkg.com/ts-jsdoc/-/ts-jsdoc-1.2.3.tgz#a550daa3f59f62f94ffde9d3e70763e5588238f4" +ts-jsdoc@^1.3.0: + version "1.3.0" + resolved "https://registry.yarnpkg.com/ts-jsdoc/-/ts-jsdoc-1.3.0.tgz#c5b16ea7c2b3db1f0355a09d072804b6b55615c8" dependencies: bluebird-lst "^1.0.2" chalk "^1.1.3" @@ -3554,10 +3547,14 @@ window-size@0.1.0: version "0.1.0" resolved "https://registry.yarnpkg.com/window-size/-/window-size-0.1.0.tgz#5438cd2ea93b202efa3a19fe8887aee7c94f9c9d" -wordwrap@0.0.2, wordwrap@~0.0.2: +wordwrap@0.0.2: version "0.0.2" resolved "https://registry.yarnpkg.com/wordwrap/-/wordwrap-0.0.2.tgz#b79669bb42ecb409f83d583cad52ca17eaa1643f" +wordwrap@~0.0.2: + version "0.0.3" + resolved "https://registry.yarnpkg.com/wordwrap/-/wordwrap-0.0.3.tgz#a3d5da6cd5c0bc0008d37234bbaf1bed63059107" + wordwrap@~1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/wordwrap/-/wordwrap-1.0.0.tgz#27584810891456a4171c8d0226441ade90cbcaeb" @@ -3601,9 +3598,9 @@ xdg-basedir@^3.0.0: version "3.0.0" resolved "https://registry.yarnpkg.com/xdg-basedir/-/xdg-basedir-3.0.0.tgz#496b2cc109eca8dbacfe2dc72b603c17c5870ad4" -xelement@^1.0.14: - version "1.0.14" - resolved "https://registry.yarnpkg.com/xelement/-/xelement-1.0.14.tgz#46eb00ea6f5e4db9c18d6f05bcd08dc9ebeff8c0" +xelement@^1.0.16: + version "1.0.16" + resolved "https://registry.yarnpkg.com/xelement/-/xelement-1.0.16.tgz#900bb46c20fc2dffadff778a9d2dc36699d0ff7e" dependencies: sax "^1.2.1"