@checkdigit/time 3.0.0-PR.17-58cd → 4.0.0-PR.18-9134

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

@@ -8,9 +8,12 @@
  *
  * ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_date
  *
- * @param dateLeft - the later date
- * @param dateRight - the earlier date
- * @returns the number of full ISO week-numbering 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 dateLeft - The later date
+ * @param dateRight - The earlier date
+ *
+ * @returns The number of full ISO week-numbering years
  *
  * @example
  * // How many full ISO week-numbering years are between 1 January 2010 and 1 January 2012?
@@ -20,4 +23,4 @@
  * )
  * //=> 1
  */
-export default function differenceInISOWeekYears<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): number;
+export declare function differenceInISOWeekYears<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string): number;

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

@@ -6,9 +6,12 @@
  * @description
  * Get the number of milliseconds between the given dates.
  *
- * @param dateLeft - the later date
- * @param dateRight - the earlier date
- * @returns the number of milliseconds
+ * @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
+ *
+ * @returns The number of milliseconds
  *
  * @example
  * // How many milliseconds are between
@@ -19,4 +22,4 @@
  * )
  * //=> 1100
  */
-export default function differenceInMilliseconds<DateType extends Date>(dateLeft: DateType | number, dateRight: DateType | number): number;
+export declare function differenceInMilliseconds<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string): number;

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

@@ -1,4 +1,4 @@
-import type { RoundingOptions } from '../types';
+import type { RoundingOptions } from "../types";
 /**
  * The {@link differenceInMinutes} function options.
  */
@@ -12,10 +12,13 @@ export interface DifferenceInMinutesOptions extends RoundingOptions {
  * @description
  * Get the signed number of full (rounded towards 0) minutes between the given dates.
  *
- * @param dateLeft - the later date
- * @param dateRight - the earlier date
- * @param options - an object with options.
- * @returns the number of minutes
+ * @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 options - An object with options.
+ *
+ * @returns The number of minutes
  *
  * @example
  * // How many minutes are between 2 July 2014 12:07:59 and 2 July 2014 12:20:00?
@@ -33,4 +36,4 @@ export interface DifferenceInMinutesOptions extends RoundingOptions {
  * )
  * //=> -1
  */
-export default function differenceInMinutes<DateType extends Date>(dateLeft: DateType | number, dateRight: DateType | number, options?: DifferenceInMinutesOptions): number;
+export declare function differenceInMinutes<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string, options?: DifferenceInMinutesOptions): number;

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

@@ -6,13 +6,16 @@
  * @description
  * Get the number of full months between the given dates using trunc as a default rounding method.
  *
- * @param dateLeft - the later date
- * @param dateRight - the earlier date
- * @returns the number of full months
+ * @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
+ *
+ * @returns The number of full months
  *
  * @example
  * // How many full months are between 31 January 2014 and 1 September 2014?
  * const result = differenceInMonths(new Date(2014, 8, 1), new Date(2014, 0, 31))
  * //=> 7
  */
-export default function differenceInMonths<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): number;
+export declare function differenceInMonths<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string): number;

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

@@ -1,4 +1,4 @@
-import type { RoundingOptions } from '../types';
+import type { RoundingOptions } from "../types";
 /**
  * The {@link differenceInQuarters} function options.
  */
@@ -12,14 +12,17 @@ export interface DifferenceInQuartersOptions extends RoundingOptions {
  * @description
  * Get the number of quarters between the given dates.
  *
- * @param dateLeft - the later date
- * @param dateRight - the earlier date
- * @param options - an object with options.
- * @returns the number of full quarters
+ * @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 options - An object with options.
+ *
+ * @returns The number of full quarters
  *
  * @example
  * // How many full quarters are between 31 December 2013 and 2 July 2014?
  * const result = differenceInQuarters(new Date(2014, 6, 2), new Date(2013, 11, 31))
  * //=> 2
  */
-export default function differenceInQuarters<DateType extends Date>(dateLeft: DateType | number, dateRight: DateType | number, options?: DifferenceInQuartersOptions): number;
+export declare function differenceInQuarters<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string, options?: DifferenceInQuartersOptions): number;

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

