@checkdigit/time 3.0.0-PR.17-5aaf → 4.0.0-PR.18-81a3

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

@@ -6,13 +6,16 @@
  * @description
  * Add the specified number of year quarters to the given date.
  *
- * @param date - the date to be changed
- * @param amount - the amount of quarters to be added. Positive decimals will be rounded using `Math.floor`, decimals less than zero will be rounded using `Math.ceil`.
- * @returns the new date with the quarters added
+ * @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 be changed
+ * @param amount - The amount of quarters to be added.
+ *
+ * @returns The new date with the quarters added
  *
  * @example
  * // Add 1 quarter to 1 September 2014:
  * const result = addQuarters(new Date(2014, 8, 1), 1)
  * //=> Mon Dec 01 2014 00:00:00
  */
-export default function addQuarters<DateType extends Date>(dirtyDate: DateType | number, amount: number): DateType;
+export declare function addQuarters<DateType extends Date>(date: DateType | number | string, amount: number): DateType;

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

@@ -6,13 +6,16 @@
  * @description
  * Add the specified number of seconds to the given date.
  *
- * @param date - the date to be changed
- * @param amount - the amount of seconds to be added. Positive decimals will be rounded using `Math.floor`, decimals less than zero will be rounded using `Math.ceil`.
- * @returns the new date with the seconds added
+ * @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 be changed
+ * @param amount - The amount of seconds to be added.
+ *
+ * @returns The new date with the seconds added
  *
  * @example
  * // Add 30 seconds to 10 July 2014 12:45:00:
  * const result = addSeconds(new Date(2014, 6, 10, 12, 45, 0), 30)
  * //=> Thu Jul 10 2014 12:45:30
  */
-export default function addSeconds<DateType extends Date>(dirtyDate: DateType | number, amount: number): DateType;
+export declare function addSeconds<DateType extends Date>(date: DateType | number | string, amount: number): DateType;

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

@@ -6,13 +6,16 @@
  * @description
  * Add the specified number of week to the given date.
  *
- * @param date - the date to be changed
- * @param amount - the amount of weeks to be added. Positive decimals will be rounded using `Math.floor`, decimals less than zero will be rounded using `Math.ceil`.
- * @returns the new date with the weeks added
+ * @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 be changed
+ * @param amount - The amount of weeks to be added.
+ *
+ * @returns The new date with the weeks added
  *
  * @example
  * // Add 4 weeks to 1 September 2014:
  * const result = addWeeks(new Date(2014, 8, 1), 4)
  * //=> Mon Sep 29 2014 00:00:00
  */
-export default function addWeeks<DateType extends Date>(dirtyDate: DateType | number, amount: number): DateType;
+export declare function addWeeks<DateType extends Date>(date: DateType | number | string, amount: number): DateType;

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

@@ -6,13 +6,16 @@
  * @description
  * Add the specified number of years to the given date.
  *
- * @param date - the date to be changed
- * @param amount - the amount of years to be added. Positive decimals will be rounded using `Math.floor`, decimals less than zero will be rounded using `Math.ceil`.
- * @returns the new date with the years added
+ * @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 be changed
+ * @param amount - The amount of years to be added.
+ *
+ * @returns The new date with the years added
  *
  * @example
  * // Add 5 years to 1 September 2014:
  * const result = addYears(new Date(2014, 8, 1), 5)
  * //=> Sun Sep 01 2019 00:00:00
  */
-export default function addYears<DateType extends Date>(dirtyDate: DateType | number, amount: number): DateType;
+export declare function addYears<DateType extends Date>(date: DateType | number | string, amount: number): DateType;

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

