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

Add close() method API doc
2016-05-04 11:48:27 -07:00 · 2016-05-04 11:48:27 -07:00 · d93f5d7584
parent 513c0fee77 9fff367ce0
commit d93f5d7584
1 changed files with 6 additions and 0 deletions
--- a/docs/realm.js
+++ b/docs/realm.js
@ -69,6 +69,12 @@ class Realm {
     */
    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.
     * @param {Realm~ObjectType} type - The type of Realm object to create.