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

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

@@ -1,9 +1,16 @@
-import type { Interval, StepOptions } from '../types';
+import type { ContextOptions, Interval, StepOptions } from '../types.ts';
 /**
  * The {@link eachYearOfInterval} function options.
  */
-export interface EachYearOfIntervalOptions extends StepOptions {
+export interface EachYearOfIntervalOptions<DateType extends Date = Date> extends StepOptions, ContextOptions<DateType> {
 }
+/**
+ * The {@link eachYearOfInterval} 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 EachYearOfIntervalResult<IntervalType extends Interval, Options extends EachYearOfIntervalOptions | undefined> = Array<Options extends EachYearOfIntervalOptions<infer DateType> ? DateType : IntervalType['start'] extends Date ? IntervalType['start'] : IntervalType['end'] extends Date ? IntervalType['end'] : Date>;
 /**
  * @name eachYearOfInterval
  * @category Interval Helpers
@@ -12,9 +19,11 @@ export interface EachYearOfIntervalOptions extends StepOptions {
  * @description
  * Return the array of yearly timestamps within the specified time interval.
  *
- * @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 IntervalType - Interval type.
+ * @typeParam Options - Options type.
  *
  * @param interval - The interval.
+ * @param options - An object with options.
  *
  * @returns The array with starts of yearly timestamps from the month of the interval start to the month of the interval end
  *
@@ -31,4 +40,4 @@ export interface EachYearOfIntervalOptions extends StepOptions {
  * //   Sun Jan 01 2017 00:00:00
  * // ]
  */
-export declare function eachYearOfInterval<DateType extends Date>(interval: Interval<DateType>, options?: EachYearOfIntervalOptions): DateType[];
+export declare function eachYearOfInterval<IntervalType extends Interval, Options extends EachYearOfIntervalOptions | undefined = undefined>(interval: IntervalType, options?: Options): EachYearOfIntervalResult<IntervalType, Options>;

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

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link endOfDay} function options.
+ */
+export interface EndOfDayOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name endOfDay
  * @category Day Helpers
@@ -8,8 +14,10 @@
  * The result will be in the local timezone.
  *
  * @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 original date
+ * @param options - An object with options
  *
  * @returns The end of a day
  *
@@ -18,4 +26,4 @@
  * const result = endOfDay(new Date(2014, 8, 2, 11, 55, 0))
  * //=> Tue Sep 02 2014 23:59:59.999
  */
-export declare function endOfDay<DateType extends Date>(date: DateType | number | string): DateType;
+export declare function endOfDay<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, options?: EndOfDayOptions<ResultDate> | undefined): ResultDate;

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

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link endOfDecade} function options.
+ */
+export interface EndOfDecadeOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name endOfDecade
  * @category Decade Helpers
@@ -7,8 +13,10 @@
  * Return the end of a decade for 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 original date
+ * @param options - An object with options
  *
  * @returns The end of a decade
  *
@@ -17,4 +25,4 @@
  * const result = endOfDecade(new Date(1984, 4, 12, 00, 00, 00))
  * //=> Dec 31 1989 23:59:59.999
  */
-export declare function endOfDecade<DateType extends Date>(date: DateType | number | string): DateType;
+export declare function endOfDecade<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, options?: EndOfDecadeOptions<ResultDate> | undefined): ResultDate;

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

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link endOfHour} function options.
+ */
+export interface EndOfHourOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name endOfHour
  * @category Hour Helpers
@@ -8,8 +14,10 @@
  * The result will be in the local timezone.
  *
  * @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 original date
+ * @param options - An object with options
  *
  * @returns The end of an hour
  *
@@ -18,4 +26,4 @@
  * const result = endOfHour(new Date(2014, 8, 2, 11, 55))
  * //=> Tue Sep 02 2014 11:59:59.999
  */
-export declare function endOfHour<DateType extends Date>(date: DateType | number | string): DateType;
+export declare function endOfHour<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, options?: EndOfHourOptions<ResultDate> | undefined): ResultDate;

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

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link endOfISOWeek} function options.
+ */
+export interface EndOfISOWeekOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name endOfISOWeek
  * @category ISO Week Helpers
