registration

frontend/style/node_modules/date-fns/differenceInCalendarYears.d.ts

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from "./types.js";
+/**
+ * The {@link differenceInCalendarYears} function options.
+ */
+export interface DifferenceInCalendarYearsOptions
+  extends ContextOptions<Date> {}
 /**
  * @name differenceInCalendarYears
  * @category Year Helpers
@@ -6,10 +12,9 @@
  * @description
  * Get the number of calendar years between the given dates.
  *
- * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
- *
- * @param dateLeft - The later date
- * @param dateRight - The earlier date
+ * @param laterDate - The later date
+ * @param earlierDate - The earlier date
+ * @param options - An object with options
 
  * @returns The number of calendar years
  *
@@ -18,10 +23,11 @@
  * const result = differenceInCalendarYears(
  *   new Date(2015, 1, 11),
  *   new Date(2013, 11, 31)
- * )
+ * );
  * //=> 2
  */
-export declare function differenceInCalendarYears<DateType extends Date>(
-  dateLeft: DateType | number | string,
-  dateRight: DateType | number | string,
+export declare function differenceInCalendarYears(
+  laterDate: DateArg<Date> & {},
+  earlierDate: DateArg<Date> & {},
+  options?: DifferenceInCalendarYearsOptions | undefined,
 ): number;