@checkdigit/time 4.0.0 → 5.0.0-PR.21-7813

package/dist-types/date-fns/addQuarters/index.d.ts

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link addQuarters} function options.
+ */
+export interface AddQuartersOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name addQuarters
  * @category Quarter Helpers
@@ -7,15 +13,17 @@
  * Add the specified number of year quarters to the given date.
  *
  * @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).
+ * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
  *
  * @param date - The date to be changed
  * @param amount - The amount of quarters to be added.
+ * @param options - An object with options
  *
  * @returns The new date with the quarters added
  *
  * @example
  * // Add 1 quarter to 1 September 2014:
  * const result = addQuarters(new Date(2014, 8, 1), 1)
- * //=> Mon Dec 01 2014 00:00:00
+ * //=; Mon Dec 01 2014 00:00:00
  */
-export declare function addQuarters<DateType extends Date>(date: DateType | number | string, amount: number): DateType;
+export declare function addQuarters<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, amount: number, options?: AddQuartersOptions<ResultDate> | undefined): ResultDate;

package/dist-types/date-fns/addSeconds/index.d.ts

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link addSeconds} function options.
+ */
+export interface AddSecondsOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name addSeconds
  * @category Second Helpers
@@ -7,9 +13,11 @@
  * Add the specified number of seconds to the given date.
  *
  * @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).
+ * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
  *
  * @param date - The date to be changed
  * @param amount - The amount of seconds to be added.
+ * @param options - An object with options
  *
  * @returns The new date with the seconds added
  *
@@ -18,4 +26,4 @@
  * const result = addSeconds(new Date(2014, 6, 10, 12, 45, 0), 30)
  * //=> Thu Jul 10 2014 12:45:30
  */
-export declare function addSeconds<DateType extends Date>(date: DateType | number | string, amount: number): DateType;
+export declare function addSeconds<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, amount: number, options?: AddSecondsOptions<ResultDate> | undefined): ResultDate;

package/dist-types/date-fns/addWeeks/index.d.ts

@@ -1,15 +1,23 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link addWeeks} function options.
+ */
+export interface AddWeeksOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name addWeeks
  * @category Week Helpers
  * @summary Add the specified number of weeks to the given date.
  *
  * @description
- * Add the specified number of week to the given date.
+ * Add the specified number of weeks to the given date.
  *
  * @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).
+ * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
  *
  * @param date - The date to be changed
  * @param amount - The amount of weeks to be added.
+ * @param options - An object with options
  *
  * @returns The new date with the weeks added
  *
@@ -18,4 +26,4 @@
  * const result = addWeeks(new Date(2014, 8, 1), 4)
  * //=> Mon Sep 29 2014 00:00:00
  */
-export declare function addWeeks<DateType extends Date>(date: DateType | number | string, amount: number): DateType;
+export declare function addWeeks<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, amount: number, options?: AddWeeksOptions<ResultDate> | undefined): ResultDate;

package/dist-types/date-fns/addYears/index.d.ts

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link addYears} function options.
+ */
+export interface AddYearsOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name addYears
  * @category Year Helpers
@@ -7,9 +13,11 @@
  * Add the specified number of years to the given date.
  *
  * @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).
+ * @typeParam ResultDate - The result `Date` type.
  *
  * @param date - The date to be changed
  * @param amount - The amount of years to be added.
+ * @param options - The options
  *
  * @returns The new date with the years added
  *
@@ -18,4 +26,4 @@
  * const result = addYears(new Date(2014, 8, 1), 5)
  * //=> Sun Sep 01 2019 00:00:00
  */
-export declare function addYears<DateType extends Date>(date: DateType | number | string, amount: number): DateType;
+export declare function addYears<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, amount: number, options?: AddYearsOptions<ResultDate> | undefined): ResultDate;

package/dist-types/date-fns/areIntervalsOverlapping/index.d.ts

@@ -1,8 +1,8 @@
-import type { Interval } from '../types';
+import type { ContextOptions, Interval } from '../types.ts';
 /**
  * The {@link areIntervalsOverlapping} function options.
  */
