API doc updates for path and schemaVersion properties

2016-04-27 17:56:58 -07:00 · 2016-04-27 17:56:58 -07:00 · b50870b040
parent 2b6b0b97f4
commit b50870b040
1 changed files with 16 additions and 0 deletions
--- a/docs/realm.js
+++ b/docs/realm.js
@ -23,6 +23,22 @@
 * ```
 */
 class Realm {
+    /**
+     * The path to the file where this Realm is stored.
+     * @type {string}
+     * @readonly
+     * @since 0.12.0
+     */
+    get path() {}
+
+   /**
+    * The current schema version of this Realm.
+    * @type {number}
+    * @readonly
+    * @since 0.12.0
+    */
+    get schemaVersion() {}
+
    /**
     * Create a new `Realm` instance using the provided `config`. If a Realm does not yet exist
     * at `config.path` (or {@link Realm.defaultPath} if not provided), then this constructor