@@ -1,4 +1,4 @@
-import type { RoundingOptions } from '../types';
+import type { RoundingOptions } from "../types";
 /**
  * The {@link differenceInSeconds} function options.
  */
@@ -12,10 +12,13 @@ export interface DifferenceInSecondsOptions extends RoundingOptions {
  * @description
  * Get the number of seconds between the given dates.
  *
- * @param dateLeft - the later date
- * @param dateRight - the earlier date
- * @param options - an object with options.
- * @returns the number of seconds
+ * @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 options - An object with options.
+ *
+ * @returns The number of seconds
  *
  * @example
  * // How many seconds are between
@@ -26,4 +29,4 @@ export interface DifferenceInSecondsOptions extends RoundingOptions {
  * )
  * //=> 12
  */
-export default function differenceInSeconds<DateType extends Date>(dateLeft: DateType | number, dateRight: DateType | number, options?: DifferenceInSecondsOptions): number;
+export declare function differenceInSeconds<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string, options?: DifferenceInSecondsOptions): number;

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

@@ -1,4 +1,4 @@
-import type { RoundingOptions } from '../types';
+import type { RoundingOptions } from "../types";
 /**
  * The {@link differenceInWeeks} function options.
  */
@@ -18,19 +18,22 @@ export interface DifferenceInWeeksOptions extends RoundingOptions {
  * or more than 7*24 hours if a daylight savings change happens between two dates.
  *
  * To ignore DST and only measure exact 7*24-hour periods, use this instead:
- * `Math.floor(differenceInHours(dateLeft, dateRight)/(7*24))|0`.
+ * `Math.trunc(differenceInHours(dateLeft, dateRight)/(7*24))|0`.
  *
+ * @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 options - an object with options.
- * @returns the number of full weeks
+ * @param dateLeft - The later date
+ * @param dateRight - The earlier date
+ * @param options - An object with options
+ *
+ * @returns The number of full weeks
  *
  * @example
  * // How many full weeks are between 5 July 2014 and 20 July 2014?
  * const result = differenceInWeeks(new Date(2014, 6, 20), new Date(2014, 6, 5))
  * //=> 2
  *
+ * @example
  * // How many full weeks are between
  * // 1 March 2020 0:00 and 6 June 2020 0:00 ?
  * // Note: because local time is used, the
@@ -43,4 +46,4 @@ export interface DifferenceInWeeksOptions extends RoundingOptions {
  * )
  * //=> 8
  */
-export default function differenceInWeeks<DateType extends Date>(dateLeft: DateType | number, dateRight: DateType | number, options?: DifferenceInWeeksOptions): number;
+export declare function differenceInWeeks<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string, options?: DifferenceInWeeksOptions): number;

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

@@ -6,13 +6,16 @@
  * @description
  * Get the number of full years between the given dates.
  *
- * @param dateLeft - the later date
- * @param dateRight - the earlier date
- * @returns the number of full 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 dateLeft - The later date
+ * @param dateRight - The earlier date
+ *
+ * @returns The number of full years
  *
  * @example
  * // How many full years are between 31 December 2013 and 11 February 2015?
  * const result = differenceInYears(new Date(2015, 1, 11), new Date(2013, 11, 31))
  * //=> 1
  */
-export default function differenceInYears<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): number;
+export declare function differenceInYears<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string): number;

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

@@ -1,4 +1,4 @@
-import type { Interval, StepOptions } from '../types';
+import type { Interval, StepOptions } from "../types";
 /**
  * The {@link eachDayOfInterval} function options.
  */