-export interface AreIntervalsOverlappingOptions {
+export interface AreIntervalsOverlappingOptions extends ContextOptions<Date> {
     /** Whether the comparison is inclusive or not */
     inclusive?: boolean;
 }
@@ -48,13 +48,6 @@ export interface AreIntervalsOverlappingOptions {
  * // Using the inclusive option:
  * areIntervalsOverlapping(
  *   { start: new Date(2014, 0, 10), end: new Date(2014, 0, 20) },
- *   { start: new Date(2014, 0, 20), end: new Date(2014, 0, 24) }
- * )
- * //=> false
- *
- * @example
- * areIntervalsOverlapping(
- *   { start: new Date(2014, 0, 10), end: new Date(2014, 0, 20) },
  *   { start: new Date(2014, 0, 20), end: new Date(2014, 0, 24) },
  *   { inclusive: true }
  * )

package/dist-types/date-fns/clamp/index.d.ts

@@ -1,8 +1,20 @@
-import type { Interval } from '../types';
+import type { ContextOptions, DateArg, Interval } from '../types.ts';
+/**
+ * The {@link clamp} function options.
+ */
+export interface ClampOptions<ContextDate extends Date = Date> extends ContextOptions<ContextDate> {
+}
+/**
+ * The {@link clamp} function result type. It resolves the proper data type.
+ * It uses the first argument date object type, starting from the date argument,
+ * then the start interval date, and finally the end interval date. If
+ * a context function is passed, it uses the context function return type.
+ */
+export type ClampResult<DateType extends DateArg<Date>, IntervalType extends Interval, Options extends ClampOptions | undefined> = Options extends ClampOptions<infer DateType extends Date> ? DateType : DateType extends Date ? DateType : IntervalType['start'] extends Date ? IntervalType['start'] : IntervalType['end'] extends Date ? IntervalType['end'] : Date;
 /**
  * @name clamp
  * @category Interval Helpers
- * @summary Return a date bounded by the start and the end of the given interval
+ * @summary Return a date bounded by the start and the end of the given interval.
  *
  * @description
  * Clamps a date to the lower bound with the start of the interval and the upper
@@ -12,19 +24,22 @@ import type { Interval } from '../types';
  * - When the date is greater than the end of the interval, the end is returned.
  * - Otherwise the date is returned.
  *
- * @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).
+ * @typeParam DateType - Date argument type.
+ * @typeParam IntervalType - Interval argument type.
+ * @typeParam Options - Options type.
  *
  * @param date - The date to be bounded
  * @param interval - The interval to bound to
+ * @param options - An object with options
  *
  * @returns The date bounded by the start and the end of the interval
  *
  * @example
- * // What is Mar, 21, 2021 bounded to an interval starting at Mar, 22, 2021 and ending at Apr, 01, 2021
+ * // What is Mar 21, 2021 bounded to an interval starting at Mar 22, 2021 and ending at Apr 01, 2021
  * const result = clamp(new Date(2021, 2, 21), {
  *   start: new Date(2021, 2, 22),
  *   end: new Date(2021, 3, 1),
  * })
  * //=> Mon Mar 22 2021 00:00:00
  */
-export declare function clamp<DateType extends Date>(date: DateType | number | string, interval: Interval): DateType | Date;
+export declare function clamp<DateType extends DateArg<Date>, IntervalType extends Interval, Options extends ClampOptions | undefined = undefined>(date: DateType, interval: IntervalType, options?: Options): ClampResult<DateType, IntervalType, Options>;

package/dist-types/date-fns/closestIndexTo/index.d.ts

@@ -1,3 +1,4 @@
+import type { DateArg } from '../types.ts';
 /**
  * @name closestIndexTo
  * @category Common Helpers
@@ -6,8 +7,6 @@
  * @description
  * Return an index of the closest date from the array comparing to the given date.
  *
- * @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 dateToCompare - The date to compare with
  * @param dates - The array to search
  *
@@ -24,4 +23,4 @@
  * const result = closestIndexTo(dateToCompare, datesArray)
  * //=> 1
  */
-export declare function closestIndexTo<DateType extends Date>(dateToCompare: DateType | number | string, dates: Array<DateType | number | string>): number | undefined;
+export declare function closestIndexTo(dateToCompare: DateArg<Date> & {}, dates: Array<DateArg<Date> & {}>): number | undefined;

package/dist-types/date-fns/closestTo/index.d.ts

@@ -1,3 +1,16 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link closestTo} function options.
+ */
+export interface ClosestToOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
+/**
+ * The {@link closestTo} function result type. It resolves the proper data type.
+ * It uses the first argument date object type, starting from the date argument,
+ * then the start interval date, and finally the end interval date. If
+ * a context function is passed, it uses the context function return type.
+ */
+export type ClosestToResult<DateToCompare extends DateArg<Date>, DatesType extends DateArg<Date>[], Options extends ClosestToOptions | undefined> = Options extends ClosestToOptions<infer DateType extends Date> ? DateType : DateToCompare extends Date ? DateToCompare : DatesType extends DateArg<infer DateType>[] ? DateType : Date;
 /**
  * @name closestTo
  * @category Common Helpers
@@ -6,7 +19,9 @@
  * @description
  * Return a date from the array closest to the given date.
  *
- * @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).
+ * @typeParam DateToCompare - Date to compare argument type.
+ * @typeParam DatesType - Dates array argument type.
+ * @typeParam Options - Options type.
  *
  * @param dateToCompare - The date to compare with
  * @param dates - The array to search
@@ -22,4 +37,4 @@
  * ])
  * //=> Tue Jan 01 2030 00:00:00
  */
-export declare function closestTo<DateType extends Date>(dateToCompare: DateType | number | string, dates: Array<DateType | number | string>): DateType | undefined;
+export declare function closestTo<DateToCompare extends DateArg<Date>, DatesType extends DateArg<Date>[], Options extends ClosestToOptions | undefined = undefined>(dateToCompare: DateToCompare, dates: DatesType, options?: Options | undefined): ClosestToResult<DateToCompare, DatesType, Options> | undefined;

package/dist-types/date-fns/compareAsc/index.d.ts

@@ -1,3 +1,4 @@
+import type { DateArg } from '../types.ts';
 /**
  * @name compareAsc
  * @category Common Helpers
@@ -7,8 +8,6 @@
  * Compare the two dates and return 1 if the first date is after the second,
  * -1 if the first date is before the second or 0 if dates are equal.
  *
- * @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 first date to compare
  * @param dateRight - The second date to compare
  *
@@ -32,4 +31,4 @@
  * //   Sun Jul 02 1995 00:00:00
  * // ]
  */
-export declare function compareAsc<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string): number;
+export declare function compareAsc(dateLeft: DateArg<Date> & {}, dateRight: DateArg<Date> & {}): number;

