From e9acd2d3fd4de9d8529b3d04a7b99d7da7bc8a4f Mon Sep 17 00:00:00 2001 From: develar Date: Wed, 8 Mar 2017 18:07:18 +0100 Subject: [PATCH] docs: API --- .yarnclean | 18 +- docs/API.md | 1856 +++++++++++++++++ docs/Options.md | 2 +- docs/Publishing Artifacts.md | 69 +- jsdoc/jsdoc.json | 26 - jsdoc/readme.md | 1 - package.json | 13 +- .../src/publishOptions.ts | 117 +- packages/electron-builder-http/tsconfig.json | 1 - packages/electron-builder/src/metadata.ts | 4 +- .../electron-builder/src/publish/publisher.ts | 17 +- yarn.lock | 384 +++- 12 files changed, 2303 insertions(+), 205 deletions(-) create mode 100644 docs/API.md delete mode 100644 jsdoc/jsdoc.json delete mode 100644 jsdoc/readme.md diff --git a/.yarnclean b/.yarnclean index e3afba09039..0bbed96592d 100644 --- a/.yarnclean +++ b/.yarnclean @@ -5,15 +5,16 @@ tests powered-test # asset directories -docs -doc -website -images -assets +# breaks jsdoc2md +#docs +#doc +#website +#images +#assets # examples -example -examples +#example +#examples # code coverage directories coverage @@ -41,5 +42,4 @@ Gruntfile.js *.gz *.md -!tslint/lib/test -!tslint\lib\test \ No newline at end of file +!tslint/lib/test \ No newline at end of file diff --git a/docs/API.md b/docs/API.md new file mode 100644 index 00000000000..474f73575c7 --- /dev/null +++ b/docs/API.md @@ -0,0 +1,1856 @@ +## Modules + +* [electron-updater/out/AppUpdater](#module_electron-updater/out/AppUpdater) + * [`.Logger`](#module_electron-updater/out/AppUpdater.Logger) + * [`.error(message)`](#module_electron-updater/out/AppUpdater.Logger+error) + * [`.info(message)`](#module_electron-updater/out/AppUpdater.Logger+info) + * [`.warn(message)`](#module_electron-updater/out/AppUpdater.Logger+warn) + * [.AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) ⇐ internal:EventEmitter + * [`.checkForUpdates()`](#module_electron-updater/out/AppUpdater.AppUpdater+checkForUpdates) ⇒ Promise + * [`.downloadUpdate(cancellationToken)`](#module_electron-updater/out/AppUpdater.AppUpdater+downloadUpdate) ⇒ Promise + * [`.getFeedURL()`](#module_electron-updater/out/AppUpdater.AppUpdater+getFeedURL) ⇒ + * [`.setFeedURL(options)`](#module_electron-updater/out/AppUpdater.AppUpdater+setFeedURL) + * [`.loadUpdateConfig()`](#module_electron-updater/out/AppUpdater.AppUpdater+loadUpdateConfig) ⇒ Promise + * [`.quitAndInstall()`](#module_electron-updater/out/AppUpdater.AppUpdater+quitAndInstall) + * [`.dispatchError(e)`](#module_electron-updater/out/AppUpdater.AppUpdater+dispatchError) + * [`.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)`](#module_electron-updater/out/AppUpdater.AppUpdater+doDownloadUpdate) ⇒ Promise + * [`.onUpdateAvailable(versionInfo, fileInfo)`](#module_electron-updater/out/AppUpdater.AppUpdater+onUpdateAvailable) +* [electron-updater/out/BintrayProvider](#module_electron-updater/out/BintrayProvider) + * [.BintrayProvider](#module_electron-updater/out/BintrayProvider.BintrayProvider) ⇐ [Provider](#module_electron-updater/out/api.Provider) + * [`.getLatestVersion()`](#module_electron-updater/out/BintrayProvider.BintrayProvider+getLatestVersion) ⇒ Promise + * [`.getUpdateFile(versionInfo)`](#module_electron-updater/out/BintrayProvider.BintrayProvider+getUpdateFile) ⇒ Promise + * [`.setRequestHeaders(value)`](#module_electron-updater/out/api.Provider+setRequestHeaders) +* [electron-updater/out/GenericProvider](#module_electron-updater/out/GenericProvider) + * [.GenericProvider](#module_electron-updater/out/GenericProvider.GenericProvider) ⇐ [Provider](#module_electron-updater/out/api.Provider) + * [`.getLatestVersion()`](#module_electron-updater/out/GenericProvider.GenericProvider+getLatestVersion) ⇒ Promise + * [`.getUpdateFile(versionInfo)`](#module_electron-updater/out/GenericProvider.GenericProvider+getUpdateFile) ⇒ Promise + * [`.setRequestHeaders(value)`](#module_electron-updater/out/api.Provider+setRequestHeaders) + * [`.validateUpdateInfo(info)`](#module_electron-updater/out/GenericProvider.validateUpdateInfo) +* [electron-updater/out/GitHubProvider](#module_electron-updater/out/GitHubProvider) + * [.GitHubProvider](#module_electron-updater/out/GitHubProvider.GitHubProvider) ⇐ [Provider](#module_electron-updater/out/api.Provider) + * [`.getLatestVersion()`](#module_electron-updater/out/GitHubProvider.GitHubProvider+getLatestVersion) ⇒ Promise + * [`.getUpdateFile(versionInfo)`](#module_electron-updater/out/GitHubProvider.GitHubProvider+getUpdateFile) ⇒ Promise + * [`.setRequestHeaders(value)`](#module_electron-updater/out/api.Provider+setRequestHeaders) +* [electron-updater/out/MacUpdater](#module_electron-updater/out/MacUpdater) + * [.MacUpdater](#module_electron-updater/out/MacUpdater.MacUpdater) ⇐ [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) + * [`.quitAndInstall()`](#module_electron-updater/out/MacUpdater.MacUpdater+quitAndInstall) + * [`.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)`](#module_electron-updater/out/MacUpdater.MacUpdater+doDownloadUpdate) ⇒ module:bluebird-lst.Bluebird + * [`.onUpdateAvailable(versionInfo, fileInfo)`](#module_electron-updater/out/MacUpdater.MacUpdater+onUpdateAvailable) + * [`.checkForUpdates()`](#module_electron-updater/out/AppUpdater.AppUpdater+checkForUpdates) ⇒ Promise + * [`.downloadUpdate(cancellationToken)`](#module_electron-updater/out/AppUpdater.AppUpdater+downloadUpdate) ⇒ Promise + * [`.getFeedURL()`](#module_electron-updater/out/AppUpdater.AppUpdater+getFeedURL) ⇒ + * [`.setFeedURL(options)`](#module_electron-updater/out/AppUpdater.AppUpdater+setFeedURL) + * [`.loadUpdateConfig()`](#module_electron-updater/out/AppUpdater.AppUpdater+loadUpdateConfig) ⇒ Promise + * [`.dispatchError(e)`](#module_electron-updater/out/AppUpdater.AppUpdater+dispatchError) +* [electron-updater/out/NsisUpdater](#module_electron-updater/out/NsisUpdater) + * [.NsisUpdater](#module_electron-updater/out/NsisUpdater.NsisUpdater) ⇐ [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) + * [`.quitAndInstall()`](#module_electron-updater/out/NsisUpdater.NsisUpdater+quitAndInstall) + * [`.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)`](#module_electron-updater/out/NsisUpdater.NsisUpdater+doDownloadUpdate) ⇒ Promise + * [`.checkForUpdates()`](#module_electron-updater/out/AppUpdater.AppUpdater+checkForUpdates) ⇒ Promise + * [`.downloadUpdate(cancellationToken)`](#module_electron-updater/out/AppUpdater.AppUpdater+downloadUpdate) ⇒ Promise + * [`.getFeedURL()`](#module_electron-updater/out/AppUpdater.AppUpdater+getFeedURL) ⇒ + * [`.setFeedURL(options)`](#module_electron-updater/out/AppUpdater.AppUpdater+setFeedURL) + * [`.loadUpdateConfig()`](#module_electron-updater/out/AppUpdater.AppUpdater+loadUpdateConfig) ⇒ Promise + * [`.dispatchError(e)`](#module_electron-updater/out/AppUpdater.AppUpdater+dispatchError) + * [`.onUpdateAvailable(versionInfo, fileInfo)`](#module_electron-updater/out/AppUpdater.AppUpdater+onUpdateAvailable) +* [electron-updater/out/api](#module_electron-updater/out/api) + * [`.FileInfo`](#module_electron-updater/out/api.FileInfo) + * [`.UpdateCheckResult`](#module_electron-updater/out/api.UpdateCheckResult) + * [.Provider](#module_electron-updater/out/api.Provider) + * [`.getLatestVersion()`](#module_electron-updater/out/api.Provider+getLatestVersion) ⇒ Promise + * [`.setRequestHeaders(value)`](#module_electron-updater/out/api.Provider+setRequestHeaders) + * [`.getUpdateFile(versionInfo)`](#module_electron-updater/out/api.Provider+getUpdateFile) ⇒ Promise + * [.UpdaterSignal](#module_electron-updater/out/api.UpdaterSignal) + * [`.progress(handler)`](#module_electron-updater/out/api.UpdaterSignal+progress) + * [`.updateCancelled(handler)`](#module_electron-updater/out/api.UpdaterSignal+updateCancelled) + * [`.updateDownloaded(handler)`](#module_electron-updater/out/api.UpdaterSignal+updateDownloaded) + * [`.getDefaultChannelName()`](#module_electron-updater/out/api.getDefaultChannelName) ⇒ string + * [`.getCustomChannelName(channel)`](#module_electron-updater/out/api.getCustomChannelName) ⇒ string + * [`.getCurrentPlatform()`](#module_electron-updater/out/api.getCurrentPlatform) ⇒ + * [`.getChannelFilename(channel)`](#module_electron-updater/out/api.getChannelFilename) ⇒ string +* [electron-updater/out/electronHttpExecutor](#module_electron-updater/out/electronHttpExecutor) + * [.ElectronHttpExecutor](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor) ⇐ [HttpExecutor](#module_electron-builder-http.HttpExecutor) + * [`.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+doApiRequest) ⇒ Promise + * [`.download(url, destination, options)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+download) ⇒ Promise + * [`.doRequest(options, callback)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+doRequest) ⇒ + * [`.request(options, cancellationToken, data)`](#module_electron-builder-http.HttpExecutor+request) ⇒ Promise + * [`.addTimeOutHandler(request, callback)`](#module_electron-builder-http.HttpExecutor+addTimeOutHandler) + * [`.doDownload(requestOptions, destination, redirectCount, options, callback, onCancel)`](#module_electron-builder-http.HttpExecutor+doDownload) + * [`.handleResponse(response, options, cancellationToken, resolve, reject, redirectCount, requestProcessor)`](#module_electron-builder-http.HttpExecutor+handleResponse) +* [electron-updater](#module_electron-updater) + * [`.autoUpdater`](#module_electron-updater.autoUpdater) : [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) +* [electron-builder-http/out/CancellationToken](#module_electron-builder-http/out/CancellationToken) + * [.CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) ⇐ internal:EventEmitter + * [`.cancel()`](#module_electron-builder-http/out/CancellationToken.CancellationToken+cancel) + * [`.createPromise(callback)`](#module_electron-builder-http/out/CancellationToken.CancellationToken+createPromise) ⇒ Promise + * [`.dispose()`](#module_electron-builder-http/out/CancellationToken.CancellationToken+dispose) + * [.CancellationError](#module_electron-builder-http/out/CancellationToken.CancellationError) ⇐ Error +* [electron-builder-http/out/ProgressCallbackTransform](#module_electron-builder-http/out/ProgressCallbackTransform) + * [`.ProgressInfo`](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressInfo) + * [.ProgressCallbackTransform](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform) ⇐ internal:Transform + * [`._flush(callback)`](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform+_flush) + * [`._transform(chunk, encoding, callback)`](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform+_transform) +* [electron-builder-http/out/bintray](#module_electron-builder-http/out/bintray) + * [`.Version`](#module_electron-builder-http/out/bintray.Version) + * [`.File`](#module_electron-builder-http/out/bintray.File) + * [.BintrayClient](#module_electron-builder-http/out/bintray.BintrayClient) + * [`.createVersion(version)`](#module_electron-builder-http/out/bintray.BintrayClient+createVersion) ⇒ Promise + * [`.deleteVersion(version)`](#module_electron-builder-http/out/bintray.BintrayClient+deleteVersion) ⇒ Promise + * [`.getVersion(version)`](#module_electron-builder-http/out/bintray.BintrayClient+getVersion) ⇒ Promise + * [`.getVersionFiles(version)`](#module_electron-builder-http/out/bintray.BintrayClient+getVersionFiles) ⇒ Promise + * [`.bintrayRequest(path, auth, data, cancellationToken, method)`](#module_electron-builder-http/out/bintray.bintrayRequest) ⇒ Promise +* [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) + * [`.PublishConfiguration`](#module_electron-builder-http/out/publishOptions.PublishConfiguration) + * [`.GenericServerOptions`](#module_electron-builder-http/out/publishOptions.GenericServerOptions) ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) + * [`.S3Options`](#module_electron-builder-http/out/publishOptions.S3Options) ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) + * [`.VersionInfo`](#module_electron-builder-http/out/publishOptions.VersionInfo) + * [`.UpdateInfo`](#module_electron-builder-http/out/publishOptions.UpdateInfo) ⇐ [VersionInfo](#module_electron-builder-http/out/publishOptions.VersionInfo) + * [`.GithubOptions`](#module_electron-builder-http/out/publishOptions.GithubOptions) ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) + * [`.BintrayOptions`](#module_electron-builder-http/out/publishOptions.BintrayOptions) ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) + * [`.s3Url(options)`](#module_electron-builder-http/out/publishOptions.s3Url) ⇒ string + * [`.githubUrl(options)`](#module_electron-builder-http/out/publishOptions.githubUrl) ⇒ string +* [electron-builder-http](#module_electron-builder-http) + * [`.RequestHeaders`](#module_electron-builder-http.RequestHeaders) + * [`.Response`](#module_electron-builder-http.Response) ⇐ internal:EventEmitter + * [`.setEncoding(encoding)`](#module_electron-builder-http.Response+setEncoding) + * [`.DownloadOptions`](#module_electron-builder-http.DownloadOptions) + * [`.onProgress(progress)`](#module_electron-builder-http.DownloadOptions+onProgress) + * [.HttpExecutorHolder](#module_electron-builder-http.HttpExecutorHolder) + * [.HttpError](#module_electron-builder-http.HttpError) ⇐ Error + * [.HttpExecutor](#module_electron-builder-http.HttpExecutor) + * [`.download(url, destination, options)`](#module_electron-builder-http.HttpExecutor+download) ⇒ Promise + * [`.request(options, cancellationToken, data)`](#module_electron-builder-http.HttpExecutor+request) ⇒ Promise + * [`.addTimeOutHandler(request, callback)`](#module_electron-builder-http.HttpExecutor+addTimeOutHandler) + * [`.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)`](#module_electron-builder-http.HttpExecutor+doApiRequest) ⇒ Promise + * [`.doDownload(requestOptions, destination, redirectCount, options, callback, onCancel)`](#module_electron-builder-http.HttpExecutor+doDownload) + * [`.doRequest(options, callback)`](#module_electron-builder-http.HttpExecutor+doRequest) ⇒ + * [`.handleResponse(response, options, cancellationToken, resolve, reject, redirectCount, requestProcessor)`](#module_electron-builder-http.HttpExecutor+handleResponse) + * [`.download(url, destination, options)`](#module_electron-builder-http.download) ⇒ Promise + * [`.request(options, cancellationToken, data)`](#module_electron-builder-http.request) ⇒ Promise + * [`.configureRequestOptions(options, token, method)`](#module_electron-builder-http.configureRequestOptions) ⇒ module:http.RequestOptions + * [`.dumpRequestOptions(options)`](#module_electron-builder-http.dumpRequestOptions) ⇒ string + + + +## electron-updater/out/AppUpdater + +* [electron-updater/out/AppUpdater](#module_electron-updater/out/AppUpdater) + * [`.Logger`](#module_electron-updater/out/AppUpdater.Logger) + * [`.error(message)`](#module_electron-updater/out/AppUpdater.Logger+error) + * [`.info(message)`](#module_electron-updater/out/AppUpdater.Logger+info) + * [`.warn(message)`](#module_electron-updater/out/AppUpdater.Logger+warn) + * [.AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) ⇐ internal:EventEmitter + * [`.checkForUpdates()`](#module_electron-updater/out/AppUpdater.AppUpdater+checkForUpdates) ⇒ Promise + * [`.downloadUpdate(cancellationToken)`](#module_electron-updater/out/AppUpdater.AppUpdater+downloadUpdate) ⇒ Promise + * [`.getFeedURL()`](#module_electron-updater/out/AppUpdater.AppUpdater+getFeedURL) ⇒ + * [`.setFeedURL(options)`](#module_electron-updater/out/AppUpdater.AppUpdater+setFeedURL) + * [`.loadUpdateConfig()`](#module_electron-updater/out/AppUpdater.AppUpdater+loadUpdateConfig) ⇒ Promise + * [`.quitAndInstall()`](#module_electron-updater/out/AppUpdater.AppUpdater+quitAndInstall) + * [`.dispatchError(e)`](#module_electron-updater/out/AppUpdater.AppUpdater+dispatchError) + * [`.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)`](#module_electron-updater/out/AppUpdater.AppUpdater+doDownloadUpdate) ⇒ Promise + * [`.onUpdateAvailable(versionInfo, fileInfo)`](#module_electron-updater/out/AppUpdater.AppUpdater+onUpdateAvailable) + + +- + + + +### `electron-updater/out/AppUpdater.Logger` +**Kind**: interface of [electron-updater/out/AppUpdater](#module_electron-updater/out/AppUpdater) + +* [`.Logger`](#module_electron-updater/out/AppUpdater.Logger) + * [`.error(message)`](#module_electron-updater/out/AppUpdater.Logger+error) + * [`.info(message)`](#module_electron-updater/out/AppUpdater.Logger+info) + * [`.warn(message)`](#module_electron-updater/out/AppUpdater.Logger+warn) + + +- + + + +#### `logger.error(message)` +**Kind**: instance method of [Logger](#module_electron-updater/out/AppUpdater.Logger) + +| Param | +| --- | +| message | + + +- + + + +#### `logger.info(message)` +**Kind**: instance method of [Logger](#module_electron-updater/out/AppUpdater.Logger) + +| Param | +| --- | +| message | + + +- + + + +#### `logger.warn(message)` +**Kind**: instance method of [Logger](#module_electron-updater/out/AppUpdater.Logger) + +| Param | +| --- | +| message | + + +- + + + +### electron-updater/out/AppUpdater.AppUpdater ⇐ internal:EventEmitter +**Kind**: class of [electron-updater/out/AppUpdater](#module_electron-updater/out/AppUpdater) +**Extends**: internal:EventEmitter + +* [.AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) ⇐ internal:EventEmitter + * [`.checkForUpdates()`](#module_electron-updater/out/AppUpdater.AppUpdater+checkForUpdates) ⇒ Promise + * [`.downloadUpdate(cancellationToken)`](#module_electron-updater/out/AppUpdater.AppUpdater+downloadUpdate) ⇒ Promise + * [`.getFeedURL()`](#module_electron-updater/out/AppUpdater.AppUpdater+getFeedURL) ⇒ + * [`.setFeedURL(options)`](#module_electron-updater/out/AppUpdater.AppUpdater+setFeedURL) + * [`.loadUpdateConfig()`](#module_electron-updater/out/AppUpdater.AppUpdater+loadUpdateConfig) ⇒ Promise + * [`.quitAndInstall()`](#module_electron-updater/out/AppUpdater.AppUpdater+quitAndInstall) + * [`.dispatchError(e)`](#module_electron-updater/out/AppUpdater.AppUpdater+dispatchError) + * [`.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)`](#module_electron-updater/out/AppUpdater.AppUpdater+doDownloadUpdate) ⇒ Promise + * [`.onUpdateAvailable(versionInfo, fileInfo)`](#module_electron-updater/out/AppUpdater.AppUpdater+onUpdateAvailable) + + +- + + + +#### `appUpdater.checkForUpdates()` ⇒ Promise +**Kind**: instance method of [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) + +- + + + +#### `appUpdater.downloadUpdate(cancellationToken)` ⇒ Promise +Start downloading update manually. You can use this method if `autoDownload` option is set to `false`. + +**Kind**: instance method of [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) +**Returns**: Promise - Path to downloaded file. + +| Param | Type | +| --- | --- | +| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | + + +- + + + +#### `appUpdater.getFeedURL()` ⇒ +**Kind**: instance method of [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) + +- + + + +#### `appUpdater.setFeedURL(options)` +Configure update provider. If value is `string`, [GenericServerOptions](#module_electron-builder-http/out/publishOptions.GenericServerOptions) will be set with value as `url`. + +**Kind**: instance method of [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) + +| Param | Type | Description | +| --- | --- | --- | +| options | [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) | [GenericServerOptions](#module_electron-builder-http/out/publishOptions.GenericServerOptions) | [S3Options](#module_electron-builder-http/out/publishOptions.S3Options) | [BintrayOptions](#module_electron-builder-http/out/publishOptions.BintrayOptions) | [GithubOptions](#module_electron-builder-http/out/publishOptions.GithubOptions) | string | If you want to override configuration in the `app-update.yml`. | + + +- + + + +#### `appUpdater.loadUpdateConfig()` ⇒ Promise +**Kind**: instance method of [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) + +- + + + +#### `appUpdater.quitAndInstall()` +**Kind**: instance method of [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) + +- + + + +#### `appUpdater.dispatchError(e)` +**Kind**: instance method of [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) +**Access**: protected + +| Param | Type | +| --- | --- | +| e | Error | + + +- + + + +#### `appUpdater.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)` ⇒ Promise +**Kind**: instance method of [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) +**Access**: protected + +| Param | Type | +| --- | --- | +| versionInfo | [VersionInfo](#module_electron-builder-http/out/publishOptions.VersionInfo) | +| fileInfo | [FileInfo](#module_electron-updater/out/api.FileInfo) | +| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | + + +- + + + +#### `appUpdater.onUpdateAvailable(versionInfo, fileInfo)` +**Kind**: instance method of [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) +**Access**: protected + +| Param | Type | +| --- | --- | +| versionInfo | [VersionInfo](#module_electron-builder-http/out/publishOptions.VersionInfo) | +| fileInfo | [FileInfo](#module_electron-updater/out/api.FileInfo) | + + +- + + + +## electron-updater/out/BintrayProvider + +* [electron-updater/out/BintrayProvider](#module_electron-updater/out/BintrayProvider) + * [.BintrayProvider](#module_electron-updater/out/BintrayProvider.BintrayProvider) ⇐ [Provider](#module_electron-updater/out/api.Provider) + * [`.getLatestVersion()`](#module_electron-updater/out/BintrayProvider.BintrayProvider+getLatestVersion) ⇒ Promise + * [`.getUpdateFile(versionInfo)`](#module_electron-updater/out/BintrayProvider.BintrayProvider+getUpdateFile) ⇒ Promise + * [`.setRequestHeaders(value)`](#module_electron-updater/out/api.Provider+setRequestHeaders) + + +- + + + +### electron-updater/out/BintrayProvider.BintrayProvider ⇐ [Provider](#module_electron-updater/out/api.Provider) +**Kind**: class of [electron-updater/out/BintrayProvider](#module_electron-updater/out/BintrayProvider) +**Extends**: [Provider](#module_electron-updater/out/api.Provider) + +* [.BintrayProvider](#module_electron-updater/out/BintrayProvider.BintrayProvider) ⇐ [Provider](#module_electron-updater/out/api.Provider) + * [`.getLatestVersion()`](#module_electron-updater/out/BintrayProvider.BintrayProvider+getLatestVersion) ⇒ Promise + * [`.getUpdateFile(versionInfo)`](#module_electron-updater/out/BintrayProvider.BintrayProvider+getUpdateFile) ⇒ Promise + * [`.setRequestHeaders(value)`](#module_electron-updater/out/api.Provider+setRequestHeaders) + + +- + + + +#### `bintrayProvider.getLatestVersion()` ⇒ Promise +**Kind**: instance method of [BintrayProvider](#module_electron-updater/out/BintrayProvider.BintrayProvider) +**Overrides**: [getLatestVersion](#module_electron-updater/out/api.Provider+getLatestVersion) + +- + + + +#### `bintrayProvider.getUpdateFile(versionInfo)` ⇒ Promise +**Kind**: instance method of [BintrayProvider](#module_electron-updater/out/BintrayProvider.BintrayProvider) +**Overrides**: [getUpdateFile](#module_electron-updater/out/api.Provider+getUpdateFile) + +| Param | Type | +| --- | --- | +| versionInfo | [VersionInfo](#module_electron-builder-http/out/publishOptions.VersionInfo) | + + +- + + + +#### `bintrayProvider.setRequestHeaders(value)` +**Kind**: instance method of [BintrayProvider](#module_electron-updater/out/BintrayProvider.BintrayProvider) + +| Param | Type | +| --- | --- | +| value | [RequestHeaders](#module_electron-builder-http.RequestHeaders) | null | + + +- + + + +## electron-updater/out/GenericProvider + +* [electron-updater/out/GenericProvider](#module_electron-updater/out/GenericProvider) + * [.GenericProvider](#module_electron-updater/out/GenericProvider.GenericProvider) ⇐ [Provider](#module_electron-updater/out/api.Provider) + * [`.getLatestVersion()`](#module_electron-updater/out/GenericProvider.GenericProvider+getLatestVersion) ⇒ Promise + * [`.getUpdateFile(versionInfo)`](#module_electron-updater/out/GenericProvider.GenericProvider+getUpdateFile) ⇒ Promise + * [`.setRequestHeaders(value)`](#module_electron-updater/out/api.Provider+setRequestHeaders) + * [`.validateUpdateInfo(info)`](#module_electron-updater/out/GenericProvider.validateUpdateInfo) + + +- + + + +### electron-updater/out/GenericProvider.GenericProvider ⇐ [Provider](#module_electron-updater/out/api.Provider) +**Kind**: class of [electron-updater/out/GenericProvider](#module_electron-updater/out/GenericProvider) +**Extends**: [Provider](#module_electron-updater/out/api.Provider) + +* [.GenericProvider](#module_electron-updater/out/GenericProvider.GenericProvider) ⇐ [Provider](#module_electron-updater/out/api.Provider) + * [`.getLatestVersion()`](#module_electron-updater/out/GenericProvider.GenericProvider+getLatestVersion) ⇒ Promise + * [`.getUpdateFile(versionInfo)`](#module_electron-updater/out/GenericProvider.GenericProvider+getUpdateFile) ⇒ Promise + * [`.setRequestHeaders(value)`](#module_electron-updater/out/api.Provider+setRequestHeaders) + + +- + + + +#### `genericProvider.getLatestVersion()` ⇒ Promise +**Kind**: instance method of [GenericProvider](#module_electron-updater/out/GenericProvider.GenericProvider) +**Overrides**: [getLatestVersion](#module_electron-updater/out/api.Provider+getLatestVersion) + +- + + + +#### `genericProvider.getUpdateFile(versionInfo)` ⇒ Promise +**Kind**: instance method of [GenericProvider](#module_electron-updater/out/GenericProvider.GenericProvider) +**Overrides**: [getUpdateFile](#module_electron-updater/out/api.Provider+getUpdateFile) + +| Param | Type | +| --- | --- | +| versionInfo | [UpdateInfo](#module_electron-builder-http/out/publishOptions.UpdateInfo) | + + +- + + + +#### `genericProvider.setRequestHeaders(value)` +**Kind**: instance method of [GenericProvider](#module_electron-updater/out/GenericProvider.GenericProvider) + +| Param | Type | +| --- | --- | +| value | [RequestHeaders](#module_electron-builder-http.RequestHeaders) | null | + + +- + + + +### `electron-updater/out/GenericProvider.validateUpdateInfo(info)` +**Kind**: method of [electron-updater/out/GenericProvider](#module_electron-updater/out/GenericProvider) + +| Param | Type | +| --- | --- | +| info | [UpdateInfo](#module_electron-builder-http/out/publishOptions.UpdateInfo) | + + +- + + + +## electron-updater/out/GitHubProvider + +* [electron-updater/out/GitHubProvider](#module_electron-updater/out/GitHubProvider) + * [.GitHubProvider](#module_electron-updater/out/GitHubProvider.GitHubProvider) ⇐ [Provider](#module_electron-updater/out/api.Provider) + * [`.getLatestVersion()`](#module_electron-updater/out/GitHubProvider.GitHubProvider+getLatestVersion) ⇒ Promise + * [`.getUpdateFile(versionInfo)`](#module_electron-updater/out/GitHubProvider.GitHubProvider+getUpdateFile) ⇒ Promise + * [`.setRequestHeaders(value)`](#module_electron-updater/out/api.Provider+setRequestHeaders) + + +- + + + +### electron-updater/out/GitHubProvider.GitHubProvider ⇐ [Provider](#module_electron-updater/out/api.Provider) +**Kind**: class of [electron-updater/out/GitHubProvider](#module_electron-updater/out/GitHubProvider) +**Extends**: [Provider](#module_electron-updater/out/api.Provider) + +* [.GitHubProvider](#module_electron-updater/out/GitHubProvider.GitHubProvider) ⇐ [Provider](#module_electron-updater/out/api.Provider) + * [`.getLatestVersion()`](#module_electron-updater/out/GitHubProvider.GitHubProvider+getLatestVersion) ⇒ Promise + * [`.getUpdateFile(versionInfo)`](#module_electron-updater/out/GitHubProvider.GitHubProvider+getUpdateFile) ⇒ Promise + * [`.setRequestHeaders(value)`](#module_electron-updater/out/api.Provider+setRequestHeaders) + + +- + + + +#### `gitHubProvider.getLatestVersion()` ⇒ Promise +**Kind**: instance method of [GitHubProvider](#module_electron-updater/out/GitHubProvider.GitHubProvider) +**Overrides**: [getLatestVersion](#module_electron-updater/out/api.Provider+getLatestVersion) + +- + + + +#### `gitHubProvider.getUpdateFile(versionInfo)` ⇒ Promise +**Kind**: instance method of [GitHubProvider](#module_electron-updater/out/GitHubProvider.GitHubProvider) +**Overrides**: [getUpdateFile](#module_electron-updater/out/api.Provider+getUpdateFile) + +| Param | Type | +| --- | --- | +| versionInfo | [UpdateInfo](#module_electron-builder-http/out/publishOptions.UpdateInfo) | + + +- + + + +#### `gitHubProvider.setRequestHeaders(value)` +**Kind**: instance method of [GitHubProvider](#module_electron-updater/out/GitHubProvider.GitHubProvider) + +| Param | Type | +| --- | --- | +| value | [RequestHeaders](#module_electron-builder-http.RequestHeaders) | null | + + +- + + + +## electron-updater/out/MacUpdater + +* [electron-updater/out/MacUpdater](#module_electron-updater/out/MacUpdater) + * [.MacUpdater](#module_electron-updater/out/MacUpdater.MacUpdater) ⇐ [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) + * [`.quitAndInstall()`](#module_electron-updater/out/MacUpdater.MacUpdater+quitAndInstall) + * [`.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)`](#module_electron-updater/out/MacUpdater.MacUpdater+doDownloadUpdate) ⇒ module:bluebird-lst.Bluebird + * [`.onUpdateAvailable(versionInfo, fileInfo)`](#module_electron-updater/out/MacUpdater.MacUpdater+onUpdateAvailable) + * [`.checkForUpdates()`](#module_electron-updater/out/AppUpdater.AppUpdater+checkForUpdates) ⇒ Promise + * [`.downloadUpdate(cancellationToken)`](#module_electron-updater/out/AppUpdater.AppUpdater+downloadUpdate) ⇒ Promise + * [`.getFeedURL()`](#module_electron-updater/out/AppUpdater.AppUpdater+getFeedURL) ⇒ + * [`.setFeedURL(options)`](#module_electron-updater/out/AppUpdater.AppUpdater+setFeedURL) + * [`.loadUpdateConfig()`](#module_electron-updater/out/AppUpdater.AppUpdater+loadUpdateConfig) ⇒ Promise + * [`.dispatchError(e)`](#module_electron-updater/out/AppUpdater.AppUpdater+dispatchError) + + +- + + + +### electron-updater/out/MacUpdater.MacUpdater ⇐ [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) +**Kind**: class of [electron-updater/out/MacUpdater](#module_electron-updater/out/MacUpdater) +**Extends**: [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) + +* [.MacUpdater](#module_electron-updater/out/MacUpdater.MacUpdater) ⇐ [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) + * [`.quitAndInstall()`](#module_electron-updater/out/MacUpdater.MacUpdater+quitAndInstall) + * [`.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)`](#module_electron-updater/out/MacUpdater.MacUpdater+doDownloadUpdate) ⇒ module:bluebird-lst.Bluebird + * [`.onUpdateAvailable(versionInfo, fileInfo)`](#module_electron-updater/out/MacUpdater.MacUpdater+onUpdateAvailable) + * [`.checkForUpdates()`](#module_electron-updater/out/AppUpdater.AppUpdater+checkForUpdates) ⇒ Promise + * [`.downloadUpdate(cancellationToken)`](#module_electron-updater/out/AppUpdater.AppUpdater+downloadUpdate) ⇒ Promise + * [`.getFeedURL()`](#module_electron-updater/out/AppUpdater.AppUpdater+getFeedURL) ⇒ + * [`.setFeedURL(options)`](#module_electron-updater/out/AppUpdater.AppUpdater+setFeedURL) + * [`.loadUpdateConfig()`](#module_electron-updater/out/AppUpdater.AppUpdater+loadUpdateConfig) ⇒ Promise + * [`.dispatchError(e)`](#module_electron-updater/out/AppUpdater.AppUpdater+dispatchError) + + +- + + + +#### `macUpdater.quitAndInstall()` +**Kind**: instance method of [MacUpdater](#module_electron-updater/out/MacUpdater.MacUpdater) +**Overrides**: [quitAndInstall](#module_electron-updater/out/AppUpdater.AppUpdater+quitAndInstall) + +- + + + +#### `macUpdater.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)` ⇒ module:bluebird-lst.Bluebird +**Kind**: instance method of [MacUpdater](#module_electron-updater/out/MacUpdater.MacUpdater) +**Overrides**: [doDownloadUpdate](#module_electron-updater/out/AppUpdater.AppUpdater+doDownloadUpdate) +**Access**: protected + +| Param | Type | +| --- | --- | +| versionInfo | [VersionInfo](#module_electron-builder-http/out/publishOptions.VersionInfo) | +| fileInfo | [FileInfo](#module_electron-updater/out/api.FileInfo) | +| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | + + +- + + + +#### `macUpdater.onUpdateAvailable(versionInfo, fileInfo)` +**Kind**: instance method of [MacUpdater](#module_electron-updater/out/MacUpdater.MacUpdater) +**Overrides**: [onUpdateAvailable](#module_electron-updater/out/AppUpdater.AppUpdater+onUpdateAvailable) +**Access**: protected + +| Param | Type | +| --- | --- | +| versionInfo | [VersionInfo](#module_electron-builder-http/out/publishOptions.VersionInfo) | +| fileInfo | [FileInfo](#module_electron-updater/out/api.FileInfo) | + + +- + + + +#### `macUpdater.checkForUpdates()` ⇒ Promise +**Kind**: instance method of [MacUpdater](#module_electron-updater/out/MacUpdater.MacUpdater) + +- + + + +#### `macUpdater.downloadUpdate(cancellationToken)` ⇒ Promise +Start downloading update manually. You can use this method if `autoDownload` option is set to `false`. + +**Kind**: instance method of [MacUpdater](#module_electron-updater/out/MacUpdater.MacUpdater) +**Returns**: Promise - Path to downloaded file. + +| Param | Type | +| --- | --- | +| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | + + +- + + + +#### `macUpdater.getFeedURL()` ⇒ +**Kind**: instance method of [MacUpdater](#module_electron-updater/out/MacUpdater.MacUpdater) + +- + + + +#### `macUpdater.setFeedURL(options)` +Configure update provider. If value is `string`, [GenericServerOptions](#module_electron-builder-http/out/publishOptions.GenericServerOptions) will be set with value as `url`. + +**Kind**: instance method of [MacUpdater](#module_electron-updater/out/MacUpdater.MacUpdater) + +| Param | Type | Description | +| --- | --- | --- | +| options | [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) | [GenericServerOptions](#module_electron-builder-http/out/publishOptions.GenericServerOptions) | [S3Options](#module_electron-builder-http/out/publishOptions.S3Options) | [BintrayOptions](#module_electron-builder-http/out/publishOptions.BintrayOptions) | [GithubOptions](#module_electron-builder-http/out/publishOptions.GithubOptions) | string | If you want to override configuration in the `app-update.yml`. | + + +- + + + +#### `macUpdater.loadUpdateConfig()` ⇒ Promise +**Kind**: instance method of [MacUpdater](#module_electron-updater/out/MacUpdater.MacUpdater) + +- + + + +#### `macUpdater.dispatchError(e)` +**Kind**: instance method of [MacUpdater](#module_electron-updater/out/MacUpdater.MacUpdater) +**Access**: protected + +| Param | Type | +| --- | --- | +| e | Error | + + +- + + + +## electron-updater/out/NsisUpdater + +* [electron-updater/out/NsisUpdater](#module_electron-updater/out/NsisUpdater) + * [.NsisUpdater](#module_electron-updater/out/NsisUpdater.NsisUpdater) ⇐ [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) + * [`.quitAndInstall()`](#module_electron-updater/out/NsisUpdater.NsisUpdater+quitAndInstall) + * [`.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)`](#module_electron-updater/out/NsisUpdater.NsisUpdater+doDownloadUpdate) ⇒ Promise + * [`.checkForUpdates()`](#module_electron-updater/out/AppUpdater.AppUpdater+checkForUpdates) ⇒ Promise + * [`.downloadUpdate(cancellationToken)`](#module_electron-updater/out/AppUpdater.AppUpdater+downloadUpdate) ⇒ Promise + * [`.getFeedURL()`](#module_electron-updater/out/AppUpdater.AppUpdater+getFeedURL) ⇒ + * [`.setFeedURL(options)`](#module_electron-updater/out/AppUpdater.AppUpdater+setFeedURL) + * [`.loadUpdateConfig()`](#module_electron-updater/out/AppUpdater.AppUpdater+loadUpdateConfig) ⇒ Promise + * [`.dispatchError(e)`](#module_electron-updater/out/AppUpdater.AppUpdater+dispatchError) + * [`.onUpdateAvailable(versionInfo, fileInfo)`](#module_electron-updater/out/AppUpdater.AppUpdater+onUpdateAvailable) + + +- + + + +### electron-updater/out/NsisUpdater.NsisUpdater ⇐ [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) +**Kind**: class of [electron-updater/out/NsisUpdater](#module_electron-updater/out/NsisUpdater) +**Extends**: [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) + +* [.NsisUpdater](#module_electron-updater/out/NsisUpdater.NsisUpdater) ⇐ [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) + * [`.quitAndInstall()`](#module_electron-updater/out/NsisUpdater.NsisUpdater+quitAndInstall) + * [`.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)`](#module_electron-updater/out/NsisUpdater.NsisUpdater+doDownloadUpdate) ⇒ Promise + * [`.checkForUpdates()`](#module_electron-updater/out/AppUpdater.AppUpdater+checkForUpdates) ⇒ Promise + * [`.downloadUpdate(cancellationToken)`](#module_electron-updater/out/AppUpdater.AppUpdater+downloadUpdate) ⇒ Promise + * [`.getFeedURL()`](#module_electron-updater/out/AppUpdater.AppUpdater+getFeedURL) ⇒ + * [`.setFeedURL(options)`](#module_electron-updater/out/AppUpdater.AppUpdater+setFeedURL) + * [`.loadUpdateConfig()`](#module_electron-updater/out/AppUpdater.AppUpdater+loadUpdateConfig) ⇒ Promise + * [`.dispatchError(e)`](#module_electron-updater/out/AppUpdater.AppUpdater+dispatchError) + * [`.onUpdateAvailable(versionInfo, fileInfo)`](#module_electron-updater/out/AppUpdater.AppUpdater+onUpdateAvailable) + + +- + + + +#### `nsisUpdater.quitAndInstall()` +**Kind**: instance method of [NsisUpdater](#module_electron-updater/out/NsisUpdater.NsisUpdater) +**Overrides**: [quitAndInstall](#module_electron-updater/out/AppUpdater.AppUpdater+quitAndInstall) + +- + + + +#### `nsisUpdater.doDownloadUpdate(versionInfo, fileInfo, cancellationToken)` ⇒ Promise +Start downloading update manually. You can use this method if `autoDownload` option is set to `false`. + +**Kind**: instance method of [NsisUpdater](#module_electron-updater/out/NsisUpdater.NsisUpdater) +**Overrides**: [doDownloadUpdate](#module_electron-updater/out/AppUpdater.AppUpdater+doDownloadUpdate) +**Returns**: Promise - Path to downloaded file. +**Access**: protected + +| Param | Type | +| --- | --- | +| versionInfo | [VersionInfo](#module_electron-builder-http/out/publishOptions.VersionInfo) | +| fileInfo | [FileInfo](#module_electron-updater/out/api.FileInfo) | +| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | + + +- + + + +#### `nsisUpdater.checkForUpdates()` ⇒ Promise +**Kind**: instance method of [NsisUpdater](#module_electron-updater/out/NsisUpdater.NsisUpdater) + +- + + + +#### `nsisUpdater.downloadUpdate(cancellationToken)` ⇒ Promise +Start downloading update manually. You can use this method if `autoDownload` option is set to `false`. + +**Kind**: instance method of [NsisUpdater](#module_electron-updater/out/NsisUpdater.NsisUpdater) +**Returns**: Promise - Path to downloaded file. + +| Param | Type | +| --- | --- | +| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | + + +- + + + +#### `nsisUpdater.getFeedURL()` ⇒ +**Kind**: instance method of [NsisUpdater](#module_electron-updater/out/NsisUpdater.NsisUpdater) + +- + + + +#### `nsisUpdater.setFeedURL(options)` +Configure update provider. If value is `string`, [GenericServerOptions](#module_electron-builder-http/out/publishOptions.GenericServerOptions) will be set with value as `url`. + +**Kind**: instance method of [NsisUpdater](#module_electron-updater/out/NsisUpdater.NsisUpdater) + +| Param | Type | Description | +| --- | --- | --- | +| options | [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) | [GenericServerOptions](#module_electron-builder-http/out/publishOptions.GenericServerOptions) | [S3Options](#module_electron-builder-http/out/publishOptions.S3Options) | [BintrayOptions](#module_electron-builder-http/out/publishOptions.BintrayOptions) | [GithubOptions](#module_electron-builder-http/out/publishOptions.GithubOptions) | string | If you want to override configuration in the `app-update.yml`. | + + +- + + + +#### `nsisUpdater.loadUpdateConfig()` ⇒ Promise +**Kind**: instance method of [NsisUpdater](#module_electron-updater/out/NsisUpdater.NsisUpdater) + +- + + + +#### `nsisUpdater.dispatchError(e)` +**Kind**: instance method of [NsisUpdater](#module_electron-updater/out/NsisUpdater.NsisUpdater) +**Access**: protected + +| Param | Type | +| --- | --- | +| e | Error | + + +- + + + +#### `nsisUpdater.onUpdateAvailable(versionInfo, fileInfo)` +**Kind**: instance method of [NsisUpdater](#module_electron-updater/out/NsisUpdater.NsisUpdater) +**Access**: protected + +| Param | Type | +| --- | --- | +| versionInfo | [VersionInfo](#module_electron-builder-http/out/publishOptions.VersionInfo) | +| fileInfo | [FileInfo](#module_electron-updater/out/api.FileInfo) | + + +- + + + +## electron-updater/out/api + +* [electron-updater/out/api](#module_electron-updater/out/api) + * [`.FileInfo`](#module_electron-updater/out/api.FileInfo) + * [`.UpdateCheckResult`](#module_electron-updater/out/api.UpdateCheckResult) + * [.Provider](#module_electron-updater/out/api.Provider) + * [`.getLatestVersion()`](#module_electron-updater/out/api.Provider+getLatestVersion) ⇒ Promise + * [`.setRequestHeaders(value)`](#module_electron-updater/out/api.Provider+setRequestHeaders) + * [`.getUpdateFile(versionInfo)`](#module_electron-updater/out/api.Provider+getUpdateFile) ⇒ Promise + * [.UpdaterSignal](#module_electron-updater/out/api.UpdaterSignal) + * [`.progress(handler)`](#module_electron-updater/out/api.UpdaterSignal+progress) + * [`.updateCancelled(handler)`](#module_electron-updater/out/api.UpdaterSignal+updateCancelled) + * [`.updateDownloaded(handler)`](#module_electron-updater/out/api.UpdaterSignal+updateDownloaded) + * [`.getDefaultChannelName()`](#module_electron-updater/out/api.getDefaultChannelName) ⇒ string + * [`.getCustomChannelName(channel)`](#module_electron-updater/out/api.getCustomChannelName) ⇒ string + * [`.getCurrentPlatform()`](#module_electron-updater/out/api.getCurrentPlatform) ⇒ + * [`.getChannelFilename(channel)`](#module_electron-updater/out/api.getChannelFilename) ⇒ string + + +- + + + +### `electron-updater/out/api.FileInfo` +**Kind**: interface of [electron-updater/out/api](#module_electron-updater/out/api) +**Properties** + +| Name | Type | +| --- | --- | +| name | string | +| url | string | +| sha2 | string | + + +- + + + +### `electron-updater/out/api.UpdateCheckResult` +**Kind**: interface of [electron-updater/out/api](#module_electron-updater/out/api) +**Properties** + +| Name | Type | +| --- | --- | +| versionInfo | [VersionInfo](#module_electron-builder-http/out/publishOptions.VersionInfo) | +| fileInfo | [FileInfo](#module_electron-updater/out/api.FileInfo) | +| downloadPromise | Promise | null | +| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | + + +- + + + +### electron-updater/out/api.Provider +**Kind**: class of [electron-updater/out/api](#module_electron-updater/out/api) + +* [.Provider](#module_electron-updater/out/api.Provider) + * [`.getLatestVersion()`](#module_electron-updater/out/api.Provider+getLatestVersion) ⇒ Promise + * [`.setRequestHeaders(value)`](#module_electron-updater/out/api.Provider+setRequestHeaders) + * [`.getUpdateFile(versionInfo)`](#module_electron-updater/out/api.Provider+getUpdateFile) ⇒ Promise + + +- + + + +#### `provider.getLatestVersion()` ⇒ Promise +**Kind**: instance method of [Provider](#module_electron-updater/out/api.Provider) + +- + + + +#### `provider.setRequestHeaders(value)` +**Kind**: instance method of [Provider](#module_electron-updater/out/api.Provider) + +| Param | Type | +| --- | --- | +| value | [RequestHeaders](#module_electron-builder-http.RequestHeaders) | null | + + +- + + + +#### `provider.getUpdateFile(versionInfo)` ⇒ Promise +**Kind**: instance method of [Provider](#module_electron-updater/out/api.Provider) + +| Param | Type | +| --- | --- | +| versionInfo | module:electron-updater/out/api.T | + + +- + + + +### electron-updater/out/api.UpdaterSignal +**Kind**: class of [electron-updater/out/api](#module_electron-updater/out/api) + +* [.UpdaterSignal](#module_electron-updater/out/api.UpdaterSignal) + * [`.progress(handler)`](#module_electron-updater/out/api.UpdaterSignal+progress) + * [`.updateCancelled(handler)`](#module_electron-updater/out/api.UpdaterSignal+updateCancelled) + * [`.updateDownloaded(handler)`](#module_electron-updater/out/api.UpdaterSignal+updateDownloaded) + + +- + + + +#### `updaterSignal.progress(handler)` +**Kind**: instance method of [UpdaterSignal](#module_electron-updater/out/api.UpdaterSignal) + +| Param | Type | +| --- | --- | +| handler | callback | + + +- + + + +#### `updaterSignal.updateCancelled(handler)` +**Kind**: instance method of [UpdaterSignal](#module_electron-updater/out/api.UpdaterSignal) + +| Param | Type | +| --- | --- | +| handler | callback | + + +- + + + +#### `updaterSignal.updateDownloaded(handler)` +**Kind**: instance method of [UpdaterSignal](#module_electron-updater/out/api.UpdaterSignal) + +| Param | Type | +| --- | --- | +| handler | callback | + + +- + + + +### `electron-updater/out/api.getDefaultChannelName()` ⇒ string +**Kind**: method of [electron-updater/out/api](#module_electron-updater/out/api) + +- + + + +### `electron-updater/out/api.getCustomChannelName(channel)` ⇒ string +**Kind**: method of [electron-updater/out/api](#module_electron-updater/out/api) + +| Param | Type | +| --- | --- | +| channel | string | + + +- + + + +### `electron-updater/out/api.getCurrentPlatform()` ⇒ +**Kind**: method of [electron-updater/out/api](#module_electron-updater/out/api) + +- + + + +### `electron-updater/out/api.getChannelFilename(channel)` ⇒ string +**Kind**: method of [electron-updater/out/api](#module_electron-updater/out/api) + +| Param | Type | +| --- | --- | +| channel | string | + + +- + + + +## electron-updater/out/electronHttpExecutor + +* [electron-updater/out/electronHttpExecutor](#module_electron-updater/out/electronHttpExecutor) + * [.ElectronHttpExecutor](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor) ⇐ [HttpExecutor](#module_electron-builder-http.HttpExecutor) + * [`.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+doApiRequest) ⇒ Promise + * [`.download(url, destination, options)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+download) ⇒ Promise + * [`.doRequest(options, callback)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+doRequest) ⇒ + * [`.request(options, cancellationToken, data)`](#module_electron-builder-http.HttpExecutor+request) ⇒ Promise + * [`.addTimeOutHandler(request, callback)`](#module_electron-builder-http.HttpExecutor+addTimeOutHandler) + * [`.doDownload(requestOptions, destination, redirectCount, options, callback, onCancel)`](#module_electron-builder-http.HttpExecutor+doDownload) + * [`.handleResponse(response, options, cancellationToken, resolve, reject, redirectCount, requestProcessor)`](#module_electron-builder-http.HttpExecutor+handleResponse) + + +- + + + +### electron-updater/out/electronHttpExecutor.ElectronHttpExecutor ⇐ [HttpExecutor](#module_electron-builder-http.HttpExecutor) +**Kind**: class of [electron-updater/out/electronHttpExecutor](#module_electron-updater/out/electronHttpExecutor) +**Extends**: [HttpExecutor](#module_electron-builder-http.HttpExecutor) + +* [.ElectronHttpExecutor](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor) ⇐ [HttpExecutor](#module_electron-builder-http.HttpExecutor) + * [`.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+doApiRequest) ⇒ Promise + * [`.download(url, destination, options)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+download) ⇒ Promise + * [`.doRequest(options, callback)`](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor+doRequest) ⇒ + * [`.request(options, cancellationToken, data)`](#module_electron-builder-http.HttpExecutor+request) ⇒ Promise + * [`.addTimeOutHandler(request, callback)`](#module_electron-builder-http.HttpExecutor+addTimeOutHandler) + * [`.doDownload(requestOptions, destination, redirectCount, options, callback, onCancel)`](#module_electron-builder-http.HttpExecutor+doDownload) + * [`.handleResponse(response, options, cancellationToken, resolve, reject, redirectCount, requestProcessor)`](#module_electron-builder-http.HttpExecutor+handleResponse) + + +- + + + +#### `electronHttpExecutor.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)` ⇒ Promise +**Kind**: instance method of [ElectronHttpExecutor](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor) +**Overrides**: [doApiRequest](#module_electron-builder-http.HttpExecutor+doApiRequest) + +| Param | Type | +| --- | --- | +| options | Electron:RequestOptions | +| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | +| requestProcessor | callback | +| redirectCount | number | + + +- + + + +#### `electronHttpExecutor.download(url, destination, options)` ⇒ Promise +**Kind**: instance method of [ElectronHttpExecutor](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor) +**Overrides**: [download](#module_electron-builder-http.HttpExecutor+download) + +| Param | Type | +| --- | --- | +| url | string | +| destination | string | +| options | [DownloadOptions](#module_electron-builder-http.DownloadOptions) | + + +- + + + +#### `electronHttpExecutor.doRequest(options, callback)` ⇒ +**Kind**: instance method of [ElectronHttpExecutor](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor) +**Overrides**: [doRequest](#module_electron-builder-http.HttpExecutor+doRequest) +**Access**: protected + +| Param | Type | +| --- | --- | +| options | | +| callback | callback | + + +- + + + +#### `electronHttpExecutor.request(options, cancellationToken, data)` ⇒ Promise +**Kind**: instance method of [ElectronHttpExecutor](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor) + +| Param | Type | +| --- | --- | +| options | module:http.RequestOptions | +| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | +| data | module:electron-builder-http.__type | null | + + +- + + + +#### `electronHttpExecutor.addTimeOutHandler(request, callback)` +**Kind**: instance method of [ElectronHttpExecutor](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor) +**Access**: protected + +| Param | Type | +| --- | --- | +| request | | +| callback | callback | + + +- + + + +#### `electronHttpExecutor.doDownload(requestOptions, destination, redirectCount, options, callback, onCancel)` +**Kind**: instance method of [ElectronHttpExecutor](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor) +**Access**: protected + +| Param | Type | +| --- | --- | +| requestOptions | | +| destination | string | +| redirectCount | number | +| options | [DownloadOptions](#module_electron-builder-http.DownloadOptions) | +| callback | callback | +| onCancel | callback | + + +- + + + +#### `electronHttpExecutor.handleResponse(response, options, cancellationToken, resolve, reject, redirectCount, requestProcessor)` +**Kind**: instance method of [ElectronHttpExecutor](#module_electron-updater/out/electronHttpExecutor.ElectronHttpExecutor) +**Access**: protected + +| Param | Type | +| --- | --- | +| response | [Response](#module_electron-builder-http.Response) | +| options | module:http.RequestOptions | +| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | +| resolve | callback | +| reject | callback | +| redirectCount | number | +| requestProcessor | callback | + + +- + + + +## electron-updater + +- + + + +### `electron-updater.autoUpdater` : [AppUpdater](#module_electron-updater/out/AppUpdater.AppUpdater) +**Kind**: constant of [electron-updater](#module_electron-updater) + +- + + + +## electron-builder-http/out/CancellationToken + +* [electron-builder-http/out/CancellationToken](#module_electron-builder-http/out/CancellationToken) + * [.CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) ⇐ internal:EventEmitter + * [`.cancel()`](#module_electron-builder-http/out/CancellationToken.CancellationToken+cancel) + * [`.createPromise(callback)`](#module_electron-builder-http/out/CancellationToken.CancellationToken+createPromise) ⇒ Promise + * [`.dispose()`](#module_electron-builder-http/out/CancellationToken.CancellationToken+dispose) + * [.CancellationError](#module_electron-builder-http/out/CancellationToken.CancellationError) ⇐ Error + + +- + + + +### electron-builder-http/out/CancellationToken.CancellationToken ⇐ internal:EventEmitter +**Kind**: class of [electron-builder-http/out/CancellationToken](#module_electron-builder-http/out/CancellationToken) +**Extends**: internal:EventEmitter + +* [.CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) ⇐ internal:EventEmitter + * [`.cancel()`](#module_electron-builder-http/out/CancellationToken.CancellationToken+cancel) + * [`.createPromise(callback)`](#module_electron-builder-http/out/CancellationToken.CancellationToken+createPromise) ⇒ Promise + * [`.dispose()`](#module_electron-builder-http/out/CancellationToken.CancellationToken+dispose) + + +- + + + +#### `cancellationToken.cancel()` +**Kind**: instance method of [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) + +- + + + +#### `cancellationToken.createPromise(callback)` ⇒ Promise +**Kind**: instance method of [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) + +| Param | Type | +| --- | --- | +| callback | callback | + + +- + + + +#### `cancellationToken.dispose()` +**Kind**: instance method of [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) + +- + + + +### electron-builder-http/out/CancellationToken.CancellationError ⇐ Error +**Kind**: class of [electron-builder-http/out/CancellationToken](#module_electron-builder-http/out/CancellationToken) +**Extends**: Error + +- + + + +## electron-builder-http/out/ProgressCallbackTransform + +* [electron-builder-http/out/ProgressCallbackTransform](#module_electron-builder-http/out/ProgressCallbackTransform) + * [`.ProgressInfo`](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressInfo) + * [.ProgressCallbackTransform](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform) ⇐ internal:Transform + * [`._flush(callback)`](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform+_flush) + * [`._transform(chunk, encoding, callback)`](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform+_transform) + + +- + + + +### `electron-builder-http/out/ProgressCallbackTransform.ProgressInfo` +**Kind**: interface of [electron-builder-http/out/ProgressCallbackTransform](#module_electron-builder-http/out/ProgressCallbackTransform) +**Properties** + +| Name | Type | +| --- | --- | +| total | number | +| delta | number | +| transferred | number | +| percent | number | +| bytesPerSecond | number | + + +- + + + +### electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform ⇐ internal:Transform +**Kind**: class of [electron-builder-http/out/ProgressCallbackTransform](#module_electron-builder-http/out/ProgressCallbackTransform) +**Extends**: internal:Transform + +* [.ProgressCallbackTransform](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform) ⇐ internal:Transform + * [`._flush(callback)`](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform+_flush) + * [`._transform(chunk, encoding, callback)`](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform+_transform) + + +- + + + +#### `progressCallbackTransform._flush(callback)` +**Kind**: instance method of [ProgressCallbackTransform](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform) + +| Param | Type | +| --- | --- | +| callback | function | + + +- + + + +#### `progressCallbackTransform._transform(chunk, encoding, callback)` +**Kind**: instance method of [ProgressCallbackTransform](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressCallbackTransform) + +| Param | Type | +| --- | --- | +| chunk | | +| encoding | string | +| callback | function | + + +- + + + +## electron-builder-http/out/bintray + +* [electron-builder-http/out/bintray](#module_electron-builder-http/out/bintray) + * [`.Version`](#module_electron-builder-http/out/bintray.Version) + * [`.File`](#module_electron-builder-http/out/bintray.File) + * [.BintrayClient](#module_electron-builder-http/out/bintray.BintrayClient) + * [`.createVersion(version)`](#module_electron-builder-http/out/bintray.BintrayClient+createVersion) ⇒ Promise + * [`.deleteVersion(version)`](#module_electron-builder-http/out/bintray.BintrayClient+deleteVersion) ⇒ Promise + * [`.getVersion(version)`](#module_electron-builder-http/out/bintray.BintrayClient+getVersion) ⇒ Promise + * [`.getVersionFiles(version)`](#module_electron-builder-http/out/bintray.BintrayClient+getVersionFiles) ⇒ Promise + * [`.bintrayRequest(path, auth, data, cancellationToken, method)`](#module_electron-builder-http/out/bintray.bintrayRequest) ⇒ Promise + + +- + + + +### `electron-builder-http/out/bintray.Version` +**Kind**: interface of [electron-builder-http/out/bintray](#module_electron-builder-http/out/bintray) +**Properties** + +| Name | Type | +| --- | --- | +| name | string | +| package | string | + + +- + + + +### `electron-builder-http/out/bintray.File` +**Kind**: interface of [electron-builder-http/out/bintray](#module_electron-builder-http/out/bintray) +**Properties** + +| Name | Type | +| --- | --- | +| name | string | +| path | string | +| sha1 | string | +| sha256 | string | + + +- + + + +### electron-builder-http/out/bintray.BintrayClient +**Kind**: class of [electron-builder-http/out/bintray](#module_electron-builder-http/out/bintray) + +* [.BintrayClient](#module_electron-builder-http/out/bintray.BintrayClient) + * [`.createVersion(version)`](#module_electron-builder-http/out/bintray.BintrayClient+createVersion) ⇒ Promise + * [`.deleteVersion(version)`](#module_electron-builder-http/out/bintray.BintrayClient+deleteVersion) ⇒ Promise + * [`.getVersion(version)`](#module_electron-builder-http/out/bintray.BintrayClient+getVersion) ⇒ Promise + * [`.getVersionFiles(version)`](#module_electron-builder-http/out/bintray.BintrayClient+getVersionFiles) ⇒ Promise + + +- + + + +#### `bintrayClient.createVersion(version)` ⇒ Promise +**Kind**: instance method of [BintrayClient](#module_electron-builder-http/out/bintray.BintrayClient) + +| Param | Type | +| --- | --- | +| version | string | + + +- + + + +#### `bintrayClient.deleteVersion(version)` ⇒ Promise +**Kind**: instance method of [BintrayClient](#module_electron-builder-http/out/bintray.BintrayClient) + +| Param | Type | +| --- | --- | +| version | string | + + +- + + + +#### `bintrayClient.getVersion(version)` ⇒ Promise +**Kind**: instance method of [BintrayClient](#module_electron-builder-http/out/bintray.BintrayClient) + +| Param | Type | +| --- | --- | +| version | string | + + +- + + + +#### `bintrayClient.getVersionFiles(version)` ⇒ Promise +**Kind**: instance method of [BintrayClient](#module_electron-builder-http/out/bintray.BintrayClient) + +| Param | Type | +| --- | --- | +| version | string | + + +- + + + +### `electron-builder-http/out/bintray.bintrayRequest(path, auth, data, cancellationToken, method)` ⇒ Promise +**Kind**: method of [electron-builder-http/out/bintray](#module_electron-builder-http/out/bintray) + +| Param | Type | +| --- | --- | +| path | string | +| auth | string | null | +| data | module:electron-builder-http/out/bintray.__type | null | +| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | +| method | "GET" | "DELETE" | "PUT" | + + +- + + + +## electron-builder-http/out/publishOptions + +* [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) + * [`.PublishConfiguration`](#module_electron-builder-http/out/publishOptions.PublishConfiguration) + * [`.GenericServerOptions`](#module_electron-builder-http/out/publishOptions.GenericServerOptions) ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) + * [`.S3Options`](#module_electron-builder-http/out/publishOptions.S3Options) ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) + * [`.VersionInfo`](#module_electron-builder-http/out/publishOptions.VersionInfo) + * [`.UpdateInfo`](#module_electron-builder-http/out/publishOptions.UpdateInfo) ⇐ [VersionInfo](#module_electron-builder-http/out/publishOptions.VersionInfo) + * [`.GithubOptions`](#module_electron-builder-http/out/publishOptions.GithubOptions) ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) + * [`.BintrayOptions`](#module_electron-builder-http/out/publishOptions.BintrayOptions) ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) + * [`.s3Url(options)`](#module_electron-builder-http/out/publishOptions.s3Url) ⇒ string + * [`.githubUrl(options)`](#module_electron-builder-http/out/publishOptions.githubUrl) ⇒ string + + +- + + + +### `electron-builder-http/out/publishOptions.PublishConfiguration` +Can be specified in the [config](https://github.com/electron-userland/electron-builder/wiki/Options#configuration-options) or any platform- or target- specific options. + +If `GH_TOKEN` is set — defaults to `[{provider: "github"}]`. + +If `BT_TOKEN` is set and `GH_TOKEN` is not set — defaults to `[{provider: "bintray"}]`. + +**Kind**: interface of [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) +**Properties** + +| Name | Type | Description | +| --- | --- | --- | +| provider | github | bintray | s3 | generic | The provider. | +| owner | string | null | The owner. | +| token | string | null | | + + +- + + + +### `electron-builder-http/out/publishOptions.GenericServerOptions` ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) +Generic (any HTTP(S) server) options. + +**Kind**: interface of [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) +**Extends**: [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) +**Properties** + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| url | string | | The base url. e.g. `https://bucket_name.s3.amazonaws.com`. You can use `${os}` (expanded to `mac`, `linux` or `win` according to target platform) and `${arch}` macros. | +| channel | string | null | "latest" | The channel. | + + +- + + + +### `electron-builder-http/out/publishOptions.S3Options` ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) +Amazon S3 options. `https` must be used, so, if you use direct Amazon S3 endpoints, format `https://s3.amazonaws.com/bucket_name` [must be used](http://stackoverflow.com/a/11203685/1910191). And do not forget to make files/directories public. + +**Kind**: interface of [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) +**Extends**: [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) +**See**: [Getting your credentials](http://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/getting-your-credentials.html). +**Properties** + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| bucket | string | | The bucket name. | +| path | string | null | "/" | The directory path. | +| channel | string | null | "latest" | The channel. | +| acl | "private" | "public-read" | null | public-read | The ACL. | +| storageClass | "STANDARD" | "REDUCED_REDUNDANCY" | "STANDARD_IA" | null | STANDARD | The type of storage to use for the object. | + + +- + + + +### `electron-builder-http/out/publishOptions.VersionInfo` +**Kind**: interface of [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) +**Properties** + +| Name | Type | +| --- | --- | +| version | string | + + +- + + + +### `electron-builder-http/out/publishOptions.UpdateInfo` ⇐ [VersionInfo](#module_electron-builder-http/out/publishOptions.VersionInfo) +**Kind**: interface of [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) +**Extends**: [VersionInfo](#module_electron-builder-http/out/publishOptions.VersionInfo) +**Properties** + +| Name | Type | +| --- | --- | +| path | string | +| githubArtifactName | string | null | +| sha2 | string | +| releaseName | string | null | +| releaseNotes | string | null | +| releaseDate | string | + + +- + + + +### `electron-builder-http/out/publishOptions.GithubOptions` ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) +GitHub options. + +**Kind**: interface of [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) +**Extends**: [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) +**Properties** + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| repo | string | null | | The repository name. [Detected automatically](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts#github-repository). | +| vPrefixedTagName | boolean | true | Whether to use `v`-prefixed tag name. | +| host | string | null | "github.com" | The host (including the port if need). | +| protocol | "https" | "http" | null | https | The protocol. GitHub Publisher supports only `https`. | + + +- + + + +### `electron-builder-http/out/publishOptions.BintrayOptions` ⇐ [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) +### `publish` Bintray + +**Kind**: interface of [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) +**Extends**: [PublishConfiguration](#module_electron-builder-http/out/publishOptions.PublishConfiguration) +**Properties** + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| package | string | null | | The Bintray package name. | +| repo | string | null | "generic" | The Bintray repository name. | +| user | string | null | | The Bintray user account. Used in cases where the owner is an organization. | + + +- + + + +### `electron-builder-http/out/publishOptions.s3Url(options)` ⇒ string +**Kind**: method of [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) + +| Param | Type | +| --- | --- | +| options | [S3Options](#module_electron-builder-http/out/publishOptions.S3Options) | + + +- + + + +### `electron-builder-http/out/publishOptions.githubUrl(options)` ⇒ string +**Kind**: method of [electron-builder-http/out/publishOptions](#module_electron-builder-http/out/publishOptions) + +| Param | Type | +| --- | --- | +| options | [GithubOptions](#module_electron-builder-http/out/publishOptions.GithubOptions) | + + +- + + + +## electron-builder-http + +* [electron-builder-http](#module_electron-builder-http) + * [`.RequestHeaders`](#module_electron-builder-http.RequestHeaders) + * [`.Response`](#module_electron-builder-http.Response) ⇐ internal:EventEmitter + * [`.setEncoding(encoding)`](#module_electron-builder-http.Response+setEncoding) + * [`.DownloadOptions`](#module_electron-builder-http.DownloadOptions) + * [`.onProgress(progress)`](#module_electron-builder-http.DownloadOptions+onProgress) + * [.HttpExecutorHolder](#module_electron-builder-http.HttpExecutorHolder) + * [.HttpError](#module_electron-builder-http.HttpError) ⇐ Error + * [.HttpExecutor](#module_electron-builder-http.HttpExecutor) + * [`.download(url, destination, options)`](#module_electron-builder-http.HttpExecutor+download) ⇒ Promise + * [`.request(options, cancellationToken, data)`](#module_electron-builder-http.HttpExecutor+request) ⇒ Promise + * [`.addTimeOutHandler(request, callback)`](#module_electron-builder-http.HttpExecutor+addTimeOutHandler) + * [`.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)`](#module_electron-builder-http.HttpExecutor+doApiRequest) ⇒ Promise + * [`.doDownload(requestOptions, destination, redirectCount, options, callback, onCancel)`](#module_electron-builder-http.HttpExecutor+doDownload) + * [`.doRequest(options, callback)`](#module_electron-builder-http.HttpExecutor+doRequest) ⇒ + * [`.handleResponse(response, options, cancellationToken, resolve, reject, redirectCount, requestProcessor)`](#module_electron-builder-http.HttpExecutor+handleResponse) + * [`.download(url, destination, options)`](#module_electron-builder-http.download) ⇒ Promise + * [`.request(options, cancellationToken, data)`](#module_electron-builder-http.request) ⇒ Promise + * [`.configureRequestOptions(options, token, method)`](#module_electron-builder-http.configureRequestOptions) ⇒ module:http.RequestOptions + * [`.dumpRequestOptions(options)`](#module_electron-builder-http.dumpRequestOptions) ⇒ string + + +- + + + +### `electron-builder-http.RequestHeaders` +**Kind**: interface of [electron-builder-http](#module_electron-builder-http) + +- + + + +### `electron-builder-http.Response` ⇐ internal:EventEmitter +**Kind**: interface of [electron-builder-http](#module_electron-builder-http) +**Extends**: internal:EventEmitter +**Properties** + +| Name | Type | +| --- | --- | +| statusCode | number | +| statusMessage | string | +| headers | | + + +- + + + +#### `response.setEncoding(encoding)` +**Kind**: instance method of [Response](#module_electron-builder-http.Response) + +| Param | Type | +| --- | --- | +| encoding | string | + + +- + + + +### `electron-builder-http.DownloadOptions` +**Kind**: interface of [electron-builder-http](#module_electron-builder-http) +**Properties** + +| Name | Type | +| --- | --- | +| headers | [RequestHeaders](#module_electron-builder-http.RequestHeaders) | null | +| skipDirCreation | boolean | +| sha2 | string | null | +| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | + + +- + + + +#### `downloadOptions.onProgress(progress)` +**Kind**: instance method of [DownloadOptions](#module_electron-builder-http.DownloadOptions) + +| Param | Type | +| --- | --- | +| progress | [ProgressInfo](#module_electron-builder-http/out/ProgressCallbackTransform.ProgressInfo) | + + +- + + + +### electron-builder-http.HttpExecutorHolder +**Kind**: class of [electron-builder-http](#module_electron-builder-http) + +- + + + +### electron-builder-http.HttpError ⇐ Error +**Kind**: class of [electron-builder-http](#module_electron-builder-http) +**Extends**: Error + +- + + + +### electron-builder-http.HttpExecutor +**Kind**: class of [electron-builder-http](#module_electron-builder-http) + +* [.HttpExecutor](#module_electron-builder-http.HttpExecutor) + * [`.download(url, destination, options)`](#module_electron-builder-http.HttpExecutor+download) ⇒ Promise + * [`.request(options, cancellationToken, data)`](#module_electron-builder-http.HttpExecutor+request) ⇒ Promise + * [`.addTimeOutHandler(request, callback)`](#module_electron-builder-http.HttpExecutor+addTimeOutHandler) + * [`.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)`](#module_electron-builder-http.HttpExecutor+doApiRequest) ⇒ Promise + * [`.doDownload(requestOptions, destination, redirectCount, options, callback, onCancel)`](#module_electron-builder-http.HttpExecutor+doDownload) + * [`.doRequest(options, callback)`](#module_electron-builder-http.HttpExecutor+doRequest) ⇒ + * [`.handleResponse(response, options, cancellationToken, resolve, reject, redirectCount, requestProcessor)`](#module_electron-builder-http.HttpExecutor+handleResponse) + + +- + + + +#### `httpExecutor.download(url, destination, options)` ⇒ Promise +**Kind**: instance method of [HttpExecutor](#module_electron-builder-http.HttpExecutor) + +| Param | Type | +| --- | --- | +| url | string | +| destination | string | +| options | [DownloadOptions](#module_electron-builder-http.DownloadOptions) | + + +- + + + +#### `httpExecutor.request(options, cancellationToken, data)` ⇒ Promise +**Kind**: instance method of [HttpExecutor](#module_electron-builder-http.HttpExecutor) + +| Param | Type | +| --- | --- | +| options | module:http.RequestOptions | +| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | +| data | module:electron-builder-http.__type | null | + + +- + + + +#### `httpExecutor.addTimeOutHandler(request, callback)` +**Kind**: instance method of [HttpExecutor](#module_electron-builder-http.HttpExecutor) +**Access**: protected + +| Param | Type | +| --- | --- | +| request | | +| callback | callback | + + +- + + + +#### `httpExecutor.doApiRequest(options, cancellationToken, requestProcessor, redirectCount)` ⇒ Promise +**Kind**: instance method of [HttpExecutor](#module_electron-builder-http.HttpExecutor) +**Access**: protected + +| Param | Type | +| --- | --- | +| options | module:electron-builder-http.REQUEST_OPTS | +| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | +| requestProcessor | callback | +| redirectCount | number | + + +- + + + +#### `httpExecutor.doDownload(requestOptions, destination, redirectCount, options, callback, onCancel)` +**Kind**: instance method of [HttpExecutor](#module_electron-builder-http.HttpExecutor) +**Access**: protected + +| Param | Type | +| --- | --- | +| requestOptions | | +| destination | string | +| redirectCount | number | +| options | [DownloadOptions](#module_electron-builder-http.DownloadOptions) | +| callback | callback | +| onCancel | callback | + + +- + + + +#### `httpExecutor.doRequest(options, callback)` ⇒ +**Kind**: instance method of [HttpExecutor](#module_electron-builder-http.HttpExecutor) +**Access**: protected + +| Param | Type | +| --- | --- | +| options | | +| callback | callback | + + +- + + + +#### `httpExecutor.handleResponse(response, options, cancellationToken, resolve, reject, redirectCount, requestProcessor)` +**Kind**: instance method of [HttpExecutor](#module_electron-builder-http.HttpExecutor) +**Access**: protected + +| Param | Type | +| --- | --- | +| response | [Response](#module_electron-builder-http.Response) | +| options | module:http.RequestOptions | +| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | +| resolve | callback | +| reject | callback | +| redirectCount | number | +| requestProcessor | callback | + + +- + + + +### `electron-builder-http.download(url, destination, options)` ⇒ Promise +**Kind**: method of [electron-builder-http](#module_electron-builder-http) + +| Param | Type | +| --- | --- | +| url | string | +| destination | string | +| options | [DownloadOptions](#module_electron-builder-http.DownloadOptions) | null | + + +- + + + +### `electron-builder-http.request(options, cancellationToken, data)` ⇒ Promise +**Kind**: method of [electron-builder-http](#module_electron-builder-http) + +| Param | Type | +| --- | --- | +| options | module:http.RequestOptions | +| cancellationToken | [CancellationToken](#module_electron-builder-http/out/CancellationToken.CancellationToken) | +| data | module:electron-builder-http.__type | null | + + +- + + + +### `electron-builder-http.configureRequestOptions(options, token, method)` ⇒ module:http.RequestOptions +**Kind**: method of [electron-builder-http](#module_electron-builder-http) + +| Param | Type | +| --- | --- | +| options | module:http.RequestOptions | +| token | string | null | +| method | "GET" | "DELETE" | "PUT" | + + +- + + + +### `electron-builder-http.dumpRequestOptions(options)` ⇒ string +**Kind**: method of [electron-builder-http](#module_electron-builder-http) + +| Param | Type | +| --- | --- | +| options | module:http.RequestOptions | + + +- + diff --git a/docs/Options.md b/docs/Options.md index 7a2ea9b78a9..5a659082eac 100644 --- a/docs/Options.md +++ b/docs/Options.md @@ -133,7 +133,7 @@ You can use [file macros](#file-macros) in the `from` and `to` fields as well. | nodeGypRebuild | Whether to execute `node-gyp rebuild` before starting to package the app. Defaults to `false`. | electronDist | The path to custom Electron build (e.g. `~/electron/out/R`). Only macOS supported, file issue if need for Linux or Windows. | electronDownload | The [electron-download](https://github.com/electron-userland/electron-download#usage) options. -| publish | See [publish](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts#PublishConfiguration). +| publish | | forceCodeSigning | Whether to fail if application will be not signed (to prevent unsigned app if code signing configuration is not correct). | electronVersion | The version of electron you are packaging for. Defaults to version of `electron`, `electron-prebuilt` or `electron-prebuilt-compile` dependency. | artifactName |

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

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

