Merge pull request #413 from realm/sk-schema-docs

Add schema property to API docs and update CHANGELOG
This commit is contained in:
Scott Kyle 2016-05-03 07:34:23 -07:00
commit 4fa35b7a12
2 changed files with 15 additions and 0 deletions

View File

@ -6,12 +6,18 @@ x.x.x Release notes (yyyy-MM-dd)
### Enhancements
* Support for queries comparing optional properties to `null`
* `object.isValid()` has been added to enable checking if an object has been deleted
- **Note:** Custom object classes can extend `Realm.Object` to inherit this method
* Support opening a Realm as read-only with the `readOnly` configuration option
* Support for providing a custom migration function (please see the docs for details)
* Added `path`, `readOnly`, `schema`, and `schemaVersion` properties to `Realm` instances
* Optional and list properties are no longer required when creating objects
### Bugfixes
* When accessing an empty Results `undefined` is returned rather than throwing an exception
* Accessing a deleted object throws a JS exception rather than crashing
* Accessing an invalidated Results snapshot throws a JS exception rather than crashing
* Fix for error message when specifying properties with invalid object types
* Fix memory leak when reloading an app in debug mode
0.11.1 Release notes (2016-3-29)
=============================================================

View File

@ -39,6 +39,15 @@ class Realm {
*/
get readOnly() {}
/**
* A normalized representation of the schema provided in the
* {@link Realm~Configuration Configuration} when this Realm was constructed.
* @type {Realm~ObjectSchema[]}
* @readonly
* @since 0.12.0
*/
get schema() {}
/**
* The current schema version of this Realm.
* @type {number}