docs: regenerate API, exclude some protected properties/methods to si…

…mplify
electron-userland · Jun 5, 2017 · 9014d74 · 9014d74
1 parent a75bac8
commit 9014d74
Show file tree

Hide file tree

Showing 6 changed files with 67 additions and 83 deletions.
diff --git a/docs/Auto Update.md b/docs/Auto Update.md
@@ -109,10 +109,6 @@ Emitted on progress. Only supported over Windows build, since `Squirrel.Mac` [do
         * [`.setFeedURL(options)`](#module_electron-updater.AppUpdater+setFeedURL)
         * [`.loadUpdateConfig()`](#module_electron-updater.AppUpdater+loadUpdateConfig) ⇒ <code>Promise&lt;any&gt;</code>
         * [`.quitAndInstall(isSilent)`](#module_electron-updater.AppUpdater+quitAndInstall)
-        * [`.computeRequestHeaders(fileInfo)`](#module_electron-updater.AppUpdater+computeRequestHeaders) ⇒ <code>null</code> \| <code>[RequestHeaders](electron-builder-http#RequestHeaders)</code>
-        * [`.dispatchError(e)`](#module_electron-updater.AppUpdater+dispatchError)
-        * [`.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)`](#module_electron-updater.AppUpdater+doDownloadUpdate) ⇒ <code>Promise&lt;any&gt;</code>
-        * [`.onUpdateAvailable(versionInfo, fileInfo)`](#module_electron-updater.AppUpdater+onUpdateAvailable)
     * [.Provider](#Provider)
         * [`.getLatestVersion()`](#module_electron-updater.Provider+getLatestVersion) ⇒ <code>Promise&lt;module:electron-updater.T&gt;</code>
         * [`.setRequestHeaders(value)`](#module_electron-updater.Provider+setRequestHeaders)
@@ -210,9 +206,6 @@ Emitted on progress. Only supported over Windows build, since `Squirrel.Mac` [do
 | requestHeaders| <code>[RequestHeaders](electron-builder-http#RequestHeaders)</code> \| <code>null</code> | <a name="AppUpdater-requestHeaders"></a>The request headers. |
 | logger = <code>(&lt;any&gt;global).__test_app ? null : console</code>| <code>[Logger](#Logger)</code> \| <code>null</code> | <a name="AppUpdater-logger"></a>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 = <code>new UpdaterSignal(this)</code>| <code>[UpdaterSignal](#UpdaterSignal)</code> | <a name="AppUpdater-signals"></a>For type safety you can use signals, e.g. `autoUpdater.signals.updateDownloaded(() => {})` instead of `autoUpdater.on('update-available', () => {})` |
-| updateAvailable| <code>boolean</code> | <a name="AppUpdater-updateAvailable"></a> |
-| app| <code>Electron:App</code> | <a name="AppUpdater-app"></a> |
-| versionInfo| <code>[VersionInfo](Publishing-Artifacts#VersionInfo)</code> \| <code>null</code> | <a name="AppUpdater-versionInfo"></a> |
 
 
 * [.AppUpdater](#AppUpdater) ⇐ <code>internal:EventEmitter</code>
@@ -222,10 +215,6 @@ Emitted on progress. Only supported over Windows build, since `Squirrel.Mac` [do
     * [`.setFeedURL(options)`](#module_electron-updater.AppUpdater+setFeedURL)
     * [`.loadUpdateConfig()`](#module_electron-updater.AppUpdater+loadUpdateConfig) ⇒ <code>Promise&lt;any&gt;</code>
     * [`.quitAndInstall(isSilent)`](#module_electron-updater.AppUpdater+quitAndInstall)
-    * [`.computeRequestHeaders(fileInfo)`](#module_electron-updater.AppUpdater+computeRequestHeaders) ⇒ <code>null</code> \| <code>[RequestHeaders](electron-builder-http#RequestHeaders)</code>
-    * [`.dispatchError(e)`](#module_electron-updater.AppUpdater+dispatchError)
-    * [`.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)`](#module_electron-updater.AppUpdater+doDownloadUpdate) ⇒ <code>Promise&lt;any&gt;</code>
-    * [`.onUpdateAvailable(versionInfo, fileInfo)`](#module_electron-updater.AppUpdater+onUpdateAvailable)
 
 <a name="module_electron-updater.AppUpdater+checkForUpdates"></a>
 
@@ -279,49 +268,6 @@ This is different from the normal quit event sequence.
 | --- | --- | --- |
 | isSilent | <code>boolean</code> | *windows-only* Runs the installer in silent mode. |
 
-<a name="module_electron-updater.AppUpdater+computeRequestHeaders"></a>
-
-#### `appUpdater.computeRequestHeaders(fileInfo)` ⇒ <code>null</code> \| <code>[RequestHeaders](electron-builder-http#RequestHeaders)</code>
-**Kind**: instance method of [<code>AppUpdater</code>](#AppUpdater)  
-**Access**: protected  
-
-| Param | Type |
-| --- | --- |
-| fileInfo | <code>[FileInfo](#FileInfo)</code> | 
-
-<a name="module_electron-updater.AppUpdater+dispatchError"></a>
-
-#### `appUpdater.dispatchError(e)`
-**Kind**: instance method of [<code>AppUpdater</code>](#AppUpdater)  
-**Access**: protected  
-
-| Param | Type |
-| --- | --- |
-| e | <code>Error</code> | 
-
-<a name="module_electron-updater.AppUpdater+doDownloadUpdate"></a>
-
-#### `appUpdater.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)` ⇒ <code>Promise&lt;any&gt;</code>
-**Kind**: instance method of [<code>AppUpdater</code>](#AppUpdater)  
-**Access**: protected  
-
-| Param | Type |
-| --- | --- |
-| versionInfo | <code>[VersionInfo](Publishing-Artifacts#VersionInfo)</code> | 
-| fileInfo | <code>[FileInfo](#FileInfo)</code> | 
-| cancellationToken | <code>[CancellationToken](electron-builder-http#CancellationToken)</code> | 
-
-<a name="module_electron-updater.AppUpdater+onUpdateAvailable"></a>
-
-#### `appUpdater.onUpdateAvailable(versionInfo, fileInfo)`
-**Kind**: instance method of [<code>AppUpdater</code>](#AppUpdater)  
-**Access**: protected  
-
-| Param | Type |
-| --- | --- |
-| versionInfo | <code>[VersionInfo](Publishing-Artifacts#VersionInfo)</code> | 
-| fileInfo | <code>[FileInfo](#FileInfo)</code> | 
-
 <a name="Provider"></a>
 
 ### Provider

diff --git a/docs/api/electron-builder-http.md b/docs/api/electron-builder-http.md
@@ -227,6 +227,9 @@
     * [`.RequestHeaders`](#RequestHeaders)
     * [`.Response`](#Response) ⇐ <code>internal:EventEmitter</code>
         * [`.setEncoding(encoding)`](#module_electron-builder-http.Response+setEncoding)
+    * [.DigestTransform](#DigestTransform) ⇐ <code>internal:Transform</code>
+        * [`._flush(callback)`](#module_electron-builder-http.DigestTransform+_flush)
+        * [`._transform(chunk, encoding, callback)`](#module_electron-builder-http.DigestTransform+_transform)
     * [.HttpError](#HttpError) ⇐ <code>Error</code>
     * [.HttpExecutor](#HttpExecutor)
         * [`.download(url, destination, options)`](#module_electron-builder-http.HttpExecutor+download) ⇒ <code>Promise&lt;string&gt;</code>
@@ -241,6 +244,7 @@
     * [`.download(url, destination, options)`](#module_electron-builder-http.download) ⇒ <code>Promise&lt;string&gt;</code>
     * [`.dumpRequestOptions(options)`](#module_electron-builder-http.dumpRequestOptions) ⇒ <code>string</code>
     * [`.request(options, cancellationToken, data)`](#module_electron-builder-http.request) ⇒ <code>Promise&lt;module:electron-builder-http.T&gt;</code>
+    * [`.safeGetHeader(response, headerKey)`](#module_electron-builder-http.safeGetHeader) ⇒ <code>any</code>
 
 <a name="DownloadOptions"></a>
 
@@ -291,6 +295,36 @@
 | --- | --- |
 | encoding | <code>string</code> | 
 
+<a name="DigestTransform"></a>
+
+### DigestTransform ⇐ <code>internal:Transform</code>
+**Kind**: class of [<code>electron-builder-http</code>](#module_electron-builder-http)  
+**Extends**: <code>internal:Transform</code>  
+
+* [.DigestTransform](#DigestTransform) ⇐ <code>internal:Transform</code>
+    * [`._flush(callback)`](#module_electron-builder-http.DigestTransform+_flush)
+    * [`._transform(chunk, encoding, callback)`](#module_electron-builder-http.DigestTransform+_transform)
+
+<a name="module_electron-builder-http.DigestTransform+_flush"></a>
+
+#### `digestTransform._flush(callback)`
+**Kind**: instance method of [<code>DigestTransform</code>](#DigestTransform)  
+
+| Param | Type |
+| --- | --- |
+| callback | <code>function</code> | 
+
+<a name="module_electron-builder-http.DigestTransform+_transform"></a>
+
+#### `digestTransform._transform(chunk, encoding, callback)`
+**Kind**: instance method of [<code>DigestTransform</code>](#DigestTransform)  
+
+| Param | Type |
+| --- | --- |
+| chunk | <code>any</code> | 
+| encoding | <code>string</code> | 
+| callback | <code>function</code> | 
+
 <a name="HttpError"></a>
 
 ### HttpError ⇐ <code>Error</code>
@@ -450,3 +484,13 @@
 | cancellationToken | <code>[CancellationToken](#CancellationToken)</code> | 
 | data | <code>Object&lt;string, any&gt;</code> \| <code>null</code> | 
 
+<a name="module_electron-builder-http.safeGetHeader"></a>
+
+### `electron-builder-http.safeGetHeader(response, headerKey)` ⇒ <code>any</code>
+**Kind**: method of [<code>electron-builder-http</code>](#module_electron-builder-http)  
+
+| Param | Type |
+| --- | --- |
+| response | <code>any</code> | 
+| headerKey | <code>string</code> | 
+
diff --git a/docs/api/electron-updater.md b/docs/api/electron-updater.md
@@ -59,8 +59,8 @@ Developer API only. See [[Auto Update]] for user documentation.
 * [electron-updater/out/electronHttpExecutor](#module_electron-updater/out/electronHttpExecutor)
     * [.ElectronHttpExecutor](#ElectronHttpExecutor) ⇐ <code>[HttpExecutor](electron-builder-http#HttpExecutor)</code>
         * [`.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+doApiRequest) ⇒ <code>Promise&lt;module:electron-updater/out/electronHttpExecutor.T&gt;</code>
-        * [`.download(url, destination, options)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+download) ⇒ <code>Promise&lt;string&gt;</code>
         * [`.doRequest(options, callback)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+doRequest) ⇒ <code>any</code>
+        * [`.download(url, destination, options)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+download) ⇒ <code>Promise&lt;string&gt;</code>
 
 <a name="ElectronHttpExecutor"></a>
 
@@ -70,8 +70,8 @@ Developer API only. See [[Auto Update]] for user documentation.
 
 * [.ElectronHttpExecutor](#ElectronHttpExecutor) ⇐ <code>[HttpExecutor](electron-builder-http#HttpExecutor)</code>
     * [`.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+doApiRequest) ⇒ <code>Promise&lt;module:electron-updater/out/electronHttpExecutor.T&gt;</code>
-    * [`.download(url, destination, options)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+download) ⇒ <code>Promise&lt;string&gt;</code>
     * [`.doRequest(options, callback)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+doRequest) ⇒ <code>any</code>
+    * [`.download(url, destination, options)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+download) ⇒ <code>Promise&lt;string&gt;</code>
 
 <a name="module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+doApiRequest"></a>
 
@@ -85,27 +85,26 @@ Developer API only. See [[Auto Update]] for user documentation.
 | requestProcessor | <code>callback</code> | 
 | redirectCount | <code>number</code> | 
 
-<a name="module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+download"></a>
+<a name="module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+doRequest"></a>
 
-#### `electronHttpExecutor.download(url, destination, options)` ⇒ <code>Promise&lt;string&gt;</code>
+#### `electronHttpExecutor.doRequest(options, callback)` ⇒ <code>any</code>
 **Kind**: instance method of [<code>ElectronHttpExecutor</code>](#ElectronHttpExecutor)  
 
 | Param | Type |
 | --- | --- |
-| url | <code>string</code> | 
-| destination | <code>string</code> | 
-| options | <code>[DownloadOptions](electron-builder-http#DownloadOptions)</code> | 
+| options | <code>any</code> | 
+| callback | <code>callback</code> | 
 
-<a name="module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+doRequest"></a>
+<a name="module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+download"></a>
 
-#### `electronHttpExecutor.doRequest(options, callback)` ⇒ <code>any</code>
+#### `electronHttpExecutor.download(url, destination, options)` ⇒ <code>Promise&lt;string&gt;</code>
 **Kind**: instance method of [<code>ElectronHttpExecutor</code>](#ElectronHttpExecutor)  
-**Access**: protected  
 
 | Param | Type |
 | --- | --- |
-| options | <code>any</code> | 
-| callback | <code>callback</code> | 
+| url | <code>string</code> | 
+| destination | <code>string</code> | 
+| options | <code>[DownloadOptions](electron-builder-http#DownloadOptions)</code> | 
 
 <a name="module_electron-updater/out/GenericProvider"></a>
 
@@ -191,7 +190,6 @@ Developer API only. See [[Auto Update]] for user documentation.
     * [.MacUpdater](#MacUpdater) ⇐ <code>[AppUpdater](Auto-Update#AppUpdater)</code>
         * [`.quitAndInstall()`](#module_electron-updater/out/MacUpdater.MacUpdater+quitAndInstall)
         * [`.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)`](#module_electron-updater/out/MacUpdater.MacUpdater+doDownloadUpdate) ⇒ <code>module:bluebird-lst.Bluebird&lt;void&gt;</code>
-        * [`.onUpdateAvailable(versionInfo, fileInfo)`](#module_electron-updater/out/MacUpdater.MacUpdater+onUpdateAvailable)
 
 <a name="MacUpdater"></a>
 
@@ -202,7 +200,6 @@ Developer API only. See [[Auto Update]] for user documentation.
 * [.MacUpdater](#MacUpdater) ⇐ <code>[AppUpdater](Auto-Update#AppUpdater)</code>
     * [`.quitAndInstall()`](#module_electron-updater/out/MacUpdater.MacUpdater+quitAndInstall)
     * [`.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)`](#module_electron-updater/out/MacUpdater.MacUpdater+doDownloadUpdate) ⇒ <code>module:bluebird-lst.Bluebird&lt;void&gt;</code>
-    * [`.onUpdateAvailable(versionInfo, fileInfo)`](#module_electron-updater/out/MacUpdater.MacUpdater+onUpdateAvailable)
 
 <a name="module_electron-updater/out/MacUpdater.MacUpdater+quitAndInstall"></a>
 
@@ -220,17 +217,6 @@ Developer API only. See [[Auto Update]] for user documentation.
 | fileInfo | <code>[FileInfo](Auto-Update#FileInfo)</code> | 
 | cancellationToken | <code>[CancellationToken](electron-builder-http#CancellationToken)</code> | 
 
-<a name="module_electron-updater/out/MacUpdater.MacUpdater+onUpdateAvailable"></a>
-
-#### `macUpdater.onUpdateAvailable(versionInfo, fileInfo)`
-**Kind**: instance method of [<code>MacUpdater</code>](#MacUpdater)  
-**Access**: protected  
-
-| Param | Type |
-| --- | --- |
-| versionInfo | <code>[VersionInfo](Publishing-Artifacts#VersionInfo)</code> | 
-| fileInfo | <code>[FileInfo](Auto-Update#FileInfo)</code> | 
-
 <a name="module_electron-updater/out/NsisUpdater"></a>
 
 ## electron-updater/out/NsisUpdater

diff --git a/packages/electron-updater/src/AppUpdater.ts b/packages/electron-updater/src/AppUpdater.ts
@@ -57,20 +57,24 @@ export abstract class AppUpdater extends EventEmitter {
     this._appUpdateConfigPath =  value
   }
 
+  /*** @private */
   protected updateAvailable = false
 
   private clientPromise: Promise<Provider<any>> | null
 
   private readonly untilAppReady: Promise<boolean>
   private checkForUpdatesPromise: Promise<UpdateCheckResult> | null
 
+  /*** @private */
   protected readonly app: Electron.App
 
+  /*** @private */
   protected versionInfo: VersionInfo | null
   private fileInfo: FileInfo | null
 
   private currentVersion: string
 
+  /*** @private */
   protected httpExecutor: ElectronHttpExecutor
 
   constructor(options: PublishConfiguration | null | undefined, app?: any) {
@@ -218,6 +222,7 @@ 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})`)
@@ -252,10 +257,12 @@ 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<any>
 
   /**
@@ -276,6 +283,7 @@ export abstract class AppUpdater extends EventEmitter {
     return safeLoad(await readFile(this._appUpdateConfigPath, "utf-8"))
   }
 
+  /*** @private */
   protected computeRequestHeaders(fileInfo: FileInfo): RequestHeaders | null {
     let requestHeaders = this.requestHeaders
     if (fileInfo.headers != null) {

diff --git a/packages/electron-updater/src/MacUpdater.ts b/packages/electron-updater/src/MacUpdater.ts
@@ -42,7 +42,7 @@ export class MacUpdater extends AppUpdater {
       return `http://${address.address}:${address.port}`
     }
 
-    return new BluebirdPromise((resolve, reject) => {
+    return new BluebirdPromise<void>((resolve, reject) => {
       server.on("request", (request: IncomingMessage, response: ServerResponse) => {
         const requestUrl = request.url!
         if (requestUrl === "/") {

diff --git a/test/out/__snapshots__/nsisUpdaterTest.js.snap b/test/out/__snapshots__/nsisUpdaterTest.js.snap
@@ -117,13 +117,13 @@ Object {
 exports[`sha512 mismatch error event 1`] = `
 Object {
   "name": "TestApp Setup 1.1.0.exe",
-  "sha2": "f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd1",
-  "sha512": undefined,
+  "sha2": undefined,
+  "sha512": "Dj51I0q8aPQ3ioaz9LMqGYujAYRbDNblAQbodDRXAMxmY6hsHqEl3F6SvhfJj5oPhcqdX1ldsgEvfMNXGUXBIZ==",
   "url": "https://develar.s3.amazonaws.com/test/TestApp Setup 1.1.0.exe",
 }
 `;
 
-exports[`sha512 mismatch error event 2`] = `"SHA2 checksum mismatch, expected f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd1, got f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd2"`;
+exports[`sha512 mismatch error event 2`] = `"sha512 checksum mismatch, expected Dj51I0q8aPQ3ioaz9LMqGYujAYRbDNblAQbodDRXAMxmY6hsHqEl3F6SvhfJj5oPhcqdX1ldsgEvfMNXGUXBIZ==, got Dj51I0q8aPQ3ioaz9LMqGYujAYRbDNblAQbodDRXAMxmY6hsHqEl3F6SvhfJj5oPhcqdX1ldsgEvfMNXGUXBIw=="`;
 
 exports[`sha512 mismatch error event 3`] = `
 Array [