@@ -10,8 +16,10 @@
  * 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).
+ * @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 original date
+ * @param options - An object with options
  *
  * @returns The end of an ISO week
  *
@@ -20,4 +28,4 @@
  * const result = endOfISOWeek(new Date(2014, 8, 2, 11, 55, 0))
  * //=> Sun Sep 07 2014 23:59:59.999
  */
-export declare function endOfISOWeek<DateType extends Date>(date: DateType | number | string): DateType;
+export declare function endOfISOWeek<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, options?: EndOfISOWeekOptions<ResultDate> | undefined): ResultDate;

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

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link endOfISOWeekYear} function options.
+ */
+export interface EndOfISOWeekYearOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name endOfISOWeekYear
  * @category ISO Week-Numbering Year Helpers
@@ -11,8 +17,10 @@
  * 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).
+ * @typeParam ContextDate - The `Date` type of the context function.
  *
  * @param date - The original date
+ * @param options - The options
  *
  * @returns The end of an ISO week-numbering year
  *
@@ -21,4 +29,4 @@
  * const result = endOfISOWeekYear(new Date(2005, 6, 2))
  * //=> Sun Jan 01 2006 23:59:59.999
  */
-export declare function endOfISOWeekYear<DateType extends Date>(date: DateType | number | string): DateType;
+export declare function endOfISOWeekYear<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, options?: EndOfISOWeekYearOptions<ResultDate> | undefined): ResultDate;

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

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link endOfMinute} function options.
+ */
+export interface EndOfMinuteOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name endOfMinute
  * @category Minute Helpers
@@ -5,11 +11,13 @@
  *
  * @description
  * Return the end of a minute for the given date.
- * The result will be in the local timezone.
+ * The result will be in the local timezone or the provided context.
  *
  * @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 original date
+ * @param options - An object with options
  *
  * @returns The end of a minute
  *
@@ -18,4 +26,4 @@
  * const result = endOfMinute(new Date(2014, 11, 1, 22, 15, 45, 400))
  * //=> Mon Dec 01 2014 22:15:59.999
  */
-export declare function endOfMinute<DateType extends Date>(date: DateType | number | string): DateType;
+export declare function endOfMinute<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, options?: EndOfMinuteOptions<ResultDate> | undefined): ResultDate;

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

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link endOfMonth} function options.
+ */
+export interface EndOfMonthOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name endOfMonth
  * @category Month Helpers
@@ -8,8 +14,10 @@
  * The result will be in the local timezone.
  *
  * @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 original date
+ * @param options - An object with options
  *
  * @returns The end of a month
  *
@@ -18,4 +26,4 @@
  * const result = endOfMonth(new Date(2014, 8, 2, 11, 55, 0))
  * //=> Tue Sep 30 2014 23:59:59.999
  */
-export declare function endOfMonth<DateType extends Date>(date: DateType | number | string): DateType;
+export declare function endOfMonth<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, options?: EndOfMonthOptions<ResultDate> | undefined): ResultDate;

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

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link endOfQuarter} function options.
+ */
+export interface EndOfQuarterOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name endOfQuarter
  * @category Quarter Helpers
@@ -8,8 +14,10 @@
  * The result will be in the local timezone.
  *
  * @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 original date
+ * @param options - An object with options
  *
  * @returns The end of a quarter
  *
@@ -18,4 +26,4 @@
  * const result = endOfQuarter(new Date(2014, 8, 2, 11, 55, 0))
  * //=> Tue Sep 30 2014 23:59:59.999
  */
-export declare function endOfQuarter<DateType extends Date>(date: DateType | number | string): DateType;
+export declare function endOfQuarter<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, options?: EndOfQuarterOptions<ResultDate> | undefined): ResultDate;

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

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link endOfSecond} function options.
+ */
+export interface EndOfSecondOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name endOfSecond
  * @category Second Helpers
@@ -5,11 +11,13 @@
  *
  * @description
  * Return the end of a second for the given date.
