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

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

@@ -1,11 +1,18 @@
-import type { NormalizedInterval } from '../types';
+import type { ContextOptions, DateArg, NormalizedInterval } from '../types.ts';
 /**
  * The {@link interval} function options.
  */
-export interface IntervalOptions {
+export interface IntervalOptions<ContextDate extends Date = Date> extends ContextOptions<ContextDate> {
     /** Asserts that the interval is positive (start is after the end). */
     assertPositive?: boolean;
 }
+/**
+ * The {@link interval} function result type. It resolves the proper data type.
+ * It uses the first argument date object type, starting from the start argument,
+ * then the end interval date. If a context function is passed, it uses the context
+ * function return type.
+ */
+export type IntervalResult<StartDate extends DateArg<Date>, EndDate extends DateArg<Date>, Options extends IntervalOptions | undefined = undefined> = NormalizedInterval<Options extends IntervalOptions<infer DateType extends Date> ? DateType : StartDate extends Date ? StartDate : EndDate extends Date ? EndDate : Date>;
 /**
  * @name interval
  * @category Interval Helpers
@@ -14,7 +21,9 @@ export interface IntervalOptions {
  * @description
  * Creates a normalized interval object and validates its values. If the interval is invalid, an exception is thrown.
  *
- * @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 StartDate - Start date type.
+ * @typeParam EndDate - End date type.
+ * @typeParam Options - Options type.
  *
  * @param start - The start of the interval.
  * @param end - The end of the interval.
@@ -26,4 +35,4 @@ export interface IntervalOptions {
  *
  * @returns The normalized and validated interval object.
  */
-export declare function interval<DateType extends Date>(start: DateType | number | string, end: DateType | number | string, options?: IntervalOptions): NormalizedInterval<DateType>;
+export declare function interval<StartDate extends DateArg<Date>, EndDate extends DateArg<Date>, Options extends IntervalOptions | undefined = undefined>(start: StartDate, end: EndDate, options?: Options): IntervalResult<StartDate, EndDate, Options>;

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

@@ -1,15 +1,19 @@
-import type { Duration, Interval } from '../types';
+import type { ContextOptions, Duration, Interval } from '../types.ts';
+/**
+ * The {@link intervalToDuration} function options.
+ */
+export interface IntervalToDurationOptions extends ContextOptions<Date> {
+}
 /**
  * @name intervalToDuration
  * @category Common Helpers
  * @summary Convert interval to duration
  *
  * @description
- * Convert a interval object to a duration object.
- *
- * @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).
+ * Convert an interval object to a duration object.
  *
  * @param interval - The interval to convert to duration
+ * @param options - The context options
  *
  * @returns The duration object
  *
@@ -18,7 +22,7 @@ import type { Duration, Interval } from '../types';
  * intervalToDuration({
  *   start: new Date(1929, 0, 15, 12, 0, 0),
  *   end: new Date(1968, 3, 4, 19, 5, 0)
- * })
- * // => { years: 39, months: 2, days: 20, hours: 7, minutes: 5, seconds: 0 }
+ * });
+ * //=> { years: 39, months: 2, days: 20, hours: 7, minutes: 5, seconds: 0 }
  */
-export declare function intervalToDuration<DateType extends Date>(interval: Interval<DateType>): Duration;
+export declare function intervalToDuration(interval: Interval, options?: IntervalToDurationOptions | undefined): Duration;

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

@@ -1,5 +1,9 @@
+import type { DateArg, MaybeArray } from '../types.ts';
 /**
  * The locale string (see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#locales_argument).
+ * @deprecated
+ *
+ * [TODO] Remove in v4
  */
 export type IntlFormatLocale = Intl.ResolvedDateTimeFormatOptions['locale'];
 /**
@@ -10,8 +14,8 @@ export type IntlFormatFormatOptions = Intl.DateTimeFormatOptions;
  * The locale options.
  */
 export interface IntlFormatLocaleOptions {
-    /** The locale(s) to use (see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#locales_argument) */
-    locale: IntlFormatLocale | IntlFormatLocale[];
+    /** The locales to use (see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#locales_argument) */
+    locale: MaybeArray<Intl.ResolvedDateTimeFormatOptions['locale']>;
 }
 /**
  * @name intlFormat
@@ -25,8 +29,6 @@ export interface IntlFormatLocaleOptions {
  *
  * > ⚠️ Please note that before Node version 13.0.0, only the locale data for en-US is available by default.
  *
- * @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 to format
  *
  * @returns The formatted date string
@@ -38,10 +40,8 @@ export interface IntlFormatLocaleOptions {
  * const result = intlFormat(new Date(2019, 9, 4, 12, 30, 13, 456))
  * //=> 10/4/2019
  */
-export declare function intlFormat<DateType extends Date>(date: DateType | number | string): string;
+export declare function intlFormat(date: DateArg<Date> & {}): 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 date to format
  * @param localeOptions - An object with locale
  *
@@ -57,10 +57,8 @@ export declare function intlFormat<DateType extends Date>(date: DateType | numbe
  * })
  * //=> 2019. 10. 4.
  */
