status-im
/
realm-js
mirror of https://github.com/status-im/realm-js.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

tweak docs

This commit is contained in:
Ari Lazier 2016-03-21 13:31:28 -07:00
parent 2d6360e1f2
commit dc5d9e80f1
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/realm.js
View File

@ -107,7 +107,8 @@ class Realm {
* Get the current schema version of the Realm at the given path. * Get the current schema version of the Realm at the given path.
* @param {string} path - The path to the file where the * @param {string} path - The path to the file where the
* Realm database is stored. * Realm database is stored.
* @param {string} encryptionKey - Optional encryption key. * @param {ArrayBuffer|ArrayBufferView} [encryptionKey] - Required only when
* accessing encrypted Realms.
* @throws {Error} When passing an invalid or non-matching encryption key. * @throws {Error} When passing an invalid or non-matching encryption key.
* @returns {number} version of the schema, or `-1` if no Realm exists at `path`. * @returns {number} version of the schema, or `-1` if no Realm exists at `path`.
*/ */