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 collection.js

This commit is contained in:
Kenneth Geisshirt 2018-06-07 11:25:38 +02:00 committed by GitHub
parent 1e5e59d3c0
commit 4dc4bac37e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/collection.js
View File

@ -431,21 +431,15 @@ class Collection {
* and `deletions`, each containing a list of indices in the collection that were * and `deletions`, each containing a list of indices in the collection that were
* inserted, updated or deleted respectively. `deletions` and `oldModifications` are * inserted, updated or deleted respectively. `deletions` and `oldModifications` are
* indices into the collection before the change happened, while `insertions` and * indices into the collection before the change happened, while `insertions` and
* `newModifications` are indices into the new version of the collection. If partial sync * `newModifications` are indices into the new version of the collection.
* is enabled, an additional key `partial_sync` is added.
* - `changes.partial_sync`: `error` indicates if an error has occurred, `old_state` is the previous
* state, and `new_state` is the current state.
* @throws {Error} If `callback` is not a function. * @throws {Error} If `callback` is not a function.
* @example * @example
* wines.addListener((collection, changes) => { * wines.addListener((collection, changes) => {
* // collection === wines * // collection === wines
* if (changes.partial_sync.new_state == Realm.Sync.SubscriptionState.Initialized) {
* console.log('Our subset is ready');
* console.log(`${changes.insertions.length} insertions`); * console.log(`${changes.insertions.length} insertions`);
* console.log(`${changes.modifications.length} modifications`); * console.log(`${changes.modifications.length} modifications`);
* console.log(`${changes.deletions.length} deletions`); * console.log(`${changes.deletions.length} deletions`);
* console.log(`new size of collection: ${collection.length}`); * console.log(`new size of collection: ${collection.length}`);
* }
* }); * });
*/ */
addListener(callback) {} addListener(callback) {}