diff --git a/reference/api.md b/reference/api.md index 6871dae..6e91874 100644 --- a/reference/api.md +++ b/reference/api.md @@ -375,13 +375,17 @@ The `listener` function is called with an `update` object of the form: { type: 'pear/updates', version: { fork , length , key , } | null, - current: { fork , length , key , } | null, app , filename , reloads } ``` +* `version` is a Pear version object +* `app` indicates whether the update represents an application (`true`) or platform (`false`) update +* `filename` is supplied if the `perFile` option is `true` and is the path of the file from application root +* `reloads` is supplied if the `liveReload` option is `true` and is an array of objects containing the original, previous and next module/component instances that can be passed on to a hot-reloader. Objects take the form `{ original , previous , next }` + For launched applications, use the default behavior (`perFile: false`) to respond to platform and application updates in production. For developed applications, the `liveReload`, `perFile` and `paths` options in combination with `pear.config.watch` and `pear.config.dev` are useful for setting up project devex hot-reload functionality. In development mode `version` and `current` will always be `null`.