@@ -3,6 +3,7 @@ import type { Interval } from '../types';
  * The {@link areIntervalsOverlapping} function options.
  */
 export interface AreIntervalsOverlappingOptions {
+    /** Whether the comparison is inclusive or not */
     inclusive?: boolean;
 }
 /**
@@ -11,14 +12,13 @@ export interface AreIntervalsOverlappingOptions {
  * @summary Is the given time interval overlapping with another time interval?
  *
  * @description
- * Is the given time interval overlapping with another time interval? Adjacent intervals do not count as overlapping.
+ * Is the given time interval overlapping with another time interval? Adjacent intervals do not count as overlapping unless `inclusive` is set to `true`.
  *
- * @param intervalLeft - the first interval to compare. See [Interval]{@link https://date-fns.org/docs/Interval}
- * @param intervalRight - the second interval to compare. See [Interval]{@link https://date-fns.org/docs/Interval}
- * @param options - the object with options
- * @returns whether the time intervals are overlapping
- * @throws {RangeError} The start of an interval cannot be after its end
- * @throws {RangeError} Date in interval cannot be `Invalid Date`
+ * @param intervalLeft - The first interval to compare.
+ * @param intervalRight - The second interval to compare.
+ * @param options - The object with options
+ *
+ * @returns Whether the time intervals are overlapping
  *
  * @example
  * // For overlapping time intervals:
@@ -51,6 +51,8 @@ export interface AreIntervalsOverlappingOptions {
  *   { start: new Date(2014, 0, 20), end: new Date(2014, 0, 24) }
  * )
  * //=> false
+ *
+ * @example
  * areIntervalsOverlapping(
  *   { start: new Date(2014, 0, 10), end: new Date(2014, 0, 20) },
  *   { start: new Date(2014, 0, 20), end: new Date(2014, 0, 24) },
@@ -58,4 +60,4 @@ export interface AreIntervalsOverlappingOptions {
  * )
  * //=> true
  */
-export default function areIntervalsOverlapping(intervalLeft: Interval, intervalRight: Interval, options?: AreIntervalsOverlappingOptions): boolean;
+export declare function areIntervalsOverlapping(intervalLeft: Interval, intervalRight: Interval, options?: AreIntervalsOverlappingOptions): boolean;

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

@@ -12,6 +12,13 @@ import type { Interval } from '../types';
  * - When the date is greater than the end of the interval, the end is returned.
  * - Otherwise the date is returned.
  *
+ * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+ *
+ * @param date - The date to be bounded
+ * @param interval - The interval to bound to
+ *
+ * @returns The date bounded by the start and the end of the interval
+ *
  * @example
  * // What is Mar, 21, 2021 bounded to an interval starting at Mar, 22, 2021 and ending at Apr, 01, 2021
  * const result = clamp(new Date(2021, 2, 21), {
@@ -19,9 +26,5 @@ import type { Interval } from '../types';
  *   end: new Date(2021, 3, 1),
  * })
  * //=> Mon Mar 22 2021 00:00:00
- *
- * @param date - the date to be bounded
- * @param interval - the interval to bound to
- * @returns the date bounded by the start and the end of the interval
  */
-export default function clamp<DateType extends Date>(date: DateType | number, { start, end }: Interval): DateType | Date;
+export declare function clamp<DateType extends Date>(date: DateType | number | string, interval: Interval): DateType | Date;

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

@@ -6,9 +6,12 @@
  * @description
  * Return an index of the closest date from the array comparing to the given date.
  *
- * @param dateToCompare - the date to compare with
- * @param datesArray - the array to search
- * @returns an index of the date closest to the given date or undefined if no valid value is given
+ * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+ *
+ * @param dateToCompare - The date to compare with
+ * @param dates - The array to search
+ *
+ * @returns An index of the date closest to the given date or undefined if no valid value is given
  *
  * @example
  * // Which date is closer to 6 September 2015?
@@ -21,4 +24,4 @@
  * const result = closestIndexTo(dateToCompare, datesArray)
  * //=> 1
  */
-export default function closestIndexTo<DateType extends Date>(dirtyDateToCompare: DateType | number, datesArray: Array<DateType | number>): number | undefined;
+export declare function closestIndexTo<DateType extends Date>(dateToCompare: DateType | number | string, dates: Array<DateType | number | string>): number | undefined;

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

@@ -6,9 +6,12 @@
  * @description
  * Return a date from the array closest to the given date.
  *
- * @param dateToCompare - the date to compare with
- * @param datesArray - the array to search
- * @returns the date from the array closest to the given date or undefined if no valid value is given
+ * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+ *
+ * @param dateToCompare - The date to compare with
+ * @param dates - The array to search
+ *
+ * @returns The date from the array closest to the given date or undefined if no valid value is given
  *
  * @example
  * // Which date is closer to 6 September 2015: 1 January 2000 or 1 January 2030?
