Add Realm.schemaVersion API doc

This may need to be adjusted depending on the decisions surrounding this API.
This commit is contained in:
Scott Kyle 2016-03-17 16:05:49 -07:00 committed by Ari Lazier
parent 5de63ac401
commit 95ac0594df

View File

@ -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}