- * The result will be in the local timezone.
+ * The result will be in the local timezone if no `in` option is specified.
  *
  * @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 original date
+ * @param options - An object with options
  *
  * @returns The end of a second
  *
@@ -18,4 +26,4 @@
  * const result = endOfSecond(new Date(2014, 11, 1, 22, 15, 45, 400))
  * //=> Mon Dec 01 2014 22:15:45.999
  */
-export declare function endOfSecond<DateType extends Date>(date: DateType | number | string): DateType;
+export declare function endOfSecond<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, options?: EndOfSecondOptions<ResultDate> | undefined): ResultDate;

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

@@ -1,3 +1,9 @@
+import type { ContextOptions } from '../types.ts';
+/**
+ * The {@link endOfToday} function options.
+ */
+export interface EndOfTodayOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name endOfToday
  * @category Day Helpers
@@ -8,6 +14,9 @@
  * Return the end of today.
  *
  * @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 options - The options
  *
  * @returns The end of today
  *
@@ -16,4 +25,4 @@
  * const result = endOfToday()
  * //=> Mon Oct 6 2014 23:59:59.999
  */
-export declare function endOfToday(): Date;
+export declare function endOfToday<ResultDate extends Date = Date>(options?: EndOfTodayOptions<ResultDate>): ResultDate;

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

@@ -1,3 +1,9 @@
+import type { ContextOptions } from '../types.ts';
+/**
+ * The {@link endOfTomorrow} function options.
+ */
+export interface EndOfTomorrowOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name endOfTomorrow
  * @category Day Helpers
@@ -8,7 +14,9 @@
  * Return the end of tomorrow.
  *
  * @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 options - The options
  * @returns The end of tomorrow
  *
  * @example
@@ -16,4 +24,4 @@
  * const result = endOfTomorrow()
  * //=> Tue Oct 7 2014 23:59:59.999
  */
-export declare function endOfTomorrow(): Date;
+export declare function endOfTomorrow<DateType extends Date, ResultDate extends Date = DateType>(options?: EndOfTomorrowOptions<ResultDate> | undefined): ResultDate;

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

@@ -1,8 +1,8 @@
-import type { LocalizedOptions, WeekOptions } from '../types';
+import type { ContextOptions, DateArg, LocalizedOptions, WeekOptions } from '../types.ts';
 /**
  * The {@link endOfWeek} function options.
  */
-export interface EndOfWeekOptions extends WeekOptions, LocalizedOptions<'options'> {
+export interface EndOfWeekOptions<DateType extends Date = Date> extends WeekOptions, LocalizedOptions<'options'>, ContextOptions<DateType> {
 }
 /**
  * @name endOfWeek
@@ -14,6 +14,7 @@ export interface EndOfWeekOptions extends WeekOptions, LocalizedOptions<'options
  * The result will be in the local timezone.
  *
  * @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 original date
  * @param options - An object with options
@@ -30,4 +31,4 @@ export interface EndOfWeekOptions extends WeekOptions, LocalizedOptions<'options
  * const result = endOfWeek(new Date(2014, 8, 2, 11, 55, 0), { weekStartsOn: 1 })
  * //=> Sun Sep 07 2014 23:59:59.999
  */
-export declare function endOfWeek<DateType extends Date>(date: DateType | number | string, options?: EndOfWeekOptions): DateType;
+export declare function endOfWeek<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, options?: EndOfWeekOptions<ResultDate>): ResultDate;

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

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link endOfYear} function options.
+ */
+export interface EndOfYearOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name endOfYear
  * @category Year Helpers
@@ -8,14 +14,16 @@
  * The result will be in the local timezone.
  *
  * @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 original date
+ * @param options - The options
  *
  * @returns The end of a year
  *
  * @example
  * // The end of a year for 2 September 2014 11:55:00:
- * const result = endOfYear(new Date(2014, 8, 2, 11, 55, 00))
+ * const result = endOfYear(new Date(2014, 8, 2, 11, 55, 0))
  * //=> Wed Dec 31 2014 23:59:59.999
  */