-export declare function intlFormat<DateType extends Date>(date: DateType | number | string, localeOptions: IntlFormatLocaleOptions): string;
+export declare function intlFormat(date: DateArg<Date> & {}, localeOptions: IntlFormatLocaleOptions): 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 date to format
  * @param formatOptions - The format options
  *
@@ -79,10 +77,8 @@ export declare function intlFormat<DateType extends Date>(date: DateType | numbe
  * })
  * //=> 10/4/2019, 12 PM
  */
-export declare function intlFormat<DateType extends Date>(date: DateType | number | string, formatOptions: IntlFormatFormatOptions): string;
+export declare function intlFormat(date: DateArg<Date> & {}, formatOptions: IntlFormatFormatOptions): 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 date to format
  * @param formatOptions - The format options
  * @param localeOptions - An object with locale
@@ -104,4 +100,4 @@ export declare function intlFormat<DateType extends Date>(date: DateType | numbe
  * })
  * //=> Freitag, 4. Oktober 2019
  */
-export declare function intlFormat<DateType extends Date>(date: DateType | number | string, formatOptions: IntlFormatFormatOptions, localeOptions: IntlFormatLocaleOptions): string;
+export declare function intlFormat(date: DateArg<Date> & {}, formatOptions: IntlFormatFormatOptions, localeOptions: IntlFormatLocaleOptions): string;

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

@@ -1,17 +1,12 @@
+import type { ContextOptions, DateArg, MaybeArray } from '../types.ts';
 /**
  * The {@link intlFormatDistance} function options.
  */
-export interface IntlFormatDistanceOptions {
+export interface IntlFormatDistanceOptions extends Intl.RelativeTimeFormatOptions, ContextOptions<Date> {
     /** Force the distance unit */
     unit?: IntlFormatDistanceUnit;
-    /** The locale(s) to use (see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#locales_argument) */
-    locale?: Intl.UnicodeBCP47LocaleIdentifier | Intl.UnicodeBCP47LocaleIdentifier[];
-    /** The locale matching algorithm to use. Other value: 'lookup'. See MDN for details [Locale identification and negotiation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#locale_identification_and_negotiation) */
-    localeMatcher?: Intl.RelativeTimeFormatLocaleMatcher;
-    /** The output message format. The values are 'auto' (e.g. `yesterday`), 'always'(e.g. `1 day ago`) */
-    numeric?: Intl.RelativeTimeFormatNumeric;
-    /** The length of the result. The values are: 'long' (e.g. `1 month`), 'short' (e.g. 'in 1 mo.'), 'narrow' (e.g. 'in 1 mo.'). The narrow one could be similar to the short one for some locales. */
-    style?: Intl.RelativeTimeFormatStyle;
+    /** The locales to use (see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#locales_argument) */
+    locale?: MaybeArray<Intl.ResolvedDateTimeFormatOptions['locale']>;
 }
 /**
  * The unit used to format the distance in {@link intlFormatDistance}.
@@ -47,10 +42,8 @@ export type IntlFormatDistanceUnit = 'year' | 'quarter' | 'month' | 'week' | 'da
  * | 1 year                 | last year      | next year       |
  * | 2+ years               | X years ago    | in X 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.
  * See MDN for details [Locale identification and negotiation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#locale_identification_and_negotiation)
  * The narrow one could be similar to the short one for some locales.
@@ -116,4 +109,4 @@ export type IntlFormatDistanceUnit = 'year' | 'quarter' | 'month' | 'week' | 'da
  * )
  * //=> 'in 2 yr'
  */
-export declare function intlFormatDistance<DateType extends Date>(date: DateType | number | string, baseDate: DateType | number | string, options?: IntlFormatDistanceOptions): string;
+export declare function intlFormatDistance(laterDate: DateArg<Date> & {}, earlierDate: DateArg<Date> & {}, options?: IntlFormatDistanceOptions): string;

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

@@ -1,3 +1,4 @@
+import type { DateArg } from '../types.ts';
 /**
  * @name isAfter
  * @category Common Helpers
@@ -6,8 +7,6 @@
  * @description
  * Is the first date after the second one?
  *
- * @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 that should be after the other one to return true
  * @param dateToCompare - The date to compare with
  *
@@ -18,4 +17,4 @@
  * const result = isAfter(new Date(1989, 6, 10), new Date(1987, 1, 11))
  * //=> true
  */
-export declare function isAfter<DateType extends Date>(date: DateType | number | string, dateToCompare: DateType | number | string): boolean;
+export declare function isAfter(date: DateArg<Date> & {}, dateToCompare: DateArg<Date> & {}): boolean;

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

@@ -1,3 +1,4 @@
+import type { DateArg } from '../types.ts';
 /**
  * @name isBefore
  * @category Common Helpers
@@ -6,8 +7,6 @@
  * @description
  * Is the first date before the second one?
  *
- * @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 that should be before the other one to return true
  * @param dateToCompare - The date to compare with
  *
@@ -18,4 +17,4 @@
  * const result = isBefore(new Date(1989, 6, 10), new Date(1987, 1, 11))
  * //=> false
  */
-export declare function isBefore<DateType extends Date>(date: DateType | number | string, dateToCompare: DateType | number | string): boolean;
+export declare function isBefore(date: DateArg<Date> & {}, dateToCompare: DateArg<Date> & {}): boolean;

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

@@ -1,3 +1,4 @@
+import type { DateArg } from '../types.ts';
 /**
  * @name isEqual
  * @category Common Helpers
@@ -6,8 +7,6 @@
  * @description
  * Are the given dates 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
  *
@@ -21,4 +20,4 @@
  * )
  * //=> false
  */
-export declare function isEqual<DateType extends Date>(leftDate: DateType | number | string, rightDate: DateType | number | string): boolean;
+export declare function isEqual(leftDate: DateArg<Date> & {}, rightDate: DateArg<Date> & {}): boolean;

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

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link isFirstDayOfMonth} function options.
+ */
+export interface IsFirstDayOfMonthOptions extends ContextOptions<Date> {
+}
 /**
  * @name isFirstDayOfMonth
  * @category Month Helpers
@@ -6,10 +12,9 @@
  * @description
  * Is the given date the first day of a month?
  *
- * @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 to check
-
+ * @param options - An object with options
+ *
  * @returns The date is the first day of a month
  *
  * @example
@@ -17,4 +22,4 @@
  * const result = isFirstDayOfMonth(new Date(2014, 8, 1))
  * //=> true
  */