diff --git a/docs/Publishing Artifacts.md b/docs/Publishing Artifacts.md index f4bfd486a27..ddead7e6bc2 100644 --- a/docs/Publishing Artifacts.md +++ b/docs/Publishing Artifacts.md @@ -58,73 +58,14 @@ But please consider using automatic rules instead of explicitly specifying `publ ## Publish Options -[publish](#PublishConfiguration) can be specified in the [configuration options](https://github.com/electron-userland/electron-builder/wiki/Options#Config) or any platform- or target- specific options. +See [GithubOptions](https://github.com/electron-userland/electron-builder/wiki/API#electron-builder-httpoutpublishoptionsgithuboptions--publishconfiguration), +[S3Options](https://github.com/electron-userland/electron-builder/wiki/API#electron-builder-httpoutpublishoptionss3options--publishconfiguration), +[BintrayOptions](https://github.com/electron-userland/electron-builder/wiki/API#module_electron-builder-http/out/publishOptions.BintrayOptions). + +Can be specified in the [configuration options](https://github.com/electron-userland/electron-builder/wiki/Options#Config) or any platform- or target- specific options. ```json "win": { "publish": ["github", "bintray"] } ``` - - -* [publish](#PublishConfiguration) -* [publish Amazon S3](#S3Options) -* [publish Bintray](#BintrayOptions) -* [publish Generic (any HTTP(S) server)](#GenericServerOptions) -* [publish GitHub](#GithubOptions) - - -### `publish` - -Can be specified in the [config](https://github.com/electron-userland/electron-builder/wiki/Options#configuration-options) or any platform- or target- specific options. - -If `GH_TOKEN` is set — defaults to `[{provider: "github"}]`. -If `BT_TOKEN` is set and `GH_TOKEN` is not set — defaults to `[{provider: "bintray"}]`. - -Array of option objects. Order is important — first item will be used as a default auto-update server on Windows (NSIS). - -Amazon S3 — `https` must be used, so, if you use direct Amazon S3 endpoints, format `https://s3.amazonaws.com/bucket_name` [must be used](http://stackoverflow.com/a/11203685/1910191). And do not forget to make files/directories public. - -| Name | Description -| --- | --- -| **provider** | The provider, one of `github`, `s3`, `bintray`, `generic`. -| owner | The owner. - - -### `publish` Amazon S3 - -[Getting your credentials](http://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/getting-your-credentials.html). - -| Name | Description -| --- | --- -| **bucket** | The bucket name. -| path | The directory path. Defaults to `/`. -| channel | The channel. Defaults to `latest`. -| acl | The ACL. Defaults to `public-read`. -| storageClass | The type of storage to use for the object. One of `STANDARD`, `REDUCED_REDUNDANCY`, `STANDARD_IA`. Defaults to `STANDARD`. - - -### `publish` Bintray -| Name | Description -| --- | --- -| package | The Bintray package name. -| repo | The Bintray repository name. Defaults to `generic`. -| user | The Bintray user account. Used in cases where the owner is an organization. - - -### `publish` Generic (any HTTP(S) server) -| Name | Description -| --- | --- -| **url** | 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 | The channel. Defaults to `latest`. - - -### `publish` GitHub -| Name | Description -| --- | --- -| repo | The repository name. [Detected automatically](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts#github-repository). -| vPrefixedTagName | Whether to use `v`-prefixed tag name. Defaults to `true`. -| host | The host (including the port if need). Defaults to `github.com`. -| protocol |