-export declare function endOfYear<DateType extends Date>(date: DateType | number | string): DateType;
+export declare function endOfYear<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, options?: EndOfYearOptions<ResultDate>): ResultDate;

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

@@ -1,3 +1,9 @@
+import type { ContextOptions } from '../types.ts';
+/**
+ * The {@link endOfYesterday} function options.
+ */
+export interface EndOfYesterdayOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name endOfYesterday
  * @category Day Helpers
@@ -8,6 +14,7 @@
  * Return the end of yesterday.
  *
  * @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.
  *
  * @returns The end of yesterday
  *
@@ -16,4 +23,4 @@
  * const result = endOfYesterday()
  * //=> Sun Oct 5 2014 23:59:59.999
  */
-export declare function endOfYesterday(): Date;
+export declare function endOfYesterday<DateType extends Date, ResultDate extends Date = DateType>(options?: EndOfYesterdayOptions<ResultDate> | undefined): ResultDate;

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

@@ -1,13 +1,13 @@
-import { formatters } from '../_lib/format/formatters/index';
-import { longFormatters } from '../_lib/format/longFormatters/index';
-import type { AdditionalTokensOptions, FirstWeekContainsDateOptions, LocalizedOptions, WeekOptions } from '../types';
+import { formatters } from '../_lib/format/formatters/index.ts';
+import { longFormatters } from '../_lib/format/longFormatters/index.ts';
+import type { AdditionalTokensOptions, ContextOptions, DateArg, FirstWeekContainsDateOptions, LocalizedOptions, WeekOptions } from '../types.ts';
 export { formatters, longFormatters };
 export { format as formatDate };
 export type { FormatOptions as FormatDateOptions };
 /**
  * The {@link format} function options.
  */
