Incorporating feedback on #6508

realm · Feb 28, 2024 · 6e60915 · 6e60915
1 parent 3cb9c46
commit 6e60915
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 22 deletions.
diff --git a/packages/realm/src/ObjectListeners.ts b/packages/realm/src/ObjectListeners.ts
@@ -32,7 +32,8 @@ export type ObjectChangeSet<T> = {
 export type ObjectChangeCallback<T> = (
   /**
    * The object that changed.
-   */ object: RealmObject<T> & T,
+   */
+  object: RealmObject<T> & T,
   /**
    * A dictionary with information about the changes.
    */

diff --git a/packages/realm/src/OrderedCollection.ts b/packages/realm/src/OrderedCollection.ts
@@ -51,22 +51,22 @@ export type CollectionChangeSet = {
    */
   insertions: number[];
   /**
-   * The indices in the collection where objects were modified.
+   * The indices in the collection where objects were deleted.
    */
   deletions: number[];
   /**
-   * The indices in the collection where objects were modified.
+   * The indices in the new state of the collection where objects were modified.
    */
   newModifications: number[];
   /**
-   * The indices in the collection where objects were deleted.
+   * The indices in the old state of the collection where objects were modified.
    */
   oldModifications: number[];
 };
 
 export type CollectionChangeCallback<T = unknown, EntryType extends [unknown, unknown] = [unknown, unknown]> = (
   /**
-   * The collection instance that changed,
+   * The collection instance that changed.
    */
   collection: OrderedCollection<T, EntryType>,
   /**

diff --git a/packages/realm/src/Realm.ts b/packages/realm/src/Realm.ts
@@ -1305,21 +1305,21 @@ export namespace Realm {
   export import WatchOptionsIds = internal.WatchOptionsIds;
 
   // Deprecated exports below
-  /** @deprecated Will be removed in v13.0.0. Please use {@link internal.AppServicesFunction} */
+  /** @deprecated Will be removed in v13.0.0. Please use {@link internal.AppServicesFunction | AppServicesFunction} */
   export import RealmFunction = internal.AppServicesFunction;
-  /** @deprecated Will be removed in v13.0.0. Please use {@link internal.CanonicalPropertySchema} */
+  /** @deprecated Will be removed in v13.0.0. Please use {@link internal.CanonicalPropertySchema | CanonicalPropertySchema} */
   export import CanonicalObjectSchemaProperty = internal.CanonicalPropertySchema;
-  /** @deprecated Will be removed in v13.0.0. Please use {@link internal.ClientResetRecoverUnsyncedChangesConfiguration} */
+  /** @deprecated Will be removed in v13.0.0. Please use {@link internal.ClientResetRecoverUnsyncedChangesConfiguration | ClientResetRecoverUnsyncedChangesConfiguration} */
   export import ClientResetRecoveryConfiguration = internal.ClientResetRecoverUnsyncedChangesConfiguration;
-  /** @deprecated Will be removed in v13.0.0. Please use {@link internal.PropertySchema} */
+  /** @deprecated Will be removed in v13.0.0. Please use {@link internal.PropertySchema | PropertySchema} */
   export import ObjectSchemaProperty = internal.PropertySchema;
-  /** @deprecated Will be removed in v13.0.0. Please use {@link internal.RealmObjectConstructor} */
+  /** @deprecated Will be removed in v13.0.0. Please use {@link internal.RealmObjectConstructor | RealmObjectConstructor} */
   export import ObjectClass = internal.RealmObjectConstructor;
-  /** @deprecated Will be removed in v13.0.0. Please use {@link internal.PropertyTypeName} */
+  /** @deprecated Will be removed in v13.0.0. Please use {@link internal.PropertyTypeName | PropertyTypeName} */
   export import PropertyType = internal.PropertyTypeName;
-  /** @deprecated Use the another {@link internal.ClientResetMode} than {@link internal.ClientResetMode.Manual}. */
+  /** @deprecated Use the another {@link internal.ClientResetMode | ClientResetMode} than {@link internal.ClientResetMode.Manual | ClientResetMode.Manual}. */
   export import ClientResetError = internal.ClientResetError;
-  /** @deprecated Use the another {@link internal.ClientResetMode} than {@link internal.ClientResetMode.Manual}. */
+  /** @deprecated See https://www.mongodb.com/docs/atlas/app-services/reference/push-notifications/ */
   export import PushClient = internal.PushClient;
 }
 

diff --git a/packages/realm/src/app-services/Sync.ts b/packages/realm/src/app-services/Sync.ts
@@ -192,7 +192,7 @@ export namespace Sync {
   export import SubscriptionOptions = internal.SubscriptionOptions;
   export import SubscriptionSet = internal.SubscriptionSet;
   export import SubscriptionSetState = internal.SubscriptionSetState;
-  /** @deprecated Please use {@link internal.SubscriptionSetState} */
+  /** @deprecated Please use {@link internal.SubscriptionSetState | SubscriptionSetState} */
   export import SubscriptionsState = internal.SubscriptionSetState;
   export import Subscription = internal.Subscription;
   export import Session = internal.SyncSession;

diff --git a/packages/realm/src/deprecated-global.ts b/packages/realm/src/deprecated-global.ts
@@ -193,21 +193,21 @@ declare global {
     export import WatchOptionsIds = internal.WatchOptionsIds;
 
     // Deprecated exports below
-    /** @deprecated Will be removed in v13.0.0. Please use {@link internal.AppServicesFunction} */
+    /** @deprecated Will be removed in v13.0.0. Please use {@link internal.AppServicesFunction | AppServicesFunction} */
     export import RealmFunction = internal.AppServicesFunction;
-    /** @deprecated Will be removed in v13.0.0. Please use {@link internal.CanonicalPropertySchema} */
+    /** @deprecated Will be removed in v13.0.0. Please use {@link internal.CanonicalPropertySchema | CanonicalPropertySchema} */
     export import CanonicalObjectSchemaProperty = internal.CanonicalPropertySchema;
-    /** @deprecated Will be removed in v13.0.0. Please use {@link internal.ClientResetRecoverUnsyncedChangesConfiguration} */
+    /** @deprecated Will be removed in v13.0.0. Please use {@link internal.ClientResetRecoverUnsyncedChangesConfiguration | ClientResetRecoverUnsyncedChangesConfiguration} */
     export import ClientResetRecoveryConfiguration = internal.ClientResetRecoverUnsyncedChangesConfiguration;
-    /** @deprecated Will be removed in v13.0.0. Please use {@link internal.PropertySchema} */
+    /** @deprecated Will be removed in v13.0.0. Please use {@link internal.PropertySchema | PropertySchema} */
     export import ObjectSchemaProperty = internal.PropertySchema;
-    /** @deprecated Will be removed in v13.0.0. Please use {@link internal.RealmObjectConstructor} */
+    /** @deprecated Will be removed in v13.0.0. Please use {@link internal.RealmObjectConstructor | RealmObjectConstructor} */
     export import ObjectClass = internal.RealmObjectConstructor;
-    /** @deprecated Will be removed in v13.0.0. Please use {@link internal.PropertyTypeName} */
+    /** @deprecated Will be removed in v13.0.0. Please use {@link internal.PropertyTypeName | PropertyTypeName} */
     export import PropertyType = internal.PropertyTypeName;
-    /** @deprecated Use the another {@link internal.ClientResetMode} than {@link internal.ClientResetMode.Manual}. */
+    /** @deprecated Use the another {@link internal.ClientResetMode | ClientResetMode} than {@link internal.ClientResetMode.Manual | ClientResetMode.Manual}. */
     export import ClientResetError = internal.ClientResetError;
-    /** @deprecated Use the another {@link internal.ClientResetMode} than {@link internal.ClientResetMode.Manual}. */
+    /** @deprecated See https://www.mongodb.com/docs/atlas/app-services/reference/push-notifications/ */
     export import PushClient = internal.PushClient;
   }
 }