package/dist-types/date-fns/compareDesc/index.d.ts

@@ -1,3 +1,4 @@
+import type { DateArg } from '../types.ts';
 /**
  * @name compareDesc
  * @category Common Helpers
@@ -7,8 +8,6 @@
  * Compare the two dates and return -1 if the first date is after the second,
  * 1 if the first date is before the second or 0 if dates are equal.
  *
- * @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 first date to compare
  * @param dateRight - The second date to compare
  *
@@ -32,4 +31,4 @@
  * //   Wed Feb 11 1987 00:00:00
  * // ]
  */
-export declare function compareDesc<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string): number;
+export declare function compareDesc(dateLeft: DateArg<Date> & {}, dateRight: DateArg<Date> & {}): number;

package/dist-types/date-fns/constants/index.d.ts

@@ -30,7 +30,7 @@ export declare const daysInWeek = 7;
  *
  * One years equals 365.2425 days according to the formula:
  *
- * > Leap year occures every 4 years, except for years that are divisable by 100 and not divisable by 400.
+ * > Leap year occurs every 4 years, except for years that are divisible by 100 and not divisible by 400.
  * > 1 mean year = (365+1/4-1/100+1/400) days = 365.2425 days
  */
 export declare const daysInYear = 365.2425;
@@ -178,3 +178,15 @@ export declare const secondsInMonth: number;
  * @summary Seconds in 1 quarter.
  */
 export declare const secondsInQuarter: number;
+/**
+ * @constant
+ * @name constructFromSymbol
+ * @summary Symbol enabling Date extensions to inherit properties from the reference date.
+ *
+ * The symbol is used to enable the `constructFrom` function to construct a date
+ * using a reference date and a value. It allows to transfer extra properties
+ * from the reference date to the new date. It's useful for extensions like
+ * [`TZDate`](https://github.com/date-fns/tz) that accept a time zone as
+ * a constructor argument.
+ */
+export declare const constructFromSymbol: unique symbol;

package/dist-types/date-fns/constructFrom/index.d.ts

@@ -1,3 +1,4 @@
+import type { ConstructableDate, ContextFn, DateArg } from '../types.ts';
 /**
  * @name constructFrom
  * @category Generic Helpers
@@ -10,6 +11,11 @@
  *
  * It defaults to `Date` if the passed reference date is a number or a string.
  *
+ * Starting from v3.7.0, it allows to construct a date using `[Symbol.for("constructDateFrom")]`
+ * enabling to transfer extra properties from the reference date to the new date.
+ * It's useful for extensions like [`TZDate`](https://github.com/date-fns/tz)
+ * that accept a time zone as a constructor argument.
+ *
  * @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 date - The reference date to take constructor from
@@ -18,14 +24,14 @@
  * @returns Date initialized using the given date and value
  *
  * @example
- * import { constructFrom } from 'date-fns'
+ * import { constructFrom } from "date-fns";
  *
  * // A function that clones a date preserving the original type
- * function cloneDate<DateType extends Date(date: DateType): DateType {
+ * function cloneDate<DateType extends Date>(date: DateType): DateType {
  *   return constructFrom(
- *     date, // Use contrustor from the given date
+ *     date, // Use constructor from the given date
  *     date.getTime() // Use the date value to create a new date
- *   )
+ *   );
  * }
  */