-export declare function isFirstDayOfMonth<DateType extends Date>(date: DateType | number | string): boolean;
+export declare function isFirstDayOfMonth(date: DateArg<Date> & {}, options?: IsFirstDayOfMonthOptions | undefined): boolean;

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

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link isFriday} function options.
+ */
+export interface IsFridayOptions extends ContextOptions<Date> {
+}
 /**
  * @name isFriday
  * @category Weekday Helpers
@@ -6,9 +12,8 @@
  * @description
  * Is the given date Friday?
  *
- * @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 to check
+ * @param options - An object with options
  *
  * @returns The date is Friday
  *
@@ -17,4 +22,4 @@
  * const result = isFriday(new Date(2014, 8, 26))
  * //=> true
  */
-export declare function isFriday<DateType extends Date>(date: DateType | number | string): boolean;
+export declare function isFriday(date: DateArg<Date> & {}, options?: IsFridayOptions | undefined): boolean;

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

@@ -1,3 +1,4 @@
+import type { DateArg } from '../types.ts';
 /**
  * @name isFuture
  * @category Common Helpers
@@ -7,8 +8,6 @@
  * @description
  * Is the given date in the future?
  *
- * @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 to check
  *
  * @returns The date is in the future
@@ -18,4 +17,4 @@
  * const result = isFuture(new Date(2014, 11, 31))
  * //=> true
  */
-export declare function isFuture<DateType extends Date>(date: DateType | number | string): boolean;
+export declare function isFuture(date: DateArg<Date> & {}): boolean;

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

@@ -1,3 +1,6 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+export interface IsLastDayOfMonthOptions extends ContextOptions<Date> {
+}
 /**
  * @name isLastDayOfMonth
  * @category Month Helpers
@@ -6,10 +9,9 @@
  * @description
  * Is the given date the last day of a month?
  *
- * @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 to check
-
+ * @param options - An object with options
+ *
  * @returns The date is the last day of a month
  *
  * @example
@@ -17,4 +19,4 @@
  * const result = isLastDayOfMonth(new Date(2014, 1, 28))
  * //=> true
  */
