Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: non-silent mode allow not to run the app when the installation is complete #7136

Merged
merged 3 commits into from Oct 1, 2022
Merged

feat: non-silent mode allow not to run the app when the installation is complete #7136

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
be2fe97
feat: add new method quitAppAndInstall
Sep 14, 2022
b7beedd
feat: refine code to better achieve the purpose
Sep 26, 2022
5fd2b5a
Create chilly-days-yawn.md
mmaietta Sep 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
31 changes: 30 additions & 1 deletion docs/api/electron-builder.md
View file
Open in desktop
@@ -1,5 +1,5 @@
Developer API only. See [Configuration](../configuration/configuration.md) for user documentation.

<!-- do not edit. start of generated block -->
<h1 id="modules">Modules</h1>
<dl>
Expand Down Expand Up @@ -1428,11 +1428,13 @@ return path.join(target.outDir, <code>__${target.name}-${getArtifactArchName(arc
<li><a href="#module_electron-updater.AppUpdater+setFeedURL"><code>.setFeedURL(options)</code></a></li>
<li><a href="#module_electron-updater.AppUpdater+isUpdaterActive"><code>.isUpdaterActive()</code></a> ⇒ <code>Boolean</code></li>
<li><a href="#module_electron-updater.AppUpdater+quitAndInstall"><code>.quitAndInstall(isSilent, isForceRunAfter)</code></a></li>
<li><a href="#module_electron-updater.AppUpdater+quitAppAndInstall"><code>.quitAppAndInstall(isForceRunAfter)</code></a></li>
</ul>
</li>
<li><a href="#MacUpdater">.MacUpdater</a> ⇐ <code><a href="#AppUpdater">AppUpdater</a></code>
<ul>
<li><a href="#module_electron-updater.MacUpdater+quitAndInstall"><code>.quitAndInstall()</code></a></li>
<li><a href="#module_electron-updater.MacUpdater+quitAppAndInstall"><code>.quitAppAndInstall()</code></a></li>
<li><a href="#module_electron-updater.AppUpdater+addAuthHeader"><code>.addAuthHeader(token)</code></a></li>
<li><a href="#module_electron-updater.AppUpdater+checkForUpdates"><code>.checkForUpdates()</code></a> ⇒ <code>Promise&lt; | <a href="#UpdateCheckResult">UpdateCheckResult</a>&gt;</code></li>
<li><a href="#module_electron-updater.AppUpdater+checkForUpdatesAndNotify"><code>.checkForUpdatesAndNotify(downloadNotification)</code></a> ⇒ <code>Promise&lt; | <a href="#UpdateCheckResult">UpdateCheckResult</a>&gt;</code></li>
Expand Down Expand Up @@ -1642,6 +1644,7 @@ return path.join(target.outDir, <code>__${target.name}-${getArtifactArchName(arc
<li><a href="#module_electron-updater.AppUpdater+setFeedURL"><code>.setFeedURL(options)</code></a></li>
<li><a href="#module_electron-updater.AppUpdater+isUpdaterActive"><code>.isUpdaterActive()</code></a> ⇒ <code>Boolean</code></li>
<li><a href="#module_electron-updater.AppUpdater+quitAndInstall"><code>.quitAndInstall(isSilent, isForceRunAfter)</code></a></li>
<li><a href="#module_electron-updater.AppUpdater+quitAppAndInstall"><code>.quitAppAndInstall(isForceRunAfter)</code></a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -1749,6 +1752,28 @@ This is different from the normal quit event sequence.</p>
</tr>
</tbody>
</table>
<p><a name="module_electron-updater.AppUpdater+quitAppAndInstall"></a></p>
<h3 id="appupdater.quitAppAndInstall(isforcerunafter)"><code>appUpdater.quitAppAndInstall(isForceRunAfter)</code></h3>
<p>Quit the app and explicit installs the update after it has been downloaded.
It should only be called after <code>update-downloaded</code> has been emitted.</p>
<p><strong>Note:</strong> <code>autoUpdater.quitAppAndInstall()</code> will close all application windows first and only emit <code>before-quit</code> event on <code>app</code> after that.
This is different from the normal quit event sequence.</p>
<table>
<thead>
<tr>
<th>Param</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>isForceRunAfter</td>
<td><code>Boolean</code></td>
<td>Run the app after finish even on silent install. Not applicable for macOS.</td>
</tr>
</tbody>
</table>
<p><a name="MacUpdater"></a></p>
<h2 id="macupdater-%E2%87%90-appupdater">MacUpdater ⇐ <code><a href="#AppUpdater">AppUpdater</a></code></h2>
<p><strong>Kind</strong>: class of <a href="#module_electron-updater"><code>electron-updater</code></a><br/>
Expand All @@ -1757,6 +1782,7 @@ This is different from the normal quit event sequence.</p>
<li><a href="#MacUpdater">.MacUpdater</a> ⇐ <code><a href="#AppUpdater">AppUpdater</a></code>
<ul>
<li><a href="#module_electron-updater.MacUpdater+quitAndInstall"><code>.quitAndInstall()</code></a></li>
<li><a href="#module_electron-updater.MacUpdater+quitAppAndInstall"><code>.quitAppAndInstall()</code></a></li>
<li><a href="#module_electron-updater.AppUpdater+addAuthHeader"><code>.addAuthHeader(token)</code></a></li>
<li><a href="#module_electron-updater.AppUpdater+checkForUpdates"><code>.checkForUpdates()</code></a> ⇒ <code>Promise&lt; | <a href="#UpdateCheckResult">UpdateCheckResult</a>&gt;</code></li>
<li><a href="#module_electron-updater.AppUpdater+checkForUpdatesAndNotify"><code>.checkForUpdatesAndNotify(downloadNotification)</code></a> ⇒ <code>Promise&lt; | <a href="#UpdateCheckResult">UpdateCheckResult</a>&gt;</code></li>
Expand All @@ -1770,6 +1796,9 @@ This is different from the normal quit event sequence.</p>
<p><a name="module_electron-updater.MacUpdater+quitAndInstall"></a></p>
<h3 id="macupdater.quitandinstall()"><code>macUpdater.quitAndInstall()</code></h3>
<p><strong>Overrides</strong>: <a href="#module_electron-updater.AppUpdater+quitAndInstall"><code>quitAndInstall</code></a><br>
<p><a name="module_electron-updater.MacUpdater+quitAppAndInstall"></a></p>
<h3 id="macupdater.quitandinstall()"><code>macUpdater.quitAppAndInstall()</code></h3>
<p><strong>Overrides</strong>: <a href="#module_electron-updater.AppUpdater+quitAppAndInstall"><code>quitAppAndInstall</code></a><br>
<a name="module_electron-updater.AppUpdater+addAuthHeader"></a></p>
<h3 id="macupdater.addauthheader(token)"><code>macUpdater.addAuthHeader(token)</code></h3>
<p>Shortcut for explicitly adding auth tokens to request headers</p>
Expand Down
11 changes: 11 additions & 0 deletions packages/electron-updater/src/AppUpdater.ts
View file
Open in desktop
Expand Up @@ -517,6 +517,17 @@ export abstract class AppUpdater extends (EventEmitter as new () => TypedEmitter
*/
abstract quitAndInstall(isSilent?: boolean, isForceRunAfter?: boolean): void

/**
* Quit the app and explicit installs the update after it has been downloaded.
* It should only be called after `update-downloaded` has been emitted.
*
* **Note:** `autoUpdater.quitAppAndInstall()` will close all application windows first and only emit `before-quit` event on `app` after that.
* This is different from the normal quit event sequence.
*
* @param isForceRunAfter Run the app after finish. Defaults to `false`. Not applicable for macOS.
*/
abstract quitAppAndInstall(isForceRunAfter?: boolean): void

private async loadUpdateConfig(): Promise<any> {
if (this._appUpdateConfigPath == null) {
this._appUpdateConfigPath = this.app.appUpdateConfigPath
Expand Down
12 changes: 12 additions & 0 deletions packages/electron-updater/src/BaseUpdater.ts
View file
Open in desktop
Expand Up @@ -24,6 +24,18 @@ export abstract class BaseUpdater extends AppUpdater {
}
}

quitAppAndInstall(isForceRunAfter = false): void {
const isInstalled = this.install(false, isForceRunAfter);
shenglianlee marked this conversation as resolved.
Show resolved Hide resolved
if (isInstalled) {
setImmediate(() => {
require("electron").autoUpdater.emit("before-quit-for-update")
this.app.quit()
})
} else {
this.quitAndInstallCalled = false
}
}

protected executeDownload(taskOptions: DownloadExecutorTask): Promise<Array<string>> {
return super.executeDownload({
...taskOptions,
Expand Down
4 changes: 4 additions & 0 deletions packages/electron-updater/src/MacUpdater.ts
View file
Open in desktop
Expand Up @@ -233,4 +233,8 @@ export class MacUpdater extends AppUpdater {
}
}
}

quitAppAndInstall(): void {
this.quitAndInstall();
}
}