-export declare function constructFrom<DateType extends Date>(date: DateType | number | string, value: Date | number | string): DateType;
+export declare function constructFrom<DateType extends Date | ConstructableDate, ResultDate extends Date = DateType>(date: DateArg<DateType> | ContextFn<ResultDate> | undefined, value: DateArg<Date> & {}): ResultDate;

package/dist-types/date-fns/constructNow/index.d.ts

@@ -1,3 +1,4 @@
+import type { ContextFn, DateArg } from '../types.ts';
 /**
  * @name constructNow
  * @category Generic Helpers
@@ -11,8 +12,6 @@
  *
  * It defaults to `Date` if the passed reference date is a number or a string.
  *
- * @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 date - The reference date to take constructor from
  *
  * @returns Current date initialized using the given date constructor
@@ -21,11 +20,11 @@
  * import { constructNow, isSameDay } from 'date-fns'
  *
  * function isToday<DateType extends Date>(
- *   date: DateType | number | string,
+ *   date: DateArg<DateType>,
  * ): boolean {
  *   // If we were to use `new Date()` directly, the function would  behave
  *   // differently in different timezones and return false for the same date.
  *   return isSameDay(date, constructNow(date));
  * }
  */
-export declare function constructNow<DateType extends Date>(date: DateType | number | string): DateType;
+export declare function constructNow<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType> | ContextFn<ResultDate> | undefined): ResultDate;

package/dist-types/date-fns/daysToWeeks/index.d.ts

@@ -6,8 +6,6 @@
  * @description
  * Convert a number of days to a full number of weeks.
  *
- * @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 days - The number of days to be converted
  *
  * @returns The number of days converted in weeks

package/dist-types/date-fns/differenceInBusinessDays/index.d.ts

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link differenceInBusinessDays} function options.
+ */
+export interface DifferenceInBusinessDaysOptions extends ContextOptions<Date> {
+}
 /**
  * @name differenceInBusinessDays
  * @category Day Helpers
@@ -5,14 +11,13 @@
  *
  * @description
  * Get the number of business day periods between the given dates.
- * Business days being days that arent in the weekend.
+ * Business days being days that aren't in the weekend.
  * Like `differenceInCalendarDays`, the function removes the times from
  * the dates before calculating the difference.
  *
- * @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 business days
  *
@@ -49,4 +54,4 @@
  * )
  * //=> 0
  */
-export declare function differenceInBusinessDays<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string): number;
+export declare function differenceInBusinessDays(laterDate: DateArg<Date> & {}, earlierDate: DateArg<Date> & {}, options?: DifferenceInBusinessDaysOptions | undefined): number;

package/dist-types/date-fns/differenceInCalendarDays/index.d.ts

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link differenceInCalendarDays} function options.
+ */
+export interface DifferenceInCalendarDaysOptions extends ContextOptions<Date> {
+}
 /**
  * @name differenceInCalendarDays
  * @category Day Helpers
@@ -7,10 +13,9 @@
  * Get the number of calendar days between the given dates. This means that the times are removed
  * from the dates and then the difference in days is calculated.
  *
- * @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 - The options object
  *
  * @returns The number of calendar days
  *
@@ -30,4 +35,4 @@
  * )
  * //=> 1
  */
-export declare function differenceInCalendarDays<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string): number;
+export declare function differenceInCalendarDays(laterDate: DateArg<Date> & {}, earlierDate: DateArg<Date> & {}, options?: DifferenceInCalendarDaysOptions | undefined): number;

package/dist-types/date-fns/differenceInCalendarISOWeekYears/index.d.ts

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link differenceInCalendarISOWeekYears} function options.
+ */
+export interface DifferenceInCalendarISOWeekYearsOptions extends ContextOptions<Date> {
+}
 /**
  * @name differenceInCalendarISOWeekYears
  * @category ISO Week-Numbering Year Helpers
@@ -8,10 +14,9 @@
  *
  * ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_date
  *
- * @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 ISO week-numbering years
  *
@@ -23,4 +28,4 @@
  * )
  * //=> 2
  */
-export declare function differenceInCalendarISOWeekYears<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string): number;
+export declare function differenceInCalendarISOWeekYears(laterDate: DateArg<Date> & {}, earlierDate: DateArg<Date> & {}, options?: DifferenceInCalendarISOWeekYearsOptions | undefined): number;