-export declare function isLastDayOfMonth<DateType extends Date>(date: DateType | number | string): boolean;
+export declare function isLastDayOfMonth(date: DateArg<Date> & {}, options?: IsLastDayOfMonthOptions | undefined): boolean;

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

@@ -1,3 +1,6 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+export interface IsLeapYearOptions extends ContextOptions<Date> {
+}
 /**
  * @name isLeapYear
  * @category Year Helpers
@@ -6,9 +9,8 @@
  * @description
  * Is the given date in the leap year?
  *
- * @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 to check
+ * @param options - The options object
  *
  * @returns The date is in the leap year
  *
@@ -17,4 +19,4 @@
  * const result = isLeapYear(new Date(2012, 8, 1))
  * //=> true
  */
-export declare function isLeapYear<DateType extends Date>(date: DateType | number | string): boolean;
+export declare function isLeapYear(date: DateArg<Date> & {}, options?: IsLeapYearOptions | undefined): boolean;

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

@@ -1,4 +1,4 @@
-import type { AdditionalTokensOptions, FirstWeekContainsDateOptions, LocalizedOptions, WeekOptions } from '../types';
+import type { AdditionalTokensOptions, FirstWeekContainsDateOptions, LocalizedOptions, WeekOptions } from '../types.ts';
 /**
  * The {@link isMatch} function options.
  */
@@ -190,7 +190,7 @@ export interface IsMatchOptions extends LocalizedOptions<'options' | 'match' | '
  *
  *    `format(new Date(2017, 10, 6), 'do MMMM', {locale: cs}) //=> '6. listopadu'`
  *
- *    `isMatch` will try to match both formatting and stand-alone units interchangably.
+ *    `isMatch` will try to match both formatting and stand-alone units interchangeably.
  *
  * 2. Any sequence of the identical letters is a pattern, unless it is escaped by
  *    the single quote characters (see below).
@@ -239,7 +239,7 @@ export interface IsMatchOptions extends LocalizedOptions<'options' | 'match' | '
  * 6. `YY` and `YYYY` tokens represent week-numbering years but they are often confused with years.
  *    You should enable `options.useAdditionalWeekYearTokens` to use them. See: https://github.com/date-fns/date-fns/blob/master/docs/unicodeTokens.md
  *
