From 15b69e381d86de4166f59f5b8a9728b4750235be Mon Sep 17 00:00:00 2001 From: Scott Kyle Date: Mon, 2 May 2016 13:21:02 -0700 Subject: [PATCH] Add API docs for readOnly --- docs/realm.js | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/realm.js b/docs/realm.js index 03d5093c..255fc142 100644 --- a/docs/realm.js +++ b/docs/realm.js @@ -31,6 +31,14 @@ class Realm { */ get path() {} + /** + * Indicates if this Realm was opened as read-only. + * @type {boolean} + * @readonly + * @since 0.12.0 + */ + get readOnly() {} + /** * The current schema version of this Realm. * @type {number} @@ -144,6 +152,7 @@ Realm.defaultPath; * key used to encrypt and decrypt all data in the Realm. * @property {string} [path={@link Realm.defaultPath}] - The path to the file where the * Realm database should be stored. + * @property {boolean} [readOnly=false] - Specifies if this Realm should be opened as read-only. * @property {Array} [schema] - Specifies all the * object types in this Realm. **Required** when first creating a Realm at this `path`. * @property {number} [schemaVersion] - **Required** (and must be incremented) after