From 95ac0594dff5c41ce5bda5ef581d9b47c5faf7d0 Mon Sep 17 00:00:00 2001 From: Scott Kyle Date: Thu, 17 Mar 2016 16:05:49 -0700 Subject: [PATCH] Add Realm.schemaVersion API doc This may need to be adjusted depending on the decisions surrounding this API. --- docs/realm.js | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/realm.js b/docs/realm.js index 8c20a1aa..99727abe 100644 --- a/docs/realm.js +++ b/docs/realm.js @@ -103,6 +103,14 @@ class Realm { write(callback) {} } +/** + * Get the current schema version of the Realm at the given path. + * @param {string} path - The path to the file where the + * Realm database is stored. + * @returns {number} version of the schema, or `-1` if no Realm exists at `path`. + */ +Realm.schemaVersion = function(path) {}; + /** * The default path where to create and access the Realm file. * @type {string}