status-im/realm-js
2
0
Fork 0
mirror of https://github.com/status-im/realm-js.git synced 2025-02-18 17:47:32 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #419 from realm/sk-close-docs

Browse Source 
Add close() method API doc
This commit is contained in:
Scott Kyle 2016-05-04 11:48:27 -07:00
commit d93f5d7584
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/realm.js
View File

@ -69,6 +69,12 @@ class Realm {
*/ */
constructor(config) {} constructor(config) {}
/**
* Closes this Realm so it may be re-opened with a newer schema version.
* All objects and collections from this Realm are no longer valid after calling this method.
*/
close() {}
/** /**
* Create a new Realm object of the given type and with the specified properties. * Create a new Realm object of the given type and with the specified properties.
* @param {Realm~ObjectType} type - The type of Realm object to create. * @param {Realm~ObjectType} type - The type of Realm object to create.