chore(sequence): deprecate compareStarts and compareEnds on IInterval…

…Helpers (microsoft#17127) Deprecates redundant methods on `IIntervalHelpers`. See microsoft#17125 for their subsequent removal and additional context.
pragya91 · Sep 1, 2023 · a830eca · a830eca
1 parent 771793f
commit a830eca
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 2 deletions.
diff --git a/.changeset/poor-friends-search.md b/.changeset/poor-friends-search.md
@@ -0,0 +1,7 @@
+---
+"@fluidframework/sequence": minor
+---
+
+deprecate compareStarts and compareEnds on IIntervalHelpers
+
+these functions will be removed in a future version. use the methods IInterval.compareStart and IInterval.compareEnd respectively instead
diff --git a/api-report/sequence.api.md b/api-report/sequence.api.md
@@ -175,9 +175,9 @@ export interface IIntervalCollectionEvent<TInterval extends ISerializableInterva
 
 // @public @sealed (undocumented)
 export interface IIntervalHelpers<TInterval extends ISerializableInterval> {
-    // (undocumented)
+    // @deprecated (undocumented)
     compareEnds(a: TInterval, b: TInterval): number;
-    // (undocumented)
+    // @deprecated (undocumented)
     compareStarts?(a: TInterval, b: TInterval): number;
     // (undocumented)
     create(label: string, start: number | undefined, end: number | undefined, client: Client | undefined, intervalType: IntervalType, op?: ISequencedDocumentMessage, fromSnapshot?: boolean, stickiness?: IntervalStickiness): TInterval;

diff --git a/packages/dds/sequence/src/intervals/intervalUtils.ts b/packages/dds/sequence/src/intervals/intervalUtils.ts
@@ -168,7 +168,14 @@ export type CompressedSerializedInterval =
  * @sealed
  */
 export interface IIntervalHelpers<TInterval extends ISerializableInterval> {
+	/**
+	 * @deprecated Use the method `IInterval.compareEnd` instead
+	 */
 	compareEnds(a: TInterval, b: TInterval): number;
+
+	/**
+	 * @deprecated Use the method `IInterval.compareStart` instead
+	 */
 	compareStarts?(a: TInterval, b: TInterval): number;
 	/**
 	 *