- * 7. `D` and `DD` tokens represent days of the year but they are ofthen confused with days of the month.
+ * 7. `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
  *
  * 8. `P+` tokens do not have a defined priority since they are merely aliases to other tokens based
@@ -260,8 +260,6 @@ export interface IsMatchOptions extends LocalizedOptions<'options' | 'match' | '
  *
  * If `formatString` matches with `dateString` but does not provides tokens, `referenceDate` will be 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).
- *
  * @param dateStr - The date string to verify
  * @param format - The string of tokens
  * @param options - An object with options.

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

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link isMonday} function options.
+ */
+export interface IsMondayOptions extends ContextOptions<Date> {
+}
 /**
  * @name isMonday
  * @category Weekday Helpers
@@ -6,9 +12,8 @@
  * @description
  * Is the given date Monday?
  *
- * @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 to check
+ * @param options - An object with options
  *
  * @returns The date is Monday
  *
@@ -17,4 +22,4 @@
  * const result = isMonday(new Date(2014, 8, 22))
  * //=> true
  */
-export declare function isMonday<DateType extends Date>(date: DateType | number | string): boolean;
+export declare function isMonday(date: DateArg<Date> & {}, options?: IsMondayOptions | undefined): boolean;

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

@@ -1,3 +1,4 @@
+import type { DateArg } from '../types.ts';
 /**
  * @name isPast
  * @category Common Helpers
@@ -7,8 +8,6 @@
  * @description
  * Is the given date in the past?
  *
- * @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 to check
  *
  * @returns The date is in the past
@@ -18,4 +17,4 @@
  * const result = isPast(new Date(2014, 6, 2))
  * //=> true
  */
-export declare function isPast<DateType extends Date>(date: DateType | number | string): boolean;
+export declare function isPast(date: DateArg<Date> & {}): boolean;

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

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link isSameDay} function options.
+ */
+export interface IsSameDayOptions extends ContextOptions<Date> {
+}
 /**
  * @name isSameDay
  * @category Day Helpers
@@ -6,11 +12,10 @@
  * @description
  * Are the given dates in the same day (and year and month)?
  *
- * @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 first date to check
+ * @param earlierDate - The second date to check
+ * @param options - An object with options
  *
- * @param dateLeft - The first date to check
- * @param dateRight - The second date to check
-
  * @returns The dates are in the same day (and year and month)
  *
  * @example
@@ -28,4 +33,4 @@
  * const result = isSameDay(new Date(2014, 8, 4), new Date(2015, 8, 4))
  * //=> false
  */
-export declare function isSameDay<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string): boolean;
+export declare function isSameDay(laterDate: DateArg<Date> & {}, earlierDate: DateArg<Date> & {}, options?: IsSameDayOptions | undefined): boolean;

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

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link isSameHour} function options.
+ */
+export interface IsSameHourOptions extends ContextOptions<Date> {
+}
 /**
  * @name isSameHour
  * @category Hour Helpers
@@ -6,10 +12,9 @@
  * @description
  * Are the given dates in the same hour (and same day)?
  *
- * @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 check
  * @param dateRight - The second date to check
+ * @param options - An object with options
  *
  * @returns The dates are in the same hour (and same day)
  *
@@ -23,4 +28,4 @@
  * const result = isSameHour(new Date(2014, 8, 4, 6, 0), new Date(2014, 8, 5, 6, 0))
  * //=> false
  */
-export declare function isSameHour<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string): boolean;
+export declare function isSameHour(dateLeft: DateArg<Date> & {}, dateRight: DateArg<Date> & {}, options?: IsSameHourOptions | undefined): boolean;

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

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link isSameISOWeek} function options.
+ */
+export interface IsSameISOWeekOptions extends ContextOptions<Date> {
+}
 /**
  * @name isSameISOWeek
  * @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 first date to check
- * @param dateRight - The second date to check
+ * @param laterDate - The first date to check
+ * @param earlierDate - The second date to check
+ * @param options - An object with options
  *
  * @returns The dates are in the same ISO week (and year)
  *
@@ -25,4 +30,4 @@
  * const result = isSameISOWeek(new Date(2014, 8, 1), new Date(2015, 8, 1))
  * //=> false
  */
-export declare function isSameISOWeek<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string): boolean;
+export declare function isSameISOWeek(laterDate: DateArg<Date> & {}, earlierDate: DateArg<Date> & {}, options?: IsSameISOWeekOptions | undefined): boolean;

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

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link isSameISOWeekYear} function options.
+ */
+export interface IsSameISOWeekYearOptions extends ContextOptions<Date> {
+}
 /**
  * @name isSameISOWeekYear
  * @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 first date to check
- * @param dateRight - The second date to check
+ * @param laterDate - The first date to check
+ * @param earlierDate - The second date to check
+ * @param options - An object with options
  *
  * @returns The dates are in the same ISO week-numbering year
  *
@@ -20,4 +25,4 @@
  * const result = isSameISOWeekYear(new Date(2003, 11, 29), new Date(2005, 0, 2))
  * //=> true
  */
-export declare function isSameISOWeekYear<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string): boolean;
+export declare function isSameISOWeekYear(laterDate: DateArg<Date> & {}, earlierDate: DateArg<Date> & {}, options?: IsSameISOWeekYearOptions | undefined): boolean;

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

@@ -1,3 +1,4 @@
+import type { DateArg } from '../types.ts';
 /**
  * @name isSameMinute
  * @category Minute Helpers
@@ -6,10 +7,8 @@
  * @description
  * Are the given dates in the same minute (and hour and day)?
  *
- * @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 check
- * @param dateRight - The second date to check
+ * @param laterDate - The first date to check
+ * @param earlierDate - The second date to check
  *
  * @returns The dates are in the same minute (and hour and day)
  *
@@ -29,4 +28,4 @@
  * )
  * //=> false
  */
-export declare function isSameMinute<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string): boolean;
+export declare function isSameMinute(laterDate: DateArg<Date> & {}, earlierDate: DateArg<Date> & {}): boolean;

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

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link isSameMonth} function options.
+ */
+export interface IsSameMonthOptions extends ContextOptions<Date> {
+}
 /**
  * @name isSameMonth
  * @category Month Helpers
@@ -6,10 +12,9 @@
  * @description
  * Are the given dates in the same month (and year)?
  *
- * @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 check
- * @param dateRight - The second date to check
+ * @param laterDate - The first date to check
+ * @param earlierDate - The second date to check
+ * @param options - An object with options
  *
  * @returns The dates are in the same month (and year)
  *
@@ -23,4 +28,4 @@
  * const result = isSameMonth(new Date(2014, 8, 2), new Date(2015, 8, 25))
  * //=> false
  */
-export declare function isSameMonth<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string): boolean;
+export declare function isSameMonth(laterDate: DateArg<Date> & {}, earlierDate: DateArg<Date> & {}, options?: IsSameMonthOptions | undefined): boolean;