Remove ObjectSchema from PropertiesTypes (realm#4577)

This is no longer a valid input for schema properties. The documentation has also been updated.
sdandois · May 30, 2022 · 6f27600 · 6f27600
1 parent 250c86e
commit 6f27600
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,7 +5,7 @@ x.x.x Release notes (yyyy-MM-dd)
 
 ### Fixed
 * <How to hit and notice issue? what was the impact?> ([#????](https://github.com/realm/realm-js/issues/????), since v?.?.?)
-* None.
+* Fixed invalid type for schema properties([#4577](https://github.com/realm/realm-js/pull/4577)).
 
 ### Compatibility
 * MongoDB Realm Cloud.

diff --git a/docs/realm.js b/docs/realm.js
@@ -453,7 +453,7 @@ class Realm {
  * that must be unique across all objects of this type within the same Realm.
  * @property {boolean} [embedded] - True if the object type is embedded. An embedded object
  * can be linked to by at most one parent object. Default value: false.
- * @property {Object<string, (Realm~PropertyType|Realm~ObjectSchemaProperty|Realm~ObjectSchema)>} properties -
+ * @property {Object<string, (Realm~PropertyType|Realm~ObjectSchemaProperty)>} properties -
  * An object where the keys are property names and the values represent the property type.
  *
  * @example

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -54,7 +54,7 @@ declare namespace Realm {
 
  // properties types
  interface PropertiesTypes {
- [keys: string]: PropertyType | ObjectSchemaProperty | ObjectSchema;
+ [keys: string]: PropertyType | ObjectSchemaProperty;
  }
 
  enum UpdateMode {