@@ -19,4 +22,4 @@
  * ])
  * //=> Tue Jan 01 2030 00:00:00
  */
-export default function closestTo<DateType extends Date>(dirtyDateToCompare: DateType | number, datesArray: Array<DateType | number>): DateType | undefined;
+export declare function closestTo<DateType extends Date>(dateToCompare: DateType | number | string, dates: Array<DateType | number | string>): DateType | undefined;

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

@@ -7,9 +7,12 @@
  * Compare the two dates and return 1 if the first date is after the second,
  * -1 if the first date is before the second or 0 if dates are equal.
  *
- * @param dateLeft - the first date to compare
- * @param dateRight - the second date to compare
- * @returns the result of the comparison
+ * @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
+ *
+ * @returns The result of the comparison
  *
  * @example
  * // Compare 11 February 1987 and 10 July 1989:
@@ -29,4 +32,4 @@
  * //   Sun Jul 02 1995 00:00:00
  * // ]
  */
-export default function compareAsc<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): number;
+export declare function compareAsc<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string): number;

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

@@ -7,9 +7,12 @@
  * Compare the two dates and return -1 if the first date is after the second,
  * 1 if the first date is before the second or 0 if dates are equal.
  *
- * @param dateLeft - the first date to compare
- * @param dateRight - the second date to compare
- * @returns the result of the comparison
+ * @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
+ *
+ * @returns The result of the comparison
  *
  * @example
  * // Compare 11 February 1987 and 10 July 1989 reverse chronologically:
@@ -29,4 +32,4 @@
  * //   Wed Feb 11 1987 00:00:00
  * // ]
  */
-export default function compareDesc<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): number;
+export declare function compareDesc<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string): number;

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

@@ -1,211 +1,180 @@
 /**
- * Days in 1 week.
+ * @module constants
+ * @summary Useful constants
+ * @description
+ * Collection of useful date constants.
  *
- * @name daysInWeek
+ * The constants could be imported from `date-fns/constants`:
+ *
+ * ```ts
+ * import { maxTime, minTime } from "date-fns/constants";
+ *
+ * function isAllowedTime(time) {
+ *   return time <= maxTime && time >= minTime;
+ * }
+ * ```
+ */
+/**
  * @constant
- * @type {number}
- * @default
+ * @name daysInWeek
+ * @summary Days in 1 week.
  */
 export declare const daysInWeek = 7;
 /**
- * Days in 1 year
+ * @constant
+ * @name daysInYear
+ * @summary Days in 1 year.
+ *
+ * @description
+ * How many days in a year.
+ *
  * One years equals 365.2425 days according to the formula:
  *
  * > Leap year occures every 4 years, except for years that are divisable by 100 and not divisable by 400.
  * > 1 mean year = (365+1/4-1/100+1/400) days = 365.2425 days
- *
- * @name daysInYear
- * @constant
- * @type {number}
- * @default
  */
