Skip to content

Commit

Permalink
refactor: mark some members as internal
Browse files Browse the repository at this point in the history
  • Loading branch information
develar committed Jun 14, 2017
1 parent 32e0f61 commit 157c730
Show file tree
Hide file tree
Showing 19 changed files with 110 additions and 135 deletions.
1 change: 1 addition & 0 deletions .idea/electron-builder.iml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions docs/Options.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ Configuration Options
* <a name="Protocol-name"></a>**`name`** String - The name. e.g. `IRC server URL`.
* <a name="Protocol-schemes"></a>**`schemes`** Array&lt;String&gt; - The schemes. e.g. `["irc", "ircs"]`.
* <a name="Protocol-role"></a>`role` = `Editor` "Editor" | "Viewer" | "Shell" | "None" - *macOS-only* The app’s role with respect to the type.
* <a name="Config-compression"></a>`compression` = `normal` "undefined" | "undefined" | "undefined" - The compression level. If you want to rapidly test build, `store` can reduce build time significantly.
* <a name="Config-compression"></a>`compression` = `normal` "store" | "normal" | "maximum" - The compression level. If you want to rapidly test build, `store` can reduce build time significantly.
* <a name="Config-afterPack"></a>`afterPack` callback - *programmatic API only* The function to be run after pack (but before pack into distributable format and sign). Promise must be returned.
* <a name="Config-beforeBuild"></a>`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.
* <a name="Config-npmRebuild"></a>`npmRebuild` = `true` Boolean - Whether to [rebuild](https://docs.npmjs.com/cli/rebuild) native dependencies (`npm rebuild`) before starting to package the app.
Expand All @@ -173,7 +173,7 @@ Configuration Options
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).
* <a name="MacOptions-target"></a>`target` Array&lt;[TargetConfig](electron-builder-core#TargetConfig) | "undefined" | "undefined" | "undefined" | "undefined" | "undefined" | "undefined" | "undefined" | "undefined" | "undefined" | "undefined" | "undefined" | "undefined"&gt; | "undefined" | "undefined" | "undefined" | "undefined" | "undefined" | "undefined" | "undefined" | "undefined" | "undefined" | "undefined" | "undefined" | "undefined" | [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).
* <a name="MacOptions-target"></a>`target` Array&lt;[TargetConfig](electron-builder-core#TargetConfig) | "default" | "dmg" | "mas" | "mas-dev" | "pkg" | "7z" | "zip" | "tar.xz" | "tar.lz" | "tar.gz" | "tar.bz2" | "dir"&gt; | "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).
* <a name="MacOptions-identity"></a>`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).
* <a name="MacOptions-icon"></a>`icon` = `build/icon.icns` String - The path to application icon.
* <a name="MacOptions-entitlements"></a>`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).
Expand Down Expand Up @@ -216,7 +216,7 @@ Configuration Options
* <a name="WinBuildOptions-target"></a>`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.
* <a name="WinBuildOptions-signingHashAlgorithms"></a>`signingHashAlgorithms` = `['sha1', 'sha256']` Array&lt;"undefined" | "undefined"&gt; - Array of signing algorithms used. For AppX `sha256` is always used.
* <a name="WinBuildOptions-signingHashAlgorithms"></a>`signingHashAlgorithms` = `['sha1', 'sha256']` Array&lt;"sha1" | "sha256"&gt; - Array of signing algorithms used. For AppX `sha256` is always used.
* <a name="WinBuildOptions-icon"></a>`icon` = `build/icon.ico` String - The path to application icon.
* <a name="WinBuildOptions-legalTrademarks"></a>`legalTrademarks` String - The trademarks and registered trademarks.
* <a name="WinBuildOptions-certificateFile"></a>`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).
Expand Down
2 changes: 1 addition & 1 deletion docs/Publishing Artifacts.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ If `BT_TOKEN` is set and `GH_TOKEN` is not set — defaults to `[{provider: "bin

| Name | Type | Description |
| --- | --- | --- |
| **provider**| <code>"undefined"</code> \| <code>"undefined"</code> \| <code>"undefined"</code> \| <code>"undefined"</code> | <a name="PublishConfiguration-provider"></a>The provider. |
| **provider**| <code>"github"</code> \| <code>"bintray"</code> \| <code>"s3"</code> \| <code>"generic"</code> | <a name="PublishConfiguration-provider"></a>The provider. |
| owner| <code>String</code> \| <code>null</code> | <a name="PublishConfiguration-owner"></a>The owner. |

<a name="S3Options"></a>
Expand Down
24 changes: 12 additions & 12 deletions docs/api/electron-builder-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,17 @@
* [`.TargetConfig`](#TargetConfig)
* [`.TargetSpecificOptions`](#TargetSpecificOptions)
* [.Platform](#Platform)
* [`.createTarget(type, archs)`](#module_electron-builder-core.Platform+createTarget) ⇒ <code>Map&lt;[Platform](#Platform) \| Map&lt;"undefined" \| "undefined" \| "undefined" \| Array&lt;String&gt;&gt;&gt;</code>
* [`.createTarget(type, archs)`](#module_electron-builder-core.Platform+createTarget) ⇒ <code>Map&lt;[Platform](#Platform) \| Map&lt;[Arch](#Arch) \| Array&lt;String&gt;&gt;&gt;</code>
* [`.current()`](#module_electron-builder-core.Platform+current) ⇒ <code>[Platform](#Platform)</code>
* [`.fromString(name)`](#module_electron-builder-core.Platform+fromString) ⇒ <code>[Platform](#Platform)</code>
* [`.toString()`](#module_electron-builder-core.Platform+toString) ⇒ <code>String</code>
* [.Target](#Target)
* [`.build(appOutDir, arch)`](#module_electron-builder-core.Target+build) ⇒ <code>Promise&lt;any&gt;</code>
* [`.finishBuild()`](#module_electron-builder-core.Target+finishBuild) ⇒ <code>Promise&lt;any&gt;</code>
* [`.Arch`](#Arch) : <code>enum</code>
* [`.archFromString(name)`](#module_electron-builder-core.archFromString) ⇒ <code>"undefined"</code> \| <code>"undefined"</code> \| <code>"undefined"</code>
* [`.archFromString(name)`](#module_electron-builder-core.archFromString) ⇒ <code>[Arch](#Arch)</code>
* [`.getArchSuffix(arch)`](#module_electron-builder-core.getArchSuffix) ⇒ <code>String</code>
* [`.toLinuxArchString(arch)`](#module_electron-builder-core.toLinuxArchString) ⇒ <code>"undefined"</code> \| <code>"undefined"</code> \| <code>"undefined"</code>
* [`.toLinuxArchString(arch)`](#module_electron-builder-core.toLinuxArchString) ⇒ <code>"armv7l"</code> \| <code>"i386"</code> \| <code>"amd64"</code>

<a name="BeforeBuildContext"></a>

Expand Down Expand Up @@ -55,7 +55,7 @@
| Name | Type | Description |
| --- | --- | --- |
| **target**| <code>String</code> | <a name="TargetConfig-target"></a>The target name. e.g. `snap`. |
| arch| <code>Array&lt;"undefined" \| "undefined" \| "undefined"&gt;</code> \| <code>String</code> | <a name="TargetConfig-arch"></a>The arch or list of archs. |
| arch| <code>Array&lt;"x64" \| "ia32" \| "armv7l"&gt;</code> \| <code>String</code> | <a name="TargetConfig-arch"></a>The arch or list of archs. |

<a name="TargetSpecificOptions"></a>

Expand Down Expand Up @@ -83,20 +83,20 @@


* [.Platform](#Platform)
* [`.createTarget(type, archs)`](#module_electron-builder-core.Platform+createTarget) ⇒ <code>Map&lt;[Platform](#Platform) \| Map&lt;"undefined" \| "undefined" \| "undefined" \| Array&lt;String&gt;&gt;&gt;</code>
* [`.createTarget(type, archs)`](#module_electron-builder-core.Platform+createTarget) ⇒ <code>Map&lt;[Platform](#Platform) \| Map&lt;[Arch](#Arch) \| Array&lt;String&gt;&gt;&gt;</code>
* [`.current()`](#module_electron-builder-core.Platform+current) ⇒ <code>[Platform](#Platform)</code>
* [`.fromString(name)`](#module_electron-builder-core.Platform+fromString) ⇒ <code>[Platform](#Platform)</code>
* [`.toString()`](#module_electron-builder-core.Platform+toString) ⇒ <code>String</code>

<a name="module_electron-builder-core.Platform+createTarget"></a>

#### `platform.createTarget(type, archs)` ⇒ <code>Map&lt;[Platform](#Platform) \| Map&lt;"undefined" \| "undefined" \| "undefined" \| Array&lt;String&gt;&gt;&gt;</code>
#### `platform.createTarget(type, archs)` ⇒ <code>Map&lt;[Platform](#Platform) \| Map&lt;[Arch](#Arch) \| Array&lt;String&gt;&gt;&gt;</code>
**Kind**: instance method of [<code>Platform</code>](#Platform)

| Param | Type |
| --- | --- |
| type | <code>String</code> \| <code>Array&lt;String&gt;</code> \| <code>null</code> |
| archs | <code>Array&lt;"undefined" \| "undefined" \| "undefined"&gt;</code> |
| archs | <code>Array&lt;[Arch](#Arch)&gt;</code> |

<a name="module_electron-builder-core.Platform+current"></a>

Expand Down Expand Up @@ -139,7 +139,7 @@
| Param | Type |
| --- | --- |
| appOutDir | <code>String</code> |
| arch | <code>"undefined"</code> \| <code>"undefined"</code> \| <code>"undefined"</code> |
| arch | <code>[Arch](#Arch)</code> |

<a name="module_electron-builder-core.Target+finishBuild"></a>

Expand All @@ -159,7 +159,7 @@

<a name="module_electron-builder-core.archFromString"></a>

### `electron-builder-core.archFromString(name)` ⇒ <code>"undefined"</code> \| <code>"undefined"</code> \| <code>"undefined"</code>
### `electron-builder-core.archFromString(name)` ⇒ <code>[Arch](#Arch)</code>
**Kind**: method of [<code>electron-builder-core</code>](#module_electron-builder-core)

| Param | Type |
Expand All @@ -173,14 +173,14 @@

| Param | Type |
| --- | --- |
| arch | <code>"undefined"</code> \| <code>"undefined"</code> \| <code>"undefined"</code> |
| arch | <code>[Arch](#Arch)</code> |

<a name="module_electron-builder-core.toLinuxArchString"></a>

### `electron-builder-core.toLinuxArchString(arch)` ⇒ <code>"undefined"</code> \| <code>"undefined"</code> \| <code>"undefined"</code>
### `electron-builder-core.toLinuxArchString(arch)` ⇒ <code>"armv7l"</code> \| <code>"i386"</code> \| <code>"amd64"</code>
**Kind**: method of [<code>electron-builder-core</code>](#module_electron-builder-core)

| Param | Type |
| --- | --- |
| arch | <code>"undefined"</code> \| <code>"undefined"</code> \| <code>"undefined"</code> |
| arch | <code>[Arch](#Arch)</code> |

4 changes: 2 additions & 2 deletions docs/api/electron-builder-util.md
Original file line number Diff line number Diff line change
Expand Up @@ -406,7 +406,7 @@ ensureDir is not called, dest parent dir must exists
* [`.getTempName(prefix)`](#module_electron-builder-util.getTempName) ⇒ <code>String</code>
* [`.handleProcess(event, childProcess, command, resolve, reject)`](#module_electron-builder-util.handleProcess)
* [`.isEmptyOrSpaces(s)`](#module_electron-builder-util.isEmptyOrSpaces) ⇒ <code>Boolean</code>
* [`.isPullRequest()`](#module_electron-builder-util.isPullRequest) ⇒ <code>"undefined"</code> \| <code>"undefined"</code> \| <code>"undefined"</code>
* [`.isPullRequest()`](#module_electron-builder-util.isPullRequest) ⇒ <code>"undefined"</code> \| <code>"undefined"</code> \| <code>""</code>
* [`.prepareArgs(args, exePath)`](#module_electron-builder-util.prepareArgs) ⇒ <code>Array&lt;String&gt;</code>
* [`.removePassword(input)`](#module_electron-builder-util.removePassword) ⇒ <code>String</code>
* [`.replaceDefault(inList, defaultList)`](#module_electron-builder-util.replaceDefault) ⇒ <code>Array&lt;String&gt;</code>
Expand Down Expand Up @@ -572,7 +572,7 @@ ensureDir is not called, dest parent dir must exists

<a name="module_electron-builder-util.isPullRequest"></a>

### `electron-builder-util.isPullRequest()` ⇒ <code>"undefined"</code> \| <code>"undefined"</code> \| <code>"undefined"</code>
### `electron-builder-util.isPullRequest()` ⇒ <code>"undefined"</code> \| <code>"undefined"</code> \| <code>""</code>
**Kind**: method of [<code>electron-builder-util</code>](#module_electron-builder-util)
<a name="module_electron-builder-util.prepareArgs"></a>

Expand Down
Loading

0 comments on commit 157c730

Please sign in to comment.