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

Adding documentation

This commit is contained in:
Kræn Hansen 2018-06-20 16:07:07 +02:00
parent f16feec112
commit b4955b816d
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/realm.js
View File

@ -285,6 +285,14 @@ class Realm {
*/ */
compact() {} compact() {}
/**
* Computes the aggregated size of all objects and their history in the Realm.
*
* Note that this will traverse the Realm and might be expensive for large Realms.
* @returns {number} the computed size in bytes.
*/
computeSize() {}
/** /**
* Writes a compacted copy of the Realm to the given path. * Writes a compacted copy of the Realm to the given path.
* *
@ -456,4 +464,3 @@ class Realm {
* any object of this type from inside the same Realm, and will always be _optional_ * any object of this type from inside the same Realm, and will always be _optional_
* (meaning it may also be assigned `null` or `undefined`). * (meaning it may also be assigned `null` or `undefined`).
*/ */