Clarify CalendarDate type restrictions in comments

adobe · Nov 26, 2024 · d4762fc · d4762fc
1 parent 6f4a9b7
commit d4762fc
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/packages/@internationalized/date/src/CalendarDate.ts b/packages/@internationalized/date/src/CalendarDate.ts
@@ -40,6 +40,8 @@ function shiftArgs(args: any[]) {
 /** A CalendarDate represents a date without any time components in a specific calendar system. */
 export class CalendarDate {
   // This prevents TypeScript from allowing other types with the same fields to match.
+  // i.e. a ZonedDateTime should not be be passable to a parameter that expects CalendarDate.
+  // If that behavior is desired, use the AnyCalendarDate interface instead.
   // @ts-ignore
   #type;
   /** The calendar system associated with this date, e.g. Gregorian. */