status-im
/
realm-js
mirror of https://github.com/status-im/realm-js.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

update the doc

This commit is contained in:
Nabil Hachicha 2017-12-04 17:46:20 +00:00
parent d1f4f2f97e
commit b2fd0c37d9
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/realm.js
View File

@ -304,7 +304,7 @@ Realm.defaultPath;
* If omitted, the schema will be read from the existing Realm file. * If omitted, the schema will be read from the existing Realm file.
* @property {number} [schemaVersion] - **Required** (and must be incremented) after * @property {number} [schemaVersion] - **Required** (and must be incremented) after
* changing the `schema`. * changing the `schema`.
* @property {Object} [sync] - Sync configuration parameters with the following * @property {Object|true} [sync] - Sync configuration parameters with the following
* child properties: * child properties:
* - `user` - A `User` object obtained by calling `Realm.Sync.User.login` * - `user` - A `User` object obtained by calling `Realm.Sync.User.login`
* - `url` - A `string` which contains a valid Realm Sync url * - `url` - A `string` which contains a valid Realm Sync url
@ -350,6 +350,8 @@ Realm.defaultPath;
* Partial synchronisation only synchronizes those objects that match the query specified in contrast * Partial synchronisation only synchronizes those objects that match the query specified in contrast
* to the normal mode of operation that synchronises all objects in a remote Realm. * to the normal mode of operation that synchronises all objects in a remote Realm.
* **Partial synchronization is a tech preview. Its APIs are subject to change.** * **Partial synchronization is a tech preview. Its APIs are subject to change.**
*
* If set to `true`, this configuration will help open a sync Realm locally/offline without any syncing capabilities.
*/ */
/** /**