package/dist-types/date-fns/differenceInCalendarISOWeeks/index.d.ts

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link differenceInCalendarISOWeeks} function options.
+ */
+export interface DifferenceInCalendarISOWeeksOptions extends ContextOptions<Date> {
+}
 /**
  * @name differenceInCalendarISOWeeks
  * @category ISO Week Helpers
@@ -8,10 +14,9 @@
  *
  * ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_date
  *
- * @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 ISO weeks
  *
@@ -19,8 +24,8 @@
  * // How many calendar ISO weeks are between 6 July 2014 and 21 July 2014?
  * const result = differenceInCalendarISOWeeks(
  *   new Date(2014, 6, 21),
- *   new Date(2014, 6, 6)
- * )
+ *   new Date(2014, 6, 6),
+ * );
  * //=> 3
  */
-export declare function differenceInCalendarISOWeeks<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string): number;
+export declare function differenceInCalendarISOWeeks(laterDate: DateArg<Date> & {}, earlierDate: DateArg<Date> & {}, options?: DifferenceInCalendarISOWeeksOptions | undefined): number;

package/dist-types/date-fns/differenceInCalendarMonths/index.d.ts

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link differenceInCalendarMonths} function options.
+ */
+export interface DifferenceInCalendarMonthsOptions extends ContextOptions<Date> {
+}
 /**
  * @name differenceInCalendarMonths
  * @category Month Helpers
@@ -6,10 +12,9 @@
  * @description
  * Get the number of calendar months 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 months
  *
@@ -21,4 +26,4 @@
  * )
  * //=> 8
  */
-export declare function differenceInCalendarMonths<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string): number;
+export declare function differenceInCalendarMonths(laterDate: DateArg<Date> & {}, earlierDate: DateArg<Date> & {}, options?: DifferenceInCalendarMonthsOptions | undefined): number;

package/dist-types/date-fns/differenceInCalendarQuarters/index.d.ts

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link differenceInCalendarQuarters} function options.
+ */
+export interface DifferenceInCalendarQuartersOptions extends ContextOptions<Date> {
+}
 /**
  * @name differenceInCalendarQuarters
  * @category Quarter Helpers
@@ -6,11 +12,10 @@
  * @description
  * Get the number of calendar quarters 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 laterDate - The later date
+ * @param earlierDate - The earlier date
+ * @param options - An object with options
  *
- * @param dateLeft - The later date
- * @param dateRight - The earlier date
-
  * @returns The number of calendar quarters
  *
  * @example
@@ -21,4 +26,4 @@
  * )
  * //=> 3
  */
-export declare function differenceInCalendarQuarters<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string): number;
+export declare function differenceInCalendarQuarters(laterDate: DateArg<Date> & {}, earlierDate: DateArg<Date> & {}, options?: DifferenceInCalendarQuartersOptions | undefined): number;

package/dist-types/date-fns/differenceInCalendarWeeks/index.d.ts

@@ -1,8 +1,8 @@
-import type { LocalizedOptions, WeekOptions } from '../types';
+import type { ContextOptions, DateArg, LocalizedOptions, WeekOptions } from '../types.ts';
 /**
  * The {@link differenceInCalendarWeeks} function options.
  */
-export interface DifferenceInCalendarWeeksOptions extends LocalizedOptions<'options'>, WeekOptions {
+export interface DifferenceInCalendarWeeksOptions extends LocalizedOptions<'options'>, WeekOptions, ContextOptions<Date> {
 }
 /**
  * @name differenceInCalendarWeeks
@@ -12,10 +12,8 @@ export interface DifferenceInCalendarWeeksOptions extends LocalizedOptions<'opti
  * @description
  * Get the number of calendar weeks 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 weeks
@@ -38,4 +36,4 @@ export interface DifferenceInCalendarWeeksOptions extends LocalizedOptions<'opti
  * )
  * //=> 2
  */
-export declare function differenceInCalendarWeeks<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string, options?: DifferenceInCalendarWeeksOptions): number;
+export declare function differenceInCalendarWeeks(laterDate: DateArg<Date> & {}, earlierDate: DateArg<Date> & {}, options?: DifferenceInCalendarWeeksOptions | undefined): number;

package/dist-types/date-fns/differenceInCalendarYears/index.d.ts

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * 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,7 +23,7 @@
  * 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): number;
+export declare function differenceInCalendarYears(laterDate: DateArg<Date> & {}, earlierDate: DateArg<Date> & {}, options?: DifferenceInCalendarYearsOptions | undefined): number;