aljaz/pear-docs
1
0
Fork 0
mirror of https://github.com/aljazceru/pear-docs.git synced 2025-12-17 14:34:19 +01:00
Code Issues Packages Projects Releases Wiki Activity

api align

Browse Source
This commit is contained in:
David Mark Clements
2023-12-12 19:02:04 +01:00
parent 7e095bc322
commit d33a745132
1 changed files with 5 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
reference/api.md
View File

@@ -364,36 +364,22 @@ will be waited upon until resolution before calling the next teardown handler.
Restart the application. Restart the application.
### `pear.updates(options <Object>, listener <Async Function|Function>)` ### `pear.updates(listener <Async Function|Function>)`
The `listener` function is called for every incoming update, or if `perFile` is `true` for every The `listener` function is called for every incoming update with an `update` object of the form:
updated file.
The `listener` function is called with an `update` object of the form:
```js ```js
{ {
type: 'pear/updates', type: 'pear/updates',
version: { fork <Integer>, length <Integer>, key <String(hex)>, } | null, version: { fork <Integer>, length <Integer>, key <String(hex)>, } | null,
app <Boolean>, app <Boolean>,
filename <String|null>, diff <Array <String> >,
reloads <Array|nulll>
} }
``` ```
* `version` is a Pear version object * `version` is a Pear version object holding incoming version information
* `app` indicates whether the update represents an application (`true`) or platform (`false`) update * `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 * `diff` is an array of file paths from the application root (drive keys) that were updated
* `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 <Module>, previous <Module>, next <Module> }`
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`.
**Options**
* `liveReload <Boolean>` Default: `false` - auto-reload JS libraries and supply to `reloads` array to `listener`
* `perFile <Boolean>` Default: `liveReload` - rather than per incoming version, updates are per file
* `paths <Array>` - array of paths to watch for updates on. Only applies is `perFile` is `true`
### `const win = new pear.Window(entry <String>, options <Object>)` ### `const win = new pear.Window(entry <String>, options <Object>)`