@@ -12,12 +12,12 @@ export interface EachDayOfIntervalOptions extends StepOptions {
  * @description
  * Return the array of dates within the specified time interval.
  *
- * @param interval - the interval. See [Interval]{@link https://date-fns.org/docs/Interval}
- * @param options - an object with options.
- * @returns the array with starts of days from the day of the interval start to the day of the interval end
- * @throws {RangeError} `options.step` must be a number greater than 1
- * @throws {RangeError} The start of an interval cannot be after its end
- * @throws {RangeError} Date in interval cannot be `Invalid 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 interval - The interval.
+ * @param options - An object with options.
+ *
+ * @returns The array with starts of days from the day of the interval start to the day of the interval end
  *
  * @example
  * // Each day between 6 October 2014 and 10 October 2014:
@@ -33,4 +33,4 @@ export interface EachDayOfIntervalOptions extends StepOptions {
  * //   Fri Oct 10 2014 00:00:00
  * // ]
  */
-export default function eachDayOfInterval<DateType extends Date>(interval: Interval<DateType>, options?: EachDayOfIntervalOptions): DateType[];
+export declare function eachDayOfInterval<DateType extends Date>(interval: Interval<DateType>, options?: EachDayOfIntervalOptions): DateType[];

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

@@ -1,4 +1,4 @@
-import type { Interval, StepOptions } from '../types';
+import type { Interval, StepOptions } from "../types";
 /**
  * The {@link eachHourOfInterval} function options.
  */
@@ -12,12 +12,12 @@ export interface EachHourOfIntervalOptions extends StepOptions {
  * @description
  * Return the array of hours within the specified time interval.
  *
- * @param interval - the interval. See [Interval]{@link https://date-fns.org/docs/Interval}
- * @param options - an object with options.
- * @returns the array with starts of hours from the hour of the interval start to the hour of the interval end
- * @throws {RangeError} `options.step` must be a number greater than 1
- * @throws {RangeError} The start of an interval cannot be after its end
- * @throws {RangeError} Date in interval cannot be `Invalid 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 interval - The interval.
+ * @param options - An object with options.
+ *
+ * @returns The array with starts of hours from the hour of the interval start to the hour of the interval end
  *
  * @example
  * // Each hour between 6 October 2014, 12:00 and 6 October 2014, 15:00
@@ -32,4 +32,4 @@ export interface EachHourOfIntervalOptions extends StepOptions {
  * //   Mon Oct 06 2014 15:00:00
  * // ]
  */
-export default function eachHourOfInterval<DateType extends Date>(interval: Interval<DateType>, options?: EachHourOfIntervalOptions): DateType[];
+export declare function eachHourOfInterval<DateType extends Date>(interval: Interval<DateType>, options?: EachHourOfIntervalOptions): DateType[];

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

@@ -1,4 +1,4 @@
-import type { Interval, StepOptions } from '../types';
+import type { Interval, StepOptions } from "../types";
 /**
  * The {@link eachMinuteOfInterval} function options.
  */
@@ -12,12 +12,12 @@ export interface EachMinuteOfIntervalOptions extends StepOptions {
  * @description
  * Returns the array of minutes within the specified time interval.
  *
- * @param interval - the interval. See [Interval]{@link https://date-fns.org/docs/Interval}
- * @param options - an object with options.
- * @returns the array with starts of minutes from the minute of the interval start to the minute of the interval end
- * @throws {RangeError} `options.step` must be a number equal to or greater than 1
- * @throws {RangeError} The start of an interval cannot be after its end
- * @throws {RangeError} Date in interval cannot be `Invalid 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 interval - The interval.
+ * @param options - An object with options.
+ *
+ * @returns The array with starts of minutes from the minute of the interval start to the minute of the interval end
  *
  * @example
  * // Each minute between 14 October 2020, 13:00 and 14 October 2020, 13:03
@@ -32,4 +32,4 @@ export interface EachMinuteOfIntervalOptions extends StepOptions {
  * //   Wed Oct 14 2014 13:03:00
  * // ]
  */
-export default function eachMinuteOfInterval<DateType extends Date>(interval: Interval<DateType>, options?: EachMinuteOfIntervalOptions): DateType[];
+export declare function eachMinuteOfInterval<DateType extends Date>(interval: Interval<DateType>, options?: EachMinuteOfIntervalOptions): DateType[];

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

@@ -1,4 +1,9 @@
-import type { Interval } from '../types';
+import type { Interval, StepOptions } from "../types";
+/**
+ * The {@link eachMonthOfInterval} function options.
+ */
+export interface EachMonthOfIntervalOptions extends StepOptions {
+}
 /**
  * @name eachMonthOfInterval
  * @category Interval Helpers
@@ -7,10 +12,11 @@ import type { Interval } from '../types';
  * @description
  * Return the array of months within the specified time interval.
  *
- * @param interval - the interval. See [Interval]{@link https://date-fns.org/docs/Interval}
- * @returns the array with starts of months from the month of the interval start to the month of the interval end
- * @throws {RangeError} The start of an interval cannot be after its end
- * @throws {RangeError} Date in interval cannot be `Invalid 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 interval - The interval
+ *
+ * @returns The array with starts of months from the month of the interval start to the month of the interval end
  *
  * @example
  * // Each month between 6 February 2014 and 10 August 2014:
@@ -28,4 +34,4 @@ import type { Interval } from '../types';
  * //   Fri Aug 01 2014 00:00:00
  * // ]
  */
-export default function eachMonthOfInterval<DateType extends Date>(interval: Interval<DateType>): DateType[];
+export declare function eachMonthOfInterval<DateType extends Date>(interval: Interval<DateType>, options?: EachMonthOfIntervalOptions): DateType[];

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

@@ -1,4 +1,9 @@
-import type { Interval } from '../types';
+import type { Interval, StepOptions } from "../types";
+/**
+ * The {@link eachQuarterOfInterval} function options.
+ */
+export interface EachQuarterOfIntervalOptions extends StepOptions {
+}
 /**
  * @name eachQuarterOfInterval
  * @category Interval Helpers
@@ -7,10 +12,11 @@ import type { Interval } from '../types';
  * @description
  * Return the array of quarters within the specified time interval.
  *
- * @param interval - the interval. See [Interval]{@link https://date-fns.org/docs/Interval}
- * @returns the array with starts of quarters from the quarter of the interval start to the quarter of the interval end
- * @throws {RangeError} The start of an interval cannot be after its end
- * @throws {RangeError} Date in interval cannot be `Invalid 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 interval - The interval
+ *
+ * @returns The array with starts of quarters from the quarter of the interval start to the quarter of the interval end
  *
  * @example
  * // Each quarter within interval 6 February 2014 - 10 August 2014:
@@ -24,4 +30,4 @@ import type { Interval } from '../types';
  * //   Tue Jul 01 2014 00:00:00,
  * // ]
  */
-export default function eachQuarterOfInterval<DateType extends Date>(interval: Interval<DateType>): DateType[];
+export declare function eachQuarterOfInterval<DateType extends Date>(interval: Interval<DateType>, options?: EachQuarterOfIntervalOptions): DateType[];

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

@@ -1,8 +1,8 @@
-import type { Interval, LocaleOptions, WeekStartOptions } from '../types';
+import type { Interval, LocalizedOptions, StepOptions, WeekOptions } from "../types";
 /**
  * The {@link eachWeekOfInterval} function options.
  */
-export interface EachWeekOfIntervalOptions extends WeekStartOptions, LocaleOptions {
+export interface EachWeekOfIntervalOptions extends StepOptions, WeekOptions, LocalizedOptions<"options"> {
 }
 /**
  * @name eachWeekOfInterval
@@ -12,11 +12,12 @@ export interface EachWeekOfIntervalOptions extends WeekStartOptions, LocaleOptio
  * @description
  * Return the array of weeks within the specified time interval.
  *
- * @param interval - the interval. See [Interval]{@link https://date-fns.org/docs/Interval}
- * @param options - an object with options.
- * @returns the array with starts of weeks from the week of the interval start to the week of the interval end
- * @throws {RangeError} The start of an interval cannot be after its end
- * @throws {RangeError} Date in interval cannot be `Invalid 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 interval - The interval.
+ * @param options - An object with options.
+ *
+ * @returns The array with starts of weeks from the week of the interval start to the week of the interval end
  *
  * @example
  * // Each week within interval 6 October 2014 - 23 November 2014:
@@ -35,4 +36,4 @@ export interface EachWeekOfIntervalOptions extends WeekStartOptions, LocaleOptio
  * //   Sun Nov 23 2014 00:00:00
  * // ]
  */
-export default function eachWeekOfInterval<DateType extends Date>(interval: Interval<DateType>, options?: EachWeekOfIntervalOptions): DateType[];
+export declare function eachWeekOfInterval<DateType extends Date>(interval: Interval<DateType>, options?: EachWeekOfIntervalOptions): DateType[];

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

@@ -1,4 +1,4 @@
-import type { Interval } from '../types';
+import type { Interval } from "../types";
 /**
  * @name eachWeekendOfInterval
  * @category Interval Helpers
@@ -7,10 +7,11 @@ import type { Interval } from '../types';
  * @description
  * Get all the Saturdays and Sundays in the given date interval.
  *
- * @param interval - the given interval. See [Interval]{@link https://date-fns.org/docs/Interval}
- * @returns an array containing all the Saturdays and Sundays
- * @throws {RangeError} The start of an interval cannot be after its end
- * @throws {RangeError} Date in interval cannot be `Invalid 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 interval - The given interval
+ *
+ * @returns An array containing all the Saturdays and Sundays
  *
  * @example
  * // Lists all Saturdays and Sundays in the given date interval
@@ -25,4 +26,4 @@ import type { Interval } from '../types';
  * //   Sun Sep 30 2018 00:00:00
  * // ]
  */
-export default function eachWeekendOfInterval<DateType extends Date>(interval: Interval<DateType>): DateType[];
+export declare function eachWeekendOfInterval<DateType extends Date>(interval: Interval<DateType>): DateType[];

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

@@ -6,9 +6,11 @@
  * @description
  * Get all the Saturdays and Sundays in the given month.
  *
- * @param date - the given month
- * @returns an array containing all the Saturdays and Sundays
- * @throws {RangeError} The passed date is invalid
+ * @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 month
+ *
+ * @returns An array containing all the Saturdays and Sundays
  *
  * @example
  * // Lists all Saturdays and Sundays in the given month
@@ -24,4 +26,4 @@
  * //   Sun Feb 27 2022 00:00:00
  * // ]
  */
-export default function eachWeekendOfMonth<DateType extends Date>(dirtyDate: DateType): DateType[];
+export declare function eachWeekendOfMonth<DateType extends Date>(date: DateType): DateType[];

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

@@ -6,9 +6,11 @@
  * @description
  * Get all the Saturdays and Sundays in the year.
  *
- * @param date - the given year
- * @returns an array containing all the Saturdays and Sundays
- * @throws {RangeError} The passed date is invalid
+ * @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 year
+ *
+ * @returns An array containing all the Saturdays and Sundays
  *
  * @example
  * // Lists all Saturdays and Sundays in the year
@@ -21,4 +23,4 @@
  * // ]
  * ]
  */
-export default function eachWeekendOfYear<DateType extends Date>(dirtyDate: DateType | number): DateType[];
+export declare function eachWeekendOfYear<DateType extends Date>(date: DateType | number | string): DateType[];

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

@@ -1,4 +1,9 @@
-import type { Interval } from '../types';
+import type { Interval, StepOptions } from "../types";
+/**
+ * The {@link eachYearOfInterval} function options.
+ */
+export interface EachYearOfIntervalOptions extends StepOptions {
+}
 /**
  * @name eachYearOfInterval
  * @category Interval Helpers
@@ -7,10 +12,11 @@ import type { Interval } from '../types';
  * @description
  * Return the array of yearly timestamps within the specified time interval.
  *
- * @param interval - the interval. See [Interval]{@link https://date-fns.org/docs/Interval}
- * @returns the array with starts of yearly timestamps from the month of the interval start to the month of the interval end
- * @throws {RangeError} The start of an interval cannot be after its end
- * @throws {RangeError} Date in interval cannot be `Invalid 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 interval - The interval.
+ *
+ * @returns The array with starts of yearly timestamps from the month of the interval start to the month of the interval end
  *
  * @example
  * // Each year between 6 February 2014 and 10 August 2017:
@@ -25,4 +31,4 @@ import type { Interval } from '../types';
  * //   Sun Jan 01 2017 00:00:00
  * // ]
  */
-export default function eachYearOfInterval<DateType extends Date>(interval: Interval<DateType>): DateType[];
+export declare function eachYearOfInterval<DateType extends Date>(interval: Interval<DateType>, options?: EachYearOfIntervalOptions): DateType[];

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

@@ -7,12 +7,15 @@
  * Return the end of a day for the given date.
  * The result will be in the local timezone.
  *
- * @param date - the original date
- * @returns the end of a 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 date - The original date
+ *
+ * @returns The end of a day
  *
  * @example
  * // The end of a day for 2 September 2014 11:55:00:
  * const result = endOfDay(new Date(2014, 8, 2, 11, 55, 0))
  * //=> Tue Sep 02 2014 23:59:59.999
  */
-export default function endOfDay<DateType extends Date>(dirtyDate: DateType | number): DateType;
+export declare function endOfDay<DateType extends Date>(date: DateType | number | string): DateType;

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

@@ -6,12 +6,15 @@
  * @description
  * Return the end of a decade for the given date.
  *
- * @param date - the original date
- * @returns the end of a decade
+ * @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
+ *
+ * @returns The end of a decade
  *
  * @example
  * // The end of a decade for 12 May 1984 00:00:00:
  * const result = endOfDecade(new Date(1984, 4, 12, 00, 00, 00))
  * //=> Dec 31 1989 23:59:59.999
  */
-export default function endOfDecade<DateType extends Date>(dirtyDate: DateType | number): DateType;
+export declare function endOfDecade<DateType extends Date>(date: DateType | number | string): DateType;

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

@@ -7,12 +7,15 @@
  * Return the end of an hour for the given date.
  * The result will be in the local timezone.
  *
- * @param date - the original date
- * @returns the end of an hour
+ * @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
+ *
+ * @returns The end of an hour
  *
  * @example
  * // The end of an hour for 2 September 2014 11:55:00:
  * const result = endOfHour(new Date(2014, 8, 2, 11, 55))
  * //=> Tue Sep 02 2014 11:59:59.999
  */
-export default function endOfHour<DateType extends Date>(dirtyDate: DateType | number): DateType;
+export declare function endOfHour<DateType extends Date>(date: DateType | number | string): DateType;

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

@@ -9,12 +9,15 @@
  *
  * ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_date
  *
- * @param date - the original date
- * @returns the end of an ISO week
+ * @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
+ *
+ * @returns The end of an ISO week
  *
  * @example
  * // The end of an ISO week for 2 September 2014 11:55:00:
  * const result = endOfISOWeek(new Date(2014, 8, 2, 11, 55, 0))
  * //=> Sun Sep 07 2014 23:59:59.999
  */
-export default function endOfISOWeek<DateType extends Date>(dirtyDate: DateType | number): DateType;
+export declare function endOfISOWeek<DateType extends Date>(date: DateType | number | string): DateType;

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

@@ -10,12 +10,15 @@
  *
  * ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_date
  *
- * @param date - the original date
- * @returns the end of an ISO week-numbering 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 original date
+ *
+ * @returns The end of an ISO week-numbering year
  *
  * @example
  * // The end of an ISO week-numbering year for 2 July 2005:
  * const result = endOfISOWeekYear(new Date(2005, 6, 2))
  * //=> Sun Jan 01 2006 23:59:59.999
  */
-export default function endOfISOWeekYear<DateType extends Date>(dirtyDate: DateType | number): DateType;
+export declare function endOfISOWeekYear<DateType extends Date>(date: DateType | number | string): DateType;