-export declare const daysInYear: number;
+export declare const daysInYear = 365.2425;
 /**
- * Maximum allowed time.
- *
- * @name maxTime
  * @constant
- * @type {number}
- * @default
+ * @name maxTime
+ * @summary Maximum allowed time.
+ *
+ * @example
+ * import { maxTime } from "date-fns/constants";
+ *
+ * const isValid = 8640000000000001 <= maxTime;
+ * //=> false
+ *
+ * new Date(8640000000000001);
+ * //=> Invalid Date
  */
 export declare const maxTime: number;
 /**
- * Milliseconds in 1 week.
+ * @constant
+ * @name minTime
+ * @summary Minimum allowed time.
  *
- * @name millisecondsInWeek
+ * @example
+ * import { minTime } from "date-fns/constants";
+ *
+ * const isValid = -8640000000000001 >= minTime;
+ * //=> false
+ *
+ * new Date(-8640000000000001)
+ * //=> Invalid Date
+ */
+export declare const minTime: number;
+/**
  * @constant
- * @type {number}
- * @default
+ * @name millisecondsInWeek
+ * @summary Milliseconds in 1 week.
  */
 export declare const millisecondsInWeek = 604800000;
 /**
- * Milliseconds in 1 day.
- *
- * @name millisecondsInDay
  * @constant
- * @type {number}
- * @default
+ * @name millisecondsInDay
+ * @summary Milliseconds in 1 day.
  */
 export declare const millisecondsInDay = 86400000;
 /**
- * Milliseconds in 1 minute
- *
- * @name millisecondsInMinute
  * @constant
- * @type {number}
- * @default
+ * @name millisecondsInMinute
+ * @summary Milliseconds in 1 minute
  */
 export declare const millisecondsInMinute = 60000;
 /**
- * Milliseconds in 1 hour
- *
- * @name millisecondsInHour
  * @constant
- * @type {number}
- * @default
+ * @name millisecondsInHour
+ * @summary Milliseconds in 1 hour
  */
 export declare const millisecondsInHour = 3600000;
 /**
- * Milliseconds in 1 second
- *
- * @name millisecondsInSecond
  * @constant
- * @type {number}
- * @default
+ * @name millisecondsInSecond
+ * @summary Milliseconds in 1 second
  */
 export declare const millisecondsInSecond = 1000;
 /**
- * Minimum allowed time.
- *
- * @name minTime
  * @constant
- * @type {number}
- * @default
- */
-export declare const minTime: number;
-/**
- * Minutes in 1 year.
- *
  * @name minutesInYear
- * @constant
- * @type {number}
- * @default
+ * @summary Minutes in 1 year.
  */
 export declare const minutesInYear = 525600;
 /**
- * Minutes in 1 month.
- *
- * @name minutesInMonth
  * @constant
- * @type {number}
- * @default
+ * @name minutesInMonth
+ * @summary Minutes in 1 month.
  */
 export declare const minutesInMonth = 43200;
 /**
- * Minutes in 1 day.
- *
- * @name minutesInDay
  * @constant
- * @type {number}
- * @default
+ * @name minutesInDay
+ * @summary Minutes in 1 day.
  */
 export declare const minutesInDay = 1440;
 /**
- * Minutes in 1 hour.
- *
- * @name minutesInHour
  * @constant
- * @type {number}
- * @default
+ * @name minutesInHour
+ * @summary Minutes in 1 hour.
  */
 export declare const minutesInHour = 60;
 /**
- * Months in 1 quarter.
- *
- * @name monthsInQuarter
  * @constant
- * @type {number}
- * @default
+ * @name monthsInQuarter
+ * @summary Months in 1 quarter.
  */
 export declare const monthsInQuarter = 3;
 /**
- * Months in 1 year.
- *
- * @name monthsInYear
  * @constant
- * @type {number}
- * @default
+ * @name monthsInYear
+ * @summary Months in 1 year.
  */
 export declare const monthsInYear = 12;
 /**
- * Quarters in 1 year
- *
- * @name quartersInYear
  * @constant
- * @type {number}
- * @default
+ * @name quartersInYear
+ * @summary Quarters in 1 year
  */
 export declare const quartersInYear = 4;
 /**
- * Seconds in 1 hour.
- *
- * @name secondsInHour
  * @constant
- * @type {number}
- * @default
+ * @name secondsInHour
+ * @summary Seconds in 1 hour.
  */
 export declare const secondsInHour = 3600;
 /**
- * Seconds in 1 minute.
- *
- * @name secondsInMinute
  * @constant
- * @type {number}
- * @default
+ * @name secondsInMinute
+ * @summary Seconds in 1 minute.
  */
 export declare const secondsInMinute = 60;
 /**
- * Seconds in 1 day.
- *
- * @name secondsInDay
  * @constant
- * @type {number}
- * @default
+ * @name secondsInDay
+ * @summary Seconds in 1 day.
  */
 export declare const secondsInDay: number;
 /**
- * Seconds in 1 week.
- *
- * @name secondsInWeek
  * @constant
- * @type {number}
- * @default
+ * @name secondsInWeek
+ * @summary Seconds in 1 week.
  */
 export declare const secondsInWeek: number;
 /**
- * Seconds in 1 year.
- *
- * @name secondsInYear
  * @constant
- * @type {number}
- * @default
+ * @name secondsInYear
+ * @summary Seconds in 1 year.
  */
 export declare const secondsInYear: number;
 /**
- * Seconds in 1 month
- *
- * @name secondsInMonth
  * @constant
- * @type {number}
- * @default
+ * @name secondsInMonth
+ * @summary Seconds in 1 month
  */
 export declare const secondsInMonth: number;
 /**
- * Seconds in 1 quarter.
- *
- * @name secondsInQuarter
  * @constant
- * @type {number}
- * @default
+ * @name secondsInQuarter
+ * @summary Seconds in 1 quarter.
  */
 export declare const secondsInQuarter: number;

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

