From 4cecb0a612af2ab8965171220c901f15ea942709 Mon Sep 17 00:00:00 2001 From: Scott Kyle Date: Wed, 4 May 2016 02:39:06 -0700 Subject: [PATCH 1/2] Add close() method API doc --- docs/realm.js | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/realm.js b/docs/realm.js index 52ed7602..0589008f 100644 --- 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 in this Realm will no longer be valid until it is re-opened. + */ + 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. From 9fff367ce05eef63e4f1ef472632af7f13d867c5 Mon Sep 17 00:00:00 2001 From: Scott Kyle Date: Wed, 4 May 2016 11:40:06 -0700 Subject: [PATCH 2/2] Reword close() API doc based on PR feedback --- docs/realm.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/realm.js b/docs/realm.js index 0589008f..4d4e2213 100644 --- a/docs/realm.js +++ b/docs/realm.js @@ -71,7 +71,7 @@ class Realm { /** * Closes this Realm so it may be re-opened with a newer schema version. - * All objects and collections in this Realm will no longer be valid until it is re-opened. + * All objects and collections from this Realm are no longer valid after calling this method. */ close() {}