The protocol, one of https or http. Defaults to https.

GitHub Publisher supports only https.

- - diff --git a/jsdoc/jsdoc.json b/jsdoc/jsdoc.json deleted file mode 100644 index f069721e917..00000000000 --- a/jsdoc/jsdoc.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "//": "Disable sorting because JSDoc doesn't sort mutators and protected (public must be first) members correctly", - "opts": { - "template": "../node_modules/docdash", - "verbose": true - }, - "templates": { - "default": { - "outputSourceFiles": false - }, - "sort": false, - "outputSourceFiles": false - }, - "docdash": { - "static": true, - "sort": false, - "search": true, - "meta": { - "title": "electron-builder" - } - }, - "plugins": ["plugins/markdown"], - "source": { - "include": ["jsdoc/out/electron-updater", "jsdoc/out/http"] - } -} \ No newline at end of file diff --git a/jsdoc/readme.md b/jsdoc/readme.md deleted file mode 100644 index 4c48deb9a95..00000000000 --- a/jsdoc/readme.md +++ /dev/null @@ -1 +0,0 @@ -[electron-builder](http://github.com/electron-userland/electron-builder) API documentation. \ No newline at end of file diff --git a/package.json b/package.json index cfb2672a724..e7f3be13518 100644 --- a/package.json +++ b/package.json @@ -20,7 +20,8 @@ "npm-publish": "yarn compile && ./packages/npm-publish.sh && conventional-changelog -p angular -i CHANGELOG.md -s", "schema": "typescript-json-schema packages/electron-builder/tsconfig.json Config --out packages/electron-builder/scheme.json --noExtraProps --useTypeOfKeyword --strictNullChecks", "jsdoc": "ts2jsdoc packages/electron-updater packages/electron-builder-http", - "docs": "rm -rf jsdoc/out/docs && jsdoc -R jsdoc/readme.md -c jsdoc/jsdoc.json -d jsdoc/out/docs" + "docs": "jsdoc2md --files 'jsdoc/out/**/*.js' --name-format --module-index-format grouped --separators --plugin dmd-tf > docs/API.md", + "api-docs": "node ./test/vendor/yarn.js docs && node ./test/vendor/yarn.js docs" }, "//": "repository must be specified otherwise conventional-changelog will use forked repo (currently cloned)", "repository": "electron-userland/electron-builder", @@ -30,7 +31,7 @@ "ajv": "^5.0.3-beta", "ajv-keywords": "^2.0.1-beta.1", "archiver": "^1.3.0", - "aws-sdk": "^2.24.0", + "aws-sdk": "^2.25.0", "bluebird-lst": "^1.0.1", "chalk": "^1.1.3", "chromium-pickle-js": "^0.2.0", @@ -55,7 +56,7 @@ "sanitize-filename": "^1.6.1", "semver": "^5.3.0", "stat-mode": "^0.2.2", - "ts-jsdoc": "^1.0.0", + "ts-jsdoc": "^1.0.2", "tunnel-agent": "^0.6.0", "update-notifier": "^2.1.0", "uuid-1345": "^0.99.6", @@ -64,7 +65,7 @@ "devDependencies": { "@types/electron": "^1.4.33", "@types/ini": "^1.3.29", - "@types/jest": "^18.1.1", + "@types/jest": "^19.2.0", "@types/js-yaml": "^3.5.29", "@types/node-forge": "^0.6.6", "@types/source-map-support": "^0.2.28", @@ -78,12 +79,12 @@ "convert-source-map": "^1.4.0", "decompress-zip": "^0.3.0", "depcheck": "^0.6.7", - "docdash": "https://github.com/develar/docdash.git", + "dmd-tf": "^3.0.3", "electron-download-tf": "4.0.0", "jest-cli": "^19.0.2", "jest-environment-node-debug": "^2.0.0", "jest-junit": "^1.3.0", - "jsdoc": "^3.4.3", + "jsdoc-to-markdown": "^3.0.0", "path-sort": "^0.1.0", "source-map-support": "^0.4.11", "ts-babel": "^2.0.0", diff --git a/packages/electron-builder-http/src/publishOptions.ts b/packages/electron-builder-http/src/publishOptions.ts index 3d695b78dda..6d1993b7d70 100644 --- a/packages/electron-builder-http/src/publishOptions.ts +++ b/packages/electron-builder-http/src/publishOptions.ts @@ -1,78 +1,80 @@ export type PublishProvider = "github" | "bintray" | "s3" | "generic" -/** -### `publish` - -Can be specified in the [config](https://github.com/electron-userland/electron-builder/wiki/Options#configuration-options) or any platform- or target- specific options. - -If `GH_TOKEN` is set — defaults to `[{provider: "github"}]`. -If `BT_TOKEN` is set and `GH_TOKEN` is not set — defaults to `[{provider: "bintray"}]`. - -Array of option objects. Order is important — first item will be used as a default auto-update server on Windows (NSIS). +// typescript-json-schema generates only PublishConfiguration if it is specified in the list, so, it is not added here +export type AllPublishOptions = string | GithubOptions | S3Options | GenericServerOptions | BintrayOptions +// https://github.com/YousefED/typescript-json-schema/issues/80 +export type Publish = AllPublishOptions | Array | null -Amazon S3 — `https` must be used, so, if you use direct Amazon S3 endpoints, format `https://s3.amazonaws.com/bucket_name` [must be used](http://stackoverflow.com/a/11203685/1910191). And do not forget to make files/directories public. +/** + * Can be specified in the [config](https://github.com/electron-userland/electron-builder/wiki/Options#configuration-options) or any platform- or target- specific options. + * + * If `GH_TOKEN` is set — defaults to `[{provider: "github"}]`. + * + * If `BT_TOKEN` is set and `GH_TOKEN` is not set — defaults to `[{provider: "bintray"}]`. */ export interface PublishConfiguration { /** - The provider, one of `github`, `s3`, `bintray`, `generic`. + * The provider. */ - provider: PublishProvider + readonly provider: PublishProvider /** - The owner. + * The owner. */ - owner?: string | null + readonly owner?: string | null - token?: string | null + readonly token?: string | null } /** -### `publish` Generic (any HTTP(S) server) + * Generic (any HTTP(S) server) options. */ export interface GenericServerOptions extends PublishConfiguration { /** - 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. + * 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. */ - url: string + readonly url: string /** - The channel. Defaults to `latest`. + * The channel. + * @default latest */ - channel?: string | null + readonly channel?: string | null } /** -### `publish` Amazon S3 - -[Getting your credentials](http://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/getting-your-credentials.html). + * Amazon S3 options. `https` must be used, so, if you use direct Amazon S3 endpoints, format `https://s3.amazonaws.com/bucket_name` [must be used](http://stackoverflow.com/a/11203685/1910191). And do not forget to make files/directories public. + * @see [Getting your credentials](http://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/getting-your-credentials.html). */ export interface S3Options extends PublishConfiguration { /** - The bucket name. + * The bucket name. */ - bucket: string + readonly bucket: string /** - The directory path. Defaults to `/`. + * The directory path. + * @default / */ - path?: string | null + readonly path?: string | null /** - The channel. Defaults to `latest`. + * The channel. + * @default latest */ - channel?: string | null + readonly channel?: string | null /** - The ACL. Defaults to `public-read`. + * The ACL. + * @default public-read */ - acl?: "private" | "public-read" | null + readonly acl?: "private" | "public-read" | null /** - The type of storage to use for the object. One of `STANDARD`, `REDUCED_REDUNDANCY`, `STANDARD_IA`. Defaults to `STANDARD`. + * The type of storage to use for the object. + * @default STANDARD */ - storageClass?: "STANDARD" | "REDUCED_REDUNDANCY" | "STANDARD_IA" | null - - secret?: string | null + readonly storageClass?: "STANDARD" | "REDUCED_REDUNDANCY" | "STANDARD_IA" | null } export function s3Url(options: S3Options) { @@ -98,30 +100,31 @@ export interface UpdateInfo extends VersionInfo { } /** -### `publish` GitHub + * GitHub options. */ export interface GithubOptions extends PublishConfiguration { /** - The repository name. [Detected automatically](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts#github-repository). + * The repository name. [Detected automatically](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts#github-repository). */ - repo?: string | null + readonly repo?: string | null /** - Whether to use `v`-prefixed tag name. Defaults to `true`. + * Whether to use `v`-prefixed tag name. + * @default true */ - vPrefixedTagName?: boolean + readonly vPrefixedTagName?: boolean /** - The host (including the port if need). Defaults to `github.com`. + * The host (including the port if need). + * @default github.com */ - host?: string | null + readonly host?: string | null /** - The protocol, one of `https` or `http`. Defaults to `https`. - - GitHub Publisher supports only `https`. + * The protocol. GitHub Publisher supports only `https`. + * @default https */ - protocol?: string | null + readonly protocol?: "https" | "http" | null } export function githubUrl(options: GithubOptions) { @@ -129,26 +132,22 @@ export function githubUrl(options: GithubOptions) { } /** -### `publish` Bintray + * Bintray options. */ export interface BintrayOptions extends PublishConfiguration { /** - The Bintray package name. + * The Bintray package name. */ - package?: string | null + readonly package?: string | null /** - The Bintray repository name. Defaults to `generic`. + * The Bintray repository name. + * @default generic */ - repo?: string | null + readonly repo?: string | null /** - The Bintray user account. Used in cases where the owner is an organization. + * The Bintray user account. Used in cases where the owner is an organization. */ - user?: string | null -} - -// typescript-json-schema generates only PublishConfiguration if it is specified in the list, so, it is not added here -export type AllPublishOptions = string | GithubOptions | S3Options | GenericServerOptions | BintrayOptions -// https://github.com/YousefED/typescript-json-schema/issues/80 -export type Publish = AllPublishOptions | Array | null \ No newline at end of file + readonly user?: string | null +} \ No newline at end of file diff --git a/packages/electron-builder-http/tsconfig.json b/packages/electron-builder-http/tsconfig.json index 8de60a644d5..e93be8b84b1 100755 --- a/packages/electron-builder-http/tsconfig.json +++ b/packages/electron-builder-http/tsconfig.json @@ -5,7 +5,6 @@ }, "declaration": true, "jsdoc": "../../jsdoc/out/http", - "docs": "../../docs/Publishing Artifacts.md", "include": [ "src/**/*.ts" ], diff --git a/packages/electron-builder/src/metadata.ts b/packages/electron-builder/src/metadata.ts index 439ee883972..304e3b65c72 100755 --- a/packages/electron-builder/src/metadata.ts +++ b/packages/electron-builder/src/metadata.ts @@ -206,7 +206,9 @@ export interface Config extends PlatformSpecificBuildOptions, TargetSpecificOpti readonly icon?: string | null /** - See [publish](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts#PublishConfiguration). + * Array of option objects. Order is important — first item will be used as a default auto-update server on Windows (NSIS). + * + * See [publish](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts#publish-options). */ readonly publish?: Publish diff --git a/packages/electron-builder/src/publish/publisher.ts b/packages/electron-builder/src/publish/publisher.ts index c08d00256b5..2ffad6c5b53 100644 --- a/packages/electron-builder/src/publish/publisher.ts +++ b/packages/electron-builder/src/publish/publisher.ts @@ -60,24 +60,11 @@ export async function getResolvedPublishConfig(packager: BuildInfo, publishConfi } } - const copy: PublishConfiguration = Object.assign({}, publishConfig) - if (copy.owner == null) { - copy.owner = owner - } - if (provider === "github") { - const options = copy - if (options.repo == null) { - options.repo = project - } - return options + return Object.assign({owner, repo: project}, publishConfig) } else if (provider === "bintray") { - const options = copy - if (options.package == null) { - options.package = project - } - return options + return Object.assign({owner, package: project}, publishConfig) } else { throw new Error(`Unknown publish provider: ${provider}`) diff --git a/yarn.lock b/yarn.lock index 7fa03532e65..3e7049616ba 100644 --- a/yarn.lock +++ b/yarn.lock @@ -32,9 +32,9 @@ version "1.3.29" resolved "https://registry.yarnpkg.com/@types/ini/-/ini-1.3.29.tgz#1325e981e047d40d13ce0359b821475b97741d2f" -"@types/jest@^18.1.1": - version "18.1.1" - resolved "https://registry.yarnpkg.com/@types/jest/-/jest-18.1.1.tgz#6f63488c64726900885ab9cd5697bb7fa1b416cc" +"@types/jest@^19.2.0": + version "19.2.0" + resolved "https://registry.yarnpkg.com/@types/jest/-/jest-19.2.0.tgz#253ed874ba134647acde4ad7d7d2c6716609b5f8" "@types/js-yaml@^3.5.29": version "3.5.29" @@ -45,8 +45,8 @@ resolved "https://registry.yarnpkg.com/@types/node-forge/-/node-forge-0.6.6.tgz#e9707d36cc4b50bd7147b9747323d461a1089613" "@types/node@*": - version "7.0.5" - resolved "https://registry.yarnpkg.com/@types/node/-/node-7.0.5.tgz#96a0f0a618b7b606f1ec547403c00650210bfbb7" + version "7.0.7" + resolved "https://registry.yarnpkg.com/@types/node/-/node-7.0.7.tgz#92637c6c4844bfc9a0a686323e38f3e9319118c2" "@types/source-map-support@^0.2.28": version "0.2.28" @@ -122,6 +122,12 @@ ansi-align@^1.1.0: dependencies: string-width "^1.0.1" +ansi-escape-sequences@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/ansi-escape-sequences/-/ansi-escape-sequences-3.0.0.tgz#1c18394b6af9b76ff9a63509fa497669fd2ce53e" + dependencies: + array-back "^1.0.3" + ansi-escapes@^1.4.0: version "1.4.0" resolved "https://registry.yarnpkg.com/ansi-escapes/-/ansi-escapes-1.4.0.tgz#d3a8a83b319aa67793662b13e761c7911422306e" @@ -147,6 +153,15 @@ anymatch@^1.3.0: arrify "^1.0.0" micromatch "^2.1.5" +app-usage-stats@^0.5.0: + version "0.5.1" + resolved "https://registry.yarnpkg.com/app-usage-stats/-/app-usage-stats-0.5.1.tgz#6547c5db9bab0aa5f5b2c560eacc8af20d0ab13b" + dependencies: + array-back "^1.0.4" + home-path "^1.0.3" + test-value "^2.1.0" + usage-stats "^0.9.0" + append-transform@^0.4.0: version "0.4.0" resolved "https://registry.yarnpkg.com/append-transform/-/append-transform-0.4.0.tgz#d76ebf8ca94d276e247a36bad44a4b74ab611991" @@ -194,6 +209,12 @@ arr-flatten@^1.0.1: version "1.0.1" resolved "https://registry.yarnpkg.com/arr-flatten/-/arr-flatten-1.0.1.tgz#e5ffe54d45e19f32f216e91eb99c8ce892bb604b" +array-back@^1.0.2, array-back@^1.0.3, array-back@^1.0.4: + version "1.0.4" + resolved "https://registry.yarnpkg.com/array-back/-/array-back-1.0.4.tgz#644ba7f095f7ffcf7c43b5f0dc39d3c1f03c063b" + dependencies: + typical "^2.6.0" + array-equal@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/array-equal/-/array-equal-1.0.0.tgz#8c2a5ef2472fd9ea742b04c77a75093ba2757c93" @@ -232,13 +253,17 @@ async@^2.0.0, async@^2.1.4: dependencies: lodash "^4.14.0" +async@~0.2.6: + version "0.2.10" + resolved "https://registry.yarnpkg.com/async/-/async-0.2.10.tgz#b6bbe0b0674b9d719708ca38de8c237cb526c3d1" + asynckit@^0.4.0: version "0.4.0" resolved "https://registry.yarnpkg.com/asynckit/-/asynckit-0.4.0.tgz#c79ed97f7f34cb8f2ba1bc9790bcc366474b4b79" -aws-sdk@^2.24.0: - version "2.24.0" - resolved "https://registry.yarnpkg.com/aws-sdk/-/aws-sdk-2.24.0.tgz#9d811e639b9aa6422e10d215523a2b9f899c0ea8" +aws-sdk@^2.25.0: + version "2.25.0" + resolved "https://registry.yarnpkg.com/aws-sdk/-/aws-sdk-2.25.0.tgz#8320cd1d9e08900df62d7cfe4a348f09d70e9897" dependencies: buffer "4.9.1" crypto-browserify "1.0.9" @@ -611,6 +636,14 @@ builtin-modules@^1.0.0, builtin-modules@^1.1.1: version "1.1.1" resolved "https://registry.yarnpkg.com/builtin-modules/-/builtin-modules-1.1.1.tgz#270f076c5a72c02f5b65a47df94c5fe3a278892f" +cache-point@^0.4.0, cache-point@~0.4.0: + version "0.4.0" + resolved "https://registry.yarnpkg.com/cache-point/-/cache-point-0.4.0.tgz#2797f68055970757c87e89b464978e74e11047b0" + dependencies: + array-back "^1.0.4" + fs-then-native "^2.0.0" + mkdirp "~0.5.1" + callsites@^2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/callsites/-/callsites-2.0.0.tgz#06eb84f00eea413da86affefacbffb36093b3c50" @@ -711,6 +744,13 @@ code-point-at@^1.0.0: version "1.1.0" resolved "https://registry.yarnpkg.com/code-point-at/-/code-point-at-1.1.0.tgz#0d070b4d043a5bea33a2f1a40e2edb3d9a4ccf77" +collect-all@^1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/collect-all/-/collect-all-1.0.2.tgz#39450f1e7aa6086570a006bce93ccf1218a77ea1" + dependencies: + stream-connect "^1.0.2" + stream-via "^1.0.3" + color-convert@^1.0.0: version "1.9.0" resolved "https://registry.yarnpkg.com/color-convert/-/color-convert-1.9.0.tgz#1accf97dd739b983bf994d56fec8f95853641b7a" @@ -735,6 +775,37 @@ combined-stream@^1.0.5, combined-stream@~1.0.5: dependencies: delayed-stream "~1.0.0" +command-line-args@^4.0.1: + version "4.0.2" + resolved "https://registry.yarnpkg.com/command-line-args/-/command-line-args-4.0.2.tgz#a99c2f28ceabcf26ac56d38e78b600ea3b57e650" + dependencies: + array-back "^1.0.4" + find-replace "^1.0.3" + typical "^2.6.0" + +command-line-tool@^0.7.0: + version "0.7.0" + resolved "https://registry.yarnpkg.com/command-line-tool/-/command-line-tool-0.7.0.tgz#ca80792ae2069cf7caa562c0cbc2cd11811122a0" + dependencies: + ansi-escape-sequences "^3.0.0" + array-back "^1.0.4" + command-line-args "^4.0.1" + command-line-usage "^4.0.0" + typical "^2.6.0" + +command-line-usage@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/command-line-usage/-/command-line-usage-4.0.0.tgz#816b32788b58f9feba44d1e6dac60fcaeb29b5ea" + dependencies: + ansi-escape-sequences "^3.0.0" + array-back "^1.0.4" + table-layout "^0.4.0" + typical "^2.6.0" + +common-sequence@^1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/common-sequence/-/common-sequence-1.0.2.tgz#30e07f3f8f6f7f9b3dee854f20b2d39eee086de8" + compare-version@^0.1.2: version "0.1.2" resolved "https://registry.yarnpkg.com/compare-version/-/compare-version-0.1.2.tgz#0162ec2d9351f5ddd59a9202cba935366a725080" @@ -752,6 +823,12 @@ concat-map@0.0.1: version "0.0.1" resolved "https://registry.yarnpkg.com/concat-map/-/concat-map-0.0.1.tgz#d8a96bd77fd68df7793a73036a3ba0d5405d477b" +config-master@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/config-master/-/config-master-3.0.0.tgz#25319ddd83cec8010c4095ca7317b17ee4cfea6a" + dependencies: + walk-back "^2.0.1" + configstore@^3.0.0: version "3.0.0" resolved "https://registry.yarnpkg.com/configstore/-/configstore-3.0.0.tgz#e1b8669c1803ccc50b545e92f8e6e79aa80e0196" @@ -865,7 +942,7 @@ decompress-zip@^0.3.0: readable-stream "^1.1.8" touch "0.0.3" -deep-extend@~0.4.0: +deep-extend@~0.4.0, deep-extend@~0.4.1: version "0.4.1" resolved "https://registry.yarnpkg.com/deep-extend/-/deep-extend-0.4.1.tgz#efe4113d08085f4e6f9687759810f807469e2253" @@ -879,6 +956,10 @@ default-require-extensions@^1.0.0: dependencies: strip-bom "^2.0.0" +defer-promise@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/defer-promise/-/defer-promise-1.0.1.tgz#1ca6ffeddbcef1715dd7aae25c7616f9ae22932f" + delayed-stream@~1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/delayed-stream/-/delayed-stream-1.0.0.tgz#df3ae199acadfb7d440aaae0b29e2272b24ec619" @@ -924,9 +1005,39 @@ diff@^3.0.0, diff@^3.0.1: version "3.2.0" resolved "https://registry.yarnpkg.com/diff/-/diff-3.2.0.tgz#c9ce393a4b7cbd0b058a725c93df299027868ff9" -"docdash@https://github.com/develar/docdash.git": - version "0.4.0" - resolved "https://github.com/develar/docdash.git#56e7c0fdfd56c0cbd13a450e4a3aff7867ee59f0" +dmd-tf@^3.0.3: + version "3.0.3" + resolved "https://registry.yarnpkg.com/dmd-tf/-/dmd-tf-3.0.3.tgz#3ffacbf12a65724b7556165f59af87999c33ae24" + dependencies: + array-back "^1.0.4" + cache-point "^0.4.0" + common-sequence "^1.0.2" + file-set "^1.1.1" + handlebars "3.0.3" + marked "^0.3.6" + object-get "^2.1.0" + reduce-flatten "^1.0.1" + reduce-unique "^1.0.0" + reduce-without "^1.0.1" + test-value "^2.1.0" + walk-back "^2.0.1" + +dmd@^3.0.0: + version "3.0.2" + resolved "https://registry.yarnpkg.com/dmd/-/dmd-3.0.2.tgz#9dbc1b24142f0ceaee8b835a112275d80f975b92" + dependencies: + array-back "^1.0.4" + cache-point "^0.4.0" + common-sequence "^1.0.2" + file-set "^1.1.1" + handlebars "3.0.3" + marked "^0.3.6" + object-get "^2.1.0" + reduce-flatten "^1.0.1" + reduce-unique "^1.0.0" + reduce-without "^1.0.1" + test-value "^2.1.0" + walk-back "^2.0.1" doctrine@^2.0.0: version "2.0.0" @@ -1093,6 +1204,19 @@ fb-watchman@^2.0.0: dependencies: bser "^2.0.0" +feature-detect-es6@^1.3.1: + version "1.3.1" + resolved "https://registry.yarnpkg.com/feature-detect-es6/-/feature-detect-es6-1.3.1.tgz#f888736af9cb0c91f55663bfa4762eb96ee7047f" + dependencies: + array-back "^1.0.3" + +file-set@^1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/file-set/-/file-set-1.1.1.tgz#d3ec70c080ec8f18f204ba1de106780c9056926b" + dependencies: + array-back "^1.0.3" + glob "^7.1.0" + filename-regex@^2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/filename-regex/-/filename-regex-2.0.0.tgz#996e3e80479b98b9897f15a8a58b3d084e926775" @@ -1114,6 +1238,13 @@ fill-range@^2.1.0: repeat-element "^1.1.2" repeat-string "^1.5.2" +find-replace@^1.0.3: + version "1.0.3" + resolved "https://registry.yarnpkg.com/find-replace/-/find-replace-1.0.3.tgz#b88e7364d2d9c959559f388c66670d6130441fa0" + dependencies: + array-back "^1.0.4" + test-value "^2.1.0" + find-up@^1.0.0: version "1.1.2" resolved "https://registry.yarnpkg.com/find-up/-/find-up-1.1.2.tgz#6b2e9822b1a2ce0a60ab64d610eccad53cb24d0f" @@ -1169,6 +1300,10 @@ fs-extra@^2.0.0: graceful-fs "^4.1.2" jsonfile "^2.1.0" +fs-then-native@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/fs-then-native/-/fs-then-native-2.0.0.tgz#19a124d94d90c22c8e045f2e8dd6ebea36d48c67" + fs.realpath@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/fs.realpath/-/fs.realpath-1.0.0.tgz#1504ad2523158caa40db4a2787cb01411994ea4f" @@ -1204,7 +1339,7 @@ glob-parent@^2.0.0: dependencies: is-glob "^2.0.0" -glob@^7.0.0, glob@^7.0.3, glob@^7.0.5, glob@^7.1.1, glob@~7.1.1: +glob@^7.0.0, glob@^7.0.3, glob@^7.0.5, glob@^7.1.0, glob@^7.1.1, glob@~7.1.1: version "7.1.1" resolved "https://registry.yarnpkg.com/glob/-/glob-7.1.1.tgz#805211df04faaf1c63a3600306cdf5ade50b2ec8" dependencies: @@ -1253,6 +1388,15 @@ growly@^1.3.0: version "1.3.0" resolved "https://registry.yarnpkg.com/growly/-/growly-1.3.0.tgz#f10748cbe76af964b7c96c93c6bcc28af120c081" +handlebars@3.0.3: + version "3.0.3" + resolved "https://registry.yarnpkg.com/handlebars/-/handlebars-3.0.3.tgz#0e09651a2f0fb3c949160583710d551f92e6d2ad" + dependencies: + optimist "^0.6.1" + source-map "^0.1.40" + optionalDependencies: + uglify-js "~2.3" + handlebars@^4.0.3: version "4.0.6" resolved "https://registry.yarnpkg.com/handlebars/-/handlebars-4.0.6.tgz#2ce4484850537f9c97a8026d5399b935c4ed4ed7" @@ -1304,6 +1448,10 @@ home-or-tmp@^2.0.0: os-homedir "^1.0.0" os-tmpdir "^1.0.1" +home-path@^1.0.3: + version "1.0.3" + resolved "https://registry.yarnpkg.com/home-path/-/home-path-1.0.3.tgz#9ece59fec3f032e6d10b5434fee264df4c2de32f" + hosted-git-info@^2.1.4, hosted-git-info@^2.2.0: version "2.2.0" resolved "https://registry.yarnpkg.com/hosted-git-info/-/hosted-git-info-2.2.0.tgz#7a0d097863d886c0fabbdcd37bf1758d8becf8a5" @@ -1793,9 +1941,9 @@ jsbn@~0.1.0: version "0.1.1" resolved "https://registry.yarnpkg.com/jsbn/-/jsbn-0.1.1.tgz#a5e654c2e5a2deb5f201d96cefbca80c0ef2f513" -jsdoc@^3.4.3: - version "3.4.3" - resolved "https://registry.yarnpkg.com/jsdoc/-/jsdoc-3.4.3.tgz#e5740d6145c681f6679e6c17783a88dbdd97ccd3" +jsdoc-75lb@^3.6.0: + version "3.6.0" + resolved "https://registry.yarnpkg.com/jsdoc-75lb/-/jsdoc-75lb-3.6.0.tgz#a807119528b4009ccbcab49b7522f63fec6cd0bd" dependencies: bluebird "~3.4.6" catharsis "~0.8.8" @@ -1810,6 +1958,50 @@ jsdoc@^3.4.3: taffydb "2.6.2" underscore "~1.8.3" +jsdoc-api@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/jsdoc-api/-/jsdoc-api-3.0.0.tgz#0d52700235f865bd4a8bad5ebc1efb562fc8ad2a" + dependencies: + array-back "^1.0.4" + cache-point "~0.4.0" + collect-all "^1.0.2" + file-set "^1.1.1" + fs-then-native "^2.0.0" + jsdoc-75lb "^3.6.0" + object-to-spawn-args "^1.1.0" + temp-path "^1.0.0" + walk-back "^2.0.1" + +jsdoc-parse@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/jsdoc-parse/-/jsdoc-parse-3.0.0.tgz#271531d88f19df2520b1632a7f6c989441a87fde" + dependencies: + array-back "^1.0.4" + lodash.omit "^4.5.0" + lodash.pick "^4.4.0" + reduce-extract "^1.0.0" + sort-array "^1.1.1" + test-value "^2.1.0" + +jsdoc-to-markdown@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/jsdoc-to-markdown/-/jsdoc-to-markdown-3.0.0.tgz#cc8a94f1f412ac1da4bac1657475b0975ee8161a" + dependencies: + array-back "^1.0.4" + command-line-tool "^0.7.0" + config-master "^3.0.0" + dmd "^3.0.0" + jsdoc-api "^3.0.0" + jsdoc-parse "^3.0.0" + jsdoc2md-stats "^2.0.0" + walk-back "^2.0.1" + +jsdoc2md-stats@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/jsdoc2md-stats/-/jsdoc2md-stats-2.0.1.tgz#bd8343734cfe69ea8050a17931251293f0d9047b" + dependencies: + app-usage-stats "^0.5.0" + jsdom@^9.11.0: version "9.11.0" resolved "https://registry.yarnpkg.com/jsdom/-/jsdom-9.11.0.tgz#a95b0304e521a2ca5a63c6ea47bf7708a7a84591" @@ -1946,6 +2138,18 @@ locate-path@^2.0.0: p-locate "^2.0.0" path-exists "^3.0.0" +lodash.omit@^4.5.0: + version "4.5.0" + resolved "https://registry.yarnpkg.com/lodash.omit/-/lodash.omit-4.5.0.tgz#6eb19ae5a1ee1dd9df0b969e66ce0b7fa30b5e60" + +lodash.padend@^4.6.1: + version "4.6.1" + resolved "https://registry.yarnpkg.com/lodash.padend/-/lodash.padend-4.6.1.tgz#53ccba047d06e158d311f45da625f4e49e6f166e" + +lodash.pick@^4.4.0: + version "4.4.0" + resolved "https://registry.yarnpkg.com/lodash.pick/-/lodash.pick-4.4.0.tgz#52f05610fff9ded422611441ed1fc123a03001b3" + lodash@^4.0.0, lodash@^4.14.0, lodash@^4.2.0, lodash@^4.5.1, lodash@^4.8.0: version "4.17.4" resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.4.tgz#78203a4d1c328ae1d86dca6460e369b57f4055ae" @@ -2006,7 +2210,7 @@ markdown-it@^8.3.1: mdurl "^1.0.1" uc.micro "^1.0.3" -marked@~0.3.6: +marked@^0.3.6, marked@~0.3.6: version "0.3.6" resolved "https://registry.yarnpkg.com/marked/-/marked-0.3.6.tgz#b2c6c618fccece4ef86c4fc6cb8a7cbf5aeda8d7" @@ -2179,10 +2383,18 @@ object-assign@^4.0.1, object-assign@^4.1.0: version "4.1.1" resolved "https://registry.yarnpkg.com/object-assign/-/object-assign-4.1.1.tgz#2109adc7965887cfc05cbbd442cac8bfbb360863" +object-get@^2.0.4, object-get@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/object-get/-/object-get-2.1.0.tgz#722bbdb60039efa47cad3c6dc2ce51a85c02c5ae" + object-keys@~0.4.0: version "0.4.0" resolved "https://registry.yarnpkg.com/object-keys/-/object-keys-0.4.0.tgz#28a6aae7428dd2c3a92f3d95f21335dd204e0336" +object-to-spawn-args@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/object-to-spawn-args/-/object-to-spawn-args-1.1.0.tgz#031a200e37db2c3dfc9b98074a0d69a5be253c1c" + object.omit@^2.0.0: version "2.0.1" resolved "https://registry.yarnpkg.com/object.omit/-/object.omit-2.0.1.tgz#1a9c744829f39dbb858c76ca3579ae2a54ebd1fa" @@ -2209,6 +2421,12 @@ optimist@^0.6.1, optimist@~0.6.0: minimist "~0.0.1" wordwrap "~0.0.2" +optimist@~0.3.5: + version "0.3.7" + resolved "https://registry.yarnpkg.com/optimist/-/optimist-0.3.7.tgz#c90941ad59e4273328923074d2cf2e7cbc6ec0d9" + dependencies: + wordwrap "~0.0.2" + optionator@^0.8.1: version "0.8.2" resolved "https://registry.yarnpkg.com/optionator/-/optionator-0.8.2.tgz#364c5e409d3f4d6301d6c0b4c05bba50180aeb64" @@ -2469,6 +2687,26 @@ redent@^1.0.0: indent-string "^2.1.0" strip-indent "^1.0.1" +reduce-extract@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/reduce-extract/-/reduce-extract-1.0.0.tgz#67f2385beda65061b5f5f4312662e8b080ca1525" + dependencies: + test-value "^1.0.1" + +reduce-flatten@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/reduce-flatten/-/reduce-flatten-1.0.1.tgz#258c78efd153ddf93cb561237f61184f3696e327" + +reduce-unique@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/reduce-unique/-/reduce-unique-1.0.0.tgz#7e586bcf87a4e32b6d7abd8277fad6cdec9f4803" + +reduce-without@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/reduce-without/-/reduce-without-1.0.1.tgz#68ad0ead11855c9a37d4e8256c15bbf87972fc8c" + dependencies: + test-value "^2.0.0" + regenerator-runtime@^0.10.0: version "0.10.3" resolved "https://registry.yarnpkg.com/regenerator-runtime/-/regenerator-runtime-0.10.3.tgz#8c4367a904b51ea62a908ac310bf99ff90a82a3e" @@ -2506,6 +2744,16 @@ repeating@^2.0.0: dependencies: is-finite "^1.0.0" +req-then@^0.5.1: + version "0.5.1" + resolved "https://registry.yarnpkg.com/req-then/-/req-then-0.5.1.tgz#31c6e0b56f4ddd2acd6de0ba1bcea77b6079dfdf" + dependencies: + array-back "^1.0.3" + defer-promise "^1.0.0" + feature-detect-es6 "^1.3.1" + lodash.pick "^4.4.0" + typical "^2.6.0" + request@^2.45.0, request@^2.79.0: version "2.80.0" resolved "https://registry.yarnpkg.com/request/-/request-2.80.0.tgz#8cc162d76d79381cdefdd3505d76b80b60589bd0" @@ -2644,12 +2892,26 @@ sntp@1.x.x: dependencies: hoek "2.x.x" +sort-array@^1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/sort-array/-/sort-array-1.1.1.tgz#9032f6f0be284eecb12af98a3db02612828a66d1" + dependencies: + array-back "^1.0.3" + object-get "^2.0.4" + typical "^2.4.2" + source-map-support@^0.4.11, source-map-support@^0.4.2: version "0.4.11" resolved "https://registry.yarnpkg.com/source-map-support/-/source-map-support-0.4.11.tgz#647f939978b38535909530885303daf23279f322" dependencies: source-map "^0.5.3" +source-map@^0.1.40, source-map@~0.1.7: + version "0.1.43" + resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.1.43.tgz#c24bc146ca517c1471f5dacbe2571b2b7f9e3346" + dependencies: + amdefine ">=0.0.4" + source-map@^0.4.4: version "0.4.4" resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.4.4.tgz#eba4f5da9c0dc999de68032d8b4f76173652036b" @@ -2707,6 +2969,16 @@ stat-mode@^0.2.2: version "0.2.2" resolved "https://registry.yarnpkg.com/stat-mode/-/stat-mode-0.2.2.tgz#e6c80b623123d7d80cf132ce538f346289072502" +stream-connect@^1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/stream-connect/-/stream-connect-1.0.2.tgz#18bc81f2edb35b8b5d9a8009200a985314428a97" + dependencies: + array-back "^1.0.2" + +stream-via@^1.0.3: + version "1.0.3" + resolved "https://registry.yarnpkg.com/stream-via/-/stream-via-1.0.3.tgz#cebd32a5a59d74b3b68e3404942e867184ad4ac9" + string-length@^1.0.1: version "1.0.1" resolved "https://registry.yarnpkg.com/string-length/-/string-length-1.0.1.tgz#56970fb1c38558e9e70b728bf3de269ac45adfac" @@ -2790,6 +3062,16 @@ symbol-tree@^3.2.1: version "3.2.2" resolved "https://registry.yarnpkg.com/symbol-tree/-/symbol-tree-3.2.2.tgz#ae27db38f660a7ae2e1c3b7d1bc290819b8519e6" +table-layout@^0.4.0: + version "0.4.0" + resolved "https://registry.yarnpkg.com/table-layout/-/table-layout-0.4.0.tgz#c70ff0455d9add63b91f7c15a77926295c0e0e7d" + dependencies: + array-back "^1.0.4" + deep-extend "~0.4.1" + lodash.padend "^4.6.1" + typical "^2.6.0" + wordwrapjs "^2.0.0" + taffydb@2.6.2: version "2.6.2" resolved "https://registry.yarnpkg.com/taffydb/-/taffydb-2.6.2.tgz#7cbcb64b5a141b6a2efc2c5d2c67b4e150b2a268" @@ -2803,6 +3085,10 @@ tar-stream@^1.5.0: readable-stream "^2.0.0" xtend "^4.0.0" +temp-path@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/temp-path/-/temp-path-1.0.0.tgz#24b1543973ab442896d9ad367dd9cbdbfafe918b" + term-size@^0.1.0: version "0.1.1" resolved "https://registry.yarnpkg.com/term-size/-/term-size-0.1.1.tgz#87360b96396cab5760963714cda0d0cbeecad9ca" @@ -2819,6 +3105,20 @@ test-exclude@^4.0.0: read-pkg-up "^1.0.1" require-main-filename "^1.0.1" +test-value@^1.0.1: + version "1.1.0" + resolved "https://registry.yarnpkg.com/test-value/-/test-value-1.1.0.tgz#a09136f72ec043d27c893707c2b159bfad7de93f" + dependencies: + array-back "^1.0.2" + typical "^2.4.2" + +test-value@^2.0.0, test-value@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/test-value/-/test-value-2.1.0.tgz#11da6ff670f3471a73b625ca4f3fdcf7bb748291" + dependencies: + array-back "^1.0.3" + typical "^2.6.0" + throat@^3.0.0: version "3.0.0" resolved "https://registry.yarnpkg.com/throat/-/throat-3.0.0.tgz#e7c64c867cbb3845f10877642f7b60055b8ec0d6" @@ -2891,9 +3191,9 @@ ts-babel@^2.0.0: markdown-it "^8.3.1" source-map-support "^0.4.11" -ts-jsdoc@^1.0.0: - version "1.0.0" - resolved "https://registry.yarnpkg.com/ts-jsdoc/-/ts-jsdoc-1.0.0.tgz#455a9d3fc7e20974669ce9e2b12c64703b4e9a7b" +ts-jsdoc@^1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/ts-jsdoc/-/ts-jsdoc-1.0.2.tgz#ff8ad690979550fcb3def5a86592e07c9f2f5c7e" dependencies: bluebird-lst "^1.0.1" chalk "^1.1.3" @@ -2956,18 +3256,30 @@ typescript@~2.1.5: version "2.1.6" resolved "https://registry.yarnpkg.com/typescript/-/typescript-2.1.6.tgz#40c7e6e9e5da7961b7718b55505f9cac9487a607" +typical@^2.4.2, typical@^2.6.0: + version "2.6.0" + resolved "https://registry.yarnpkg.com/typical/-/typical-2.6.0.tgz#89d51554ab139848a65bcc2c8772f8fb450c40ed" + uc.micro@^1.0.1, uc.micro@^1.0.3: version "1.0.3" resolved "https://registry.yarnpkg.com/uc.micro/-/uc.micro-1.0.3.tgz#7ed50d5e0f9a9fb0a573379259f2a77458d50192" uglify-js@^2.6: - version "2.8.8" - resolved "https://registry.yarnpkg.com/uglify-js/-/uglify-js-2.8.8.tgz#1a5cd145eb528b606fa2b86e578885272b597cd7" + version "2.8.10" + resolved "https://registry.yarnpkg.com/uglify-js/-/uglify-js-2.8.10.tgz#bd0be568369f7be8cad2a4161fa90ada118ef73a" dependencies: source-map "~0.5.1" uglify-to-browserify "~1.0.0" yargs "~3.10.0" +uglify-js@~2.3: + version "2.3.6" + resolved "https://registry.yarnpkg.com/uglify-js/-/uglify-js-2.3.6.tgz#fa0984770b428b7a9b2a8058f46355d14fef211a" + dependencies: + async "~0.2.6" + optimist "~0.3.5" + source-map "~0.1.7" + uglify-to-browserify@~1.0.0: version "1.0.2" resolved "https://registry.yarnpkg.com/uglify-to-browserify/-/uglify-to-browserify-1.0.2.tgz#6e0924d6bda6b5afe349e39a6d632850a0f882b7" @@ -3022,6 +3334,17 @@ url@0.10.3: punycode "1.3.2" querystring "0.2.0" +usage-stats@^0.9.0: + version "0.9.0" + resolved "https://registry.yarnpkg.com/usage-stats/-/usage-stats-0.9.0.tgz#a763f6116859f769925e75b5f92e4e3b47a374fd" + dependencies: + array-back "^1.0.4" + home-path "^1.0.3" + mkdirp "^0.5.1" + req-then "^0.5.1" + typical "^2.6.0" + uuid "^3.0.1" + utf8-byte-length@^1.0.1: version "1.0.4" resolved "https://registry.yarnpkg.com/utf8-byte-length/-/utf8-byte-length-1.0.4.tgz#f45f150c4c66eee968186505ab93fcbb8ad6bf61" @@ -3040,6 +3363,10 @@ uuid@3.0.0, uuid@^3.0.0: version "3.0.0" resolved "https://registry.yarnpkg.com/uuid/-/uuid-3.0.0.tgz#6728fc0459c450d796a99c31837569bdf672d728" +uuid@^3.0.1: + version "3.0.1" + resolved "https://registry.yarnpkg.com/uuid/-/uuid-3.0.1.tgz#6544bba2dfda8c1cf17e629a3a305e2bb1fee6c1" + validate-npm-package-license@^3.0.1: version "3.0.1" resolved "https://registry.yarnpkg.com/validate-npm-package-license/-/validate-npm-package-license-3.0.1.tgz#2804babe712ad3379459acfbe24746ab2c303fbc" @@ -3053,6 +3380,10 @@ verror@1.3.6: dependencies: extsprintf "1.0.2" +walk-back@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/walk-back/-/walk-back-2.0.1.tgz#554e2a9d874fac47a8cb006bf44c2f0c4998a0a4" + walkdir@0.0.11, walkdir@^0.0.11: version "0.0.11" resolved "https://registry.yarnpkg.com/walkdir/-/walkdir-0.0.11.tgz#a16d025eb931bd03b52f308caed0f40fcebe9532" @@ -3128,6 +3459,15 @@ wordwrap@~1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/wordwrap/-/wordwrap-1.0.0.tgz#27584810891456a4171c8d0226441ade90cbcaeb" +wordwrapjs@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/wordwrapjs/-/wordwrapjs-2.0.0.tgz#ab55f695e6118da93858fdd70c053d1c5e01ac20" + dependencies: + array-back "^1.0.3" + feature-detect-es6 "^1.3.1" + reduce-flatten "^1.0.1" + typical "^2.6.0" + worker-farm@^1.3.1: version "1.3.1" resolved "https://registry.yarnpkg.com/worker-farm/-/worker-farm-1.3.1.tgz#4333112bb49b17aa050b87895ca6b2cacf40e5ff"