mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

docs: clarify default auto-updater installation behavior (#12783)

Browse source 
* docs: clarify default auto-updater installation behavior

* remove redundant note
This commit is contained in:
Zeke Sikelianos 2018-07-24 15:33:53 -07:00 committed by Samuel Attard
parent 76a62b44dc
commit 89a9ccab8b
1 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/api/auto-updater.md
View file

@ -84,6 +84,9 @@ Emitted when an update has been downloaded.
On Windows only `releaseName` is available. On Windows only `releaseName` is available.
**Note:** It is not strictly necessary to handle this event. A successfully
downloaded update will still be applied the next time the application starts.
### Event: 'before-quit-for-update' ### Event: 'before-quit-for-update'
This event is emitted after a user calls `quitAndInstall()`. This event is emitted after a user calls `quitAndInstall()`.
@ -122,9 +125,9 @@ Under the hood calling `autoUpdater.quitAndInstall()` will close all application
windows first, and automatically call `app.quit()` after all windows have been windows first, and automatically call `app.quit()` after all windows have been
closed. closed.
**Note:** If the application is quit without calling this API after the **Note:** It is not strictly necessary to call this function to apply an update,
`update-downloaded` event has been emitted, the application will still be as a successfully downloaded update will always be applied the next time the
replaced by the updated one on the next run. application starts.
[squirrel-mac]: https://github.com/Squirrel/Squirrel.Mac [squirrel-mac]: https://github.com/Squirrel/Squirrel.Mac
[server-support]: https://github.com/Squirrel/Squirrel.Mac#server-support [server-support]: https://github.com/Squirrel/Squirrel.Mac#server-support