# auto-updater

`auto-updater` module is a simple wrap around the Sparkle framework, it
provides auto update service for the application.

Before using this module, you should edit the `Info.plist` following
https://github.com/andymatuschak/Sparkle/wiki.

## Event: will-install-update

* `event` Event
* `version` String
* `continueUpdate` Function

This event is emitted when the update is found and going to be installed.
Calling `event.preventDefault()` would pause it, and you can call
`continueUpdate` to continue the update.

## Event: ready-for-update-on-quit

* `event` Event
* `version` String
* `quitAndUpdate` Function

This event is emitted when user chose to delay the update until the quit.
Calling `quitAndUpdate()` would quit the application and install the update.

## autoUpdater.setFeedUrl(url)

* `url` String

## autoUpdater.setAutomaticallyChecksForUpdates(flag)

* `flag` Boolean

## autoUpdater.setAutomaticallyDownloadsUpdates(flag)

* `flag` Boolean

## autoUpdater.checkForUpdates()

## autoUpdater.checkForUpdatesInBackground()

# auto-updater

The `auto-updater` module is a simple wrap around the
[Squirrel](https://github.com/Squirrel/Squirrel.Mac) framework, you should
follow Squirrel's instructions on setting the server.

## Event: checking-for-update

Emitted when checking for update has started.

## Event: update-available

Emitted when there is an available update, the update would be downloaded
automatically.

## Event: update-not-available

Emitted when there is no available update.

## Event: update-downloaded

* `event` Event
* `releaseNotes` String
* `releaseName` String
* `releaseDate` Date
* `updateUrl` String
* `quitAndUpdate` Function

Emitted when update has been downloaded, calling `quitAndUpdate()` would restart
the application and install the update.

## autoUpdater.setFeedUrl(url)

* `url` String

Set the `url` and initialize the auto updater. The `url` could not be changed
once it is set.

## autoUpdater.checkForUpdates()

Ask the server whether there is an update, you have to call `setFeedUrl` before
using this API.

Add docs on new auto updater API.
:memo: Add docs on new auto updater API.
