From b787a32f4b7f313d5a93ff8b9cd871d4ed311df9 Mon Sep 17 00:00:00 2001 From: Steffen Agger Date: Mon, 21 Sep 2020 10:47:11 +0200 Subject: [PATCH 1/2] Reordered TS declarations for create(...), to not trigger deprecation warning prematurely. --- types/index.d.ts | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/types/index.d.ts b/types/index.d.ts index 9a188f4f61..1d650bfe9e 100644 --- a/types/index.d.ts +++ b/types/index.d.ts @@ -539,38 +539,38 @@ declare class Realm { /** * @param {string} type * @param {T} properties - * @param {boolean} update? + * @param {Realm.UpdateMode} mode? If not provided, `Realm.UpdateMode.Never` is used. * @returns T & Realm.Object - * - * @deprecated, to be removed in future versions. Use `create(type, properties, UpdateMode)` instead. */ - create(type: string, properties: RealmInsertionModel, update?: boolean): T & Realm.Object + create(type: string, properties: RealmInsertionModel, mode?: Realm.UpdateMode): T & Realm.Object /** * @param {Class} type * @param {T} properties - * @param {boolean} update? + * @param {Realm.UpdateMode} mode? If not provided, `Realm.UpdateMode.Never` is used. * @returns T - * - * @deprecated, to be removed in future versions. Use `create(type, properties, UpdateMode)` instead. */ - create(type: {new(...arg: any[]): T; }, properties: RealmInsertionModel, update?: boolean): T + create(type: {new(...arg: any[]): T; }, properties: RealmInsertionModel, mode?: Realm.UpdateMode): T /** * @param {string} type * @param {T} properties - * @param {Realm.UpdateMode} mode? If not provided, `Realm.UpdateMode.Never` is used. + * @param {boolean} update? * @returns T & Realm.Object + * + * @deprecated, to be removed in future versions. Use `create(type, properties, UpdateMode)` instead. */ - create(type: string, properties: RealmInsertionModel, mode?: Realm.UpdateMode): T & Realm.Object + create(type: string, properties: RealmInsertionModel, update?: boolean): T & Realm.Object /** * @param {Class} type * @param {T} properties - * @param {Realm.UpdateMode} mode? If not provided, `Realm.UpdateMode.Never` is used. + * @param {boolean} update? * @returns T + * + * @deprecated, to be removed in future versions. Use `create(type, properties, UpdateMode)` instead. */ - create(type: {new(...arg: any[]): T; }, properties: RealmInsertionModel, mode?: Realm.UpdateMode): T + create(type: {new(...arg: any[]): T; }, properties: RealmInsertionModel, update?: boolean): T /** * @param {Realm.Object|Realm.Object[]|Realm.List|Realm.Results|any} object From 75cc44796812188801d6483cda924a7a8a0ca49a Mon Sep 17 00:00:00 2001 From: Steffen Agger Date: Mon, 21 Sep 2020 10:55:12 +0200 Subject: [PATCH 2/2] Changelog updated w. TS deprecation warning --- CHANGELOG.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index d644de2c74..a4754695f4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,19 @@ +x.x.x Release notes (yyyy-MM-dd) +============================================================= +### Enhancements +* None. + +### Fixed +* Fixed `create(...)` deprecation warning. ([#3243](https://github.com/realm/realm-js/pull/3243)) + +### Compatibility +* MongoDB Realm Cloud. +* APIs are backwards compatible with all previous releases of Realm JavaScript in the 10.x.y series. +* File format: generates Realms with format v20 (reads and upgrades file format v5 or later for non-synced Realm, upgrades file format v10 for synced Realms). + +### Internal +* None. + 10.0.0 Release notes (2020-9-18) ============================================================= NOTE: Support for syncing with realm.cloud.io and/or Realm Object Server has been replaced with support for syncing with MongoDB Realm Cloud.