You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/Auto Update.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -328,7 +328,9 @@ Emitted on progress. Only supported over Windows build, since `Squirrel.Mac` [do
328
328
329
329
| Name | Type | Description |
330
330
|---|---|---|
331
-
| autoDownload =<code>true</code>|<code>boolean</code>|<a name="AppUpdater-autoDownload"></a>Automatically download an update when it is found. |
331
+
| autoDownload =<code>true</code>|<code>boolean</code>|<a name="AppUpdater-autoDownload"></a>Whether to automatically download an update when it is found. |
332
+
| allowPrerelease|<code>boolean</code>|<a name="AppUpdater-allowPrerelease"></a>*GitHub provider only.* Whether to allow update to pre-release versions. Defaults to `true`if application version contains prerelease components (e.g. `0.12.1-alpha.1`, here `alpha` is a prerelease component), otherwise `false`.<br><br>If `true`, downgrade will be allowed (`allowDowngrade` will be set to `true`). |
333
+
| allowDowngrade|<code>boolean</code>|<a name="AppUpdater-allowDowngrade"></a>Whether to allow version downgrade (when a user from the beta channel wants to go back to the stable channel). Defaults to `true`if application version contains prerelease components (e.g. `0.12.1-alpha.1`, here `alpha` is a prerelease component), otherwise `false`. |
| logger =<code>(<any>global).__test_app?null:console</code>|<code>[Logger](#Logger)</code> \|<code>null</code>|<a name="AppUpdater-logger"></a>The logger. You can pass [electron-log](https://github.com/megahertz/electron-log), [winston](https://github.com/winstonjs/winston) or another logger with the following interface: `{ info(), warn(), error() }`. Set it to `null` if you would like to disable a logging feature. |
334
336
| signals =<code>newUpdaterSignal(this)</code>|<code>[UpdaterSignal](#UpdaterSignal)</code>|<a name="AppUpdater-signals"></a>For type safety you can use signals, e.g. `autoUpdater.signals.updateDownloaded(() => {})` instead of`autoUpdater.on('update-available', () => {})`|
0 commit comments