-export interface FormatOptions extends LocalizedOptions<'options' | 'localize' | 'formatLong'>, WeekOptions, FirstWeekContainsDateOptions, AdditionalTokensOptions {
+export interface FormatOptions extends LocalizedOptions<'options' | 'localize' | 'formatLong'>, WeekOptions, FirstWeekContainsDateOptions, AdditionalTokensOptions, ContextOptions<Date> {
 }
 /**
  * @name format
@@ -260,8 +260,6 @@ export interface FormatOptions extends LocalizedOptions<'options' | 'localize' |
  * 9. `D` and `DD` tokens represent days of the year but they are often confused with days of the month.
  *    You should enable `options.useAdditionalDayOfYearTokens` to use them. See: https://github.com/date-fns/date-fns/blob/master/docs/unicodeTokens.md
  *
- * @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 original date
  * @param format - The string of tokens
  * @param options - An object with options
@@ -295,4 +293,4 @@ export interface FormatOptions extends LocalizedOptions<'options' | 'localize' |
  * const result = format(new Date(2014, 6, 2, 15), "h 'o''clock'")
  * //=> "3 o'clock"
  */
-export declare function format<DateType extends Date>(date: DateType | number | string, formatStr: string, options?: FormatOptions): string;
+export declare function format(date: DateArg<Date> & {}, formatStr: string, options?: FormatOptions): string;

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

@@ -1,8 +1,8 @@
-import type { LocalizedOptions } from '../types';
+import type { ContextOptions, DateArg, LocalizedOptions } from '../types.ts';
 /**
  * The {@link formatDistance} function options.
  */
-export interface FormatDistanceOptions extends LocalizedOptions<'formatDistance'> {
+export interface FormatDistanceOptions extends LocalizedOptions<'formatDistance'>, ContextOptions<Date> {
     /** Distances less than a minute are more detailed */
     includeSeconds?: boolean;
     /** Add "X ago"/"in X" in the locale language */
@@ -45,10 +45,8 @@ export interface FormatDistanceOptions extends LocalizedOptions<'formatDistance'
  * | 40 secs ... 60 secs    | less than a minute   |
  * | 60 secs ... 90 secs    | 1 minute             |
  *
- * @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 date
- * @param baseDate - The date to compare with
+ * @param laterDate - The date
+ * @param earlierDate - The date to compare with
  * @param options - An object with options
  *
  * @returns The distance in words
@@ -88,4 +86,4 @@ export interface FormatDistanceOptions extends LocalizedOptions<'formatDistance'
  * })
  * //=> 'pli ol 1 jaro'
  */
-export declare function formatDistance<DateType extends Date>(date: DateType | number | string, baseDate: DateType | number | string, options?: FormatDistanceOptions): string;
+export declare function formatDistance(laterDate: DateArg<Date> & {}, earlierDate: DateArg<Date> & {}, options?: FormatDistanceOptions): string;

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

@@ -1,8 +1,8 @@
-import type { LocalizedOptions, RoundingOptions } from '../types';
+import type { ContextOptions, DateArg, LocalizedOptions, RoundingOptions } from '../types.ts';
 /**
  * The {@link formatDistanceStrict} function options.
  */
-export interface FormatDistanceStrictOptions extends LocalizedOptions<'formatDistance'>, RoundingOptions {
+export interface FormatDistanceStrictOptions extends LocalizedOptions<'formatDistance'>, RoundingOptions, ContextOptions<Date> {
     /** Add "X ago"/"in X" in the locale language */
     addSuffix?: boolean;
     /** If specified, will force the unit */
@@ -31,10 +31,8 @@ export type FormatDistanceStrictUnit = 'second' | 'minute' | 'hour' | 'day' | 'm
  * | 1 ... 11 months        | [1..11] months      |
  * | 1 ... N years          | [1..N]  years       |
  *
- * @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 date
- * @param baseDate - The date to compare with
+ * @param laterDate - The date
+ * @param earlierDate - The date to compare with
  * @param options - An object with options
  *
  * @returns The distance in words
@@ -91,4 +89,4 @@ export type FormatDistanceStrictUnit = 'second' | 'minute' | 'hour' | 'day' | 'm
  * })
  * //=> '1 jaro'
  */
-export declare function formatDistanceStrict<DateType extends Date>(date: DateType | number | string, baseDate: DateType | number | string, options?: FormatDistanceStrictOptions): string;
+export declare function formatDistanceStrict(laterDate: DateArg<Date> & {}, earlierDate: DateArg<Date> & {}, options?: FormatDistanceStrictOptions): string;

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

@@ -1,8 +1,9 @@
-import type { FormatDistanceOptions } from '../formatDistance/index';
+import type { FormatDistanceOptions } from '../formatDistance/index.ts';
+import type { ContextOptions, DateArg } from '../types.ts';
 /**
  * The {@link formatDistanceToNow} function options.
  */
-export interface FormatDistanceToNowOptions extends FormatDistanceOptions {
+export interface FormatDistanceToNowOptions extends FormatDistanceOptions, ContextOptions<Date> {
 }
 /**
  * @name formatDistanceToNow
@@ -42,8 +43,6 @@ export interface FormatDistanceToNowOptions extends FormatDistanceOptions {
  * | 40 secs ... 60 secs | less than a minute   |
  * | 60 secs ... 90 secs | 1 minute             |
  *
- * @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 given date
  * @param options - The object with options
  *
@@ -87,4 +86,4 @@ export interface FormatDistanceToNowOptions extends FormatDistanceOptions {
  * )
  * //=> 'pli ol 1 jaro'
  */
-export declare function formatDistanceToNow<DateType extends Date>(date: DateType | number | string, options?: FormatDistanceToNowOptions): string;
+export declare function formatDistanceToNow(date: DateArg<Date> & {}, options?: FormatDistanceToNowOptions): string;

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

@@ -1,8 +1,9 @@
-import type { FormatDistanceStrictOptions } from '../formatDistanceStrict/index';
+import type { FormatDistanceStrictOptions } from '../formatDistanceStrict/index.ts';
+import type { ContextOptions, DateArg } from '../types.ts';
 /**
  * The {@link formatDistanceToNowStrict} function options.
  */
-export interface FormatDistanceToNowStrictOptions extends FormatDistanceStrictOptions {
+export interface FormatDistanceToNowStrictOptions extends FormatDistanceStrictOptions, ContextOptions<Date> {
 }
 /**
  * @name formatDistanceToNowStrict
@@ -24,8 +25,6 @@ export interface FormatDistanceToNowStrictOptions extends FormatDistanceStrictOp
  * | 1 ... 11 months        | [1..11] months      |
  * | 1 ... N years          | [1..N]  years       |
  *
- * @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 given date
  * @param options - An object with options.
  *
@@ -77,4 +76,4 @@ export interface FormatDistanceToNowStrictOptions extends FormatDistanceStrictOp
  * )
  * //=> '1 jaro'
  */
-export declare function formatDistanceToNowStrict<DateType extends Date>(date: DateType | number | string, options?: FormatDistanceToNowStrictOptions): string;
+export declare function formatDistanceToNowStrict(date: DateArg<Date> & {}, options?: FormatDistanceToNowStrictOptions): string;

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

@@ -1,4 +1,4 @@
-import type { Duration, DurationUnit, LocalizedOptions } from '../types';
+import type { Duration, DurationUnit, LocalizedOptions } from '../types.ts';
 /**
  * The {@link formatDuration} function options.
  */
@@ -18,8 +18,6 @@ export interface FormatDurationOptions extends LocalizedOptions<'formatDistance'
  * @description
  * Return human-readable duration string i.e. "9 months 2 days"
  *
- * @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 duration - The duration to format
  * @param options - An object with options.
  *

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

@@ -1,8 +1,8 @@
-import type { ISOFormatOptions } from '../types';
+import type { ContextOptions, DateArg, ISOFormatOptions } from '../types.ts';
 /**
  * The {@link formatISO} function options.
  */
-export interface FormatISOOptions extends ISOFormatOptions {
+export interface FormatISOOptions extends ISOFormatOptions, ContextOptions<Date> {
 }
 /**
  * @name formatISO
@@ -12,12 +12,10 @@ export interface FormatISOOptions extends ISOFormatOptions {
  * @description
  * Return the formatted date string in ISO 8601 format. Options may be passed to control the parts and notations of the 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 date - The original date
  * @param options - An object with options.
  *
- * @returns The formatted date string (in loca.l time zone)
+ * @returns The formatted date string (in local time zone)
  *
  * @throws `date` must not be Invalid Date
  *
@@ -41,4 +39,4 @@ export interface FormatISOOptions extends ISOFormatOptions {
  * const result = formatISO(new Date(2019, 8, 18, 19, 0, 52), { representation: 'time' })
  * //=> '19:00:52Z'
  */
-export declare function formatISO<DateType extends Date>(date: DateType | number | string, options?: FormatISOOptions): string;
+export declare function formatISO(date: DateArg<Date> & {}, options?: FormatISOOptions): string;

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

@@ -1,8 +1,8 @@
-import type { ISOFormatOptions } from '../types';
+import type { ContextOptions, DateArg, ISOFormatOptions } from '../types.ts';
 /**
  * The {@link formatISO9075} function options.
  */
-export interface FormatISO9075Options extends ISOFormatOptions {
+export interface FormatISO9075Options extends ISOFormatOptions, ContextOptions<Date> {
 }
 /**
  * @name formatISO9075
@@ -12,8 +12,6 @@ export interface FormatISO9075Options extends ISOFormatOptions {
  * @description
  * Return the formatted date string in ISO 9075 format. Options may be passed to control the parts and notations of the 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 date - The original date
  * @param options - An object with options.
  *
@@ -41,4 +39,4 @@ export interface FormatISO9075Options extends ISOFormatOptions {
  * const result = formatISO9075(new Date(2019, 8, 18, 19, 0, 52), { representation: 'time' })
  * //=> '19:00:52'
  */
-export declare function formatISO9075<DateType extends Date>(date: DateType | number | string, options?: FormatISO9075Options): string;
+export declare function formatISO9075(date: DateArg<Date> & {}, options?: FormatISO9075Options): string;