@@ -1,6 +1,6 @@
 /**
  * @name constructFrom
- * @category Date Extension Helpers
+ * @category Generic Helpers
  * @summary Constructs a date using the reference date and the value
  *
  * @description
@@ -8,9 +8,14 @@
  * date and the given value. It helps to build generic functions that accept
  * date extensions.
  *
- * @param date {Date|number} - the reference date to take constructor from
- * @param value {Date|number} - the value to create the date
- * @returns date initialized using the given date and value
+ * It defaults to `Date` if the passed reference date is a number or a string.
+ *
+ * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+ *
+ * @param date - The reference date to take constructor from
+ * @param value - The value to create the date
+ *
+ * @returns Date initialized using the given date and value
  *
  * @example
  * import { constructFrom } from 'date-fns'
@@ -23,4 +28,4 @@
  *   )
  * }
  */
-export default function constructFrom<DateType extends Date>(date: DateType | number, value: Date | number): DateType;
+export declare function constructFrom<DateType extends Date>(date: DateType | number | string, value: Date | number | string): DateType;

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

@@ -0,0 +1,31 @@
+/**
+ * @name constructNow
+ * @category Generic Helpers
+ * @summary Constructs a new current date using the passed value constructor.
+ * @pure false
+ *
+ * @description
+ * The function constructs a new current date using the constructor from
+ * the reference date. It helps to build generic functions that accept date
+ * extensions and use the current date.
+ *
+ * It defaults to `Date` if the passed reference date is a number or a string.
+ *
+ * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+ *
+ * @param date - The reference date to take constructor from
+ *
+ * @returns Current date initialized using the given date constructor
+ *
+ * @example
+ * import { constructNow, isSameDay } from 'date-fns'
+ *
+ * function isToday<DateType extends Date>(
+ *   date: DateType | number | string,
+ * ): boolean {
+ *   // If we were to use `new Date()` directly, the function would  behave
+ *   // differently in different timezones and return false for the same date.
+ *   return isSameDay(date, constructNow(date));
+ * }
+ */
+export declare function constructNow<DateType extends Date>(date: DateType | number | string): DateType;

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

@@ -6,9 +6,11 @@
  * @description
  * Convert a number of days to a full number of weeks.
  *
- * @param days - number of days to be converted
+ * @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).
  *
- * @returns the number of days converted in weeks
+ * @param days - The number of days to be converted
+ *
+ * @returns The number of days converted in weeks
  *
  * @example
  * // Convert 14 days to weeks:
@@ -16,8 +18,8 @@
  * //=> 2
  *
  * @example
- * // It uses floor rounding:
+ * // It uses trunc rounding:
  * const result = daysToWeeks(13)
  * //=> 1
  */
-export default function daysToWeeks(days: number): number;
+export declare function daysToWeeks(days: number): number;

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

@@ -9,9 +9,12 @@
  * Like `differenceInCalendarDays`, the function removes the times from
  * the dates before calculating the difference.
  *
- * @param dateLeft - the later date
- * @param dateRight - the earlier date
- * @returns the number of business 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 dateLeft - The later date
+ * @param dateRight - The earlier date
+ *
+ * @returns The number of business days
  *
  * @example
  * // How many business days are between
@@ -46,4 +49,4 @@
  * )
  * //=> 0
  */
-export default function differenceInBusinessDays<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): number;
+export declare function differenceInBusinessDays<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string): number;