@checkdigit/time 1.0.0

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

@@ -0,0 +1,27 @@
+import type { Interval } from '../types';
+/**
+ * @name clamp
+ * @category Interval Helpers
+ * @summary Return a date bounded by the start and the end of the given interval
+ *
+ * @description
+ * Clamps a date to the lower bound with the start of the interval and the upper
+ * bound with the end of the interval.
+ *
+ * - When the date is less than the start of the interval, the start is returned.
+ * - When the date is greater than the end of the interval, the end is returned.
+ * - Otherwise the date is returned.
+ *
+ * @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), {
+ *   start: new Date(2021, 2, 22),
+ *   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;

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

@@ -0,0 +1,24 @@
+/**
+ * @name closestIndexTo
+ * @category Common Helpers
+ * @summary Return an index of the closest date from the array comparing to the given date.
+ *
+ * @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
+ *
+ * @example
+ * // Which date is closer to 6 September 2015?
+ * const dateToCompare = new Date(2015, 8, 6)
+ * const datesArray = [
+ *   new Date(2015, 0, 1),
+ *   new Date(2016, 0, 1),
+ *   new Date(2017, 0, 1)
+ * ]
+ * const result = closestIndexTo(dateToCompare, datesArray)
+ * //=> 1
+ */
+export default function closestIndexTo<DateType extends Date>(dirtyDateToCompare: DateType | number, datesArray: Array<DateType | number>): number | undefined;

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

@@ -0,0 +1,22 @@
+/**
+ * @name closestTo
+ * @category Common Helpers
+ * @summary Return a date from the array closest to the given date.
+ *
+ * @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
+ *
+ * @example
+ * // Which date is closer to 6 September 2015: 1 January 2000 or 1 January 2030?
+ * const dateToCompare = new Date(2015, 8, 6)
+ * const result = closestTo(dateToCompare, [
+ *   new Date(2000, 0, 1),
+ *   new Date(2030, 0, 1)
+ * ])
+ * //=> Tue Jan 01 2030 00:00:00
+ */
+export default function closestTo<DateType extends Date>(dirtyDateToCompare: DateType | number, datesArray: Array<DateType | number>): DateType | undefined;

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

@@ -0,0 +1,32 @@
+/**
+ * @name compareAsc
+ * @category Common Helpers
+ * @summary Compare the two dates and return -1, 0 or 1.
+ *
+ * @description
+ * 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
+ *
+ * @example
+ * // Compare 11 February 1987 and 10 July 1989:
+ * const result = compareAsc(new Date(1987, 1, 11), new Date(1989, 6, 10))
+ * //=> -1
+ *
+ * @example
+ * // Sort the array of dates:
+ * const result = [
+ *   new Date(1995, 6, 2),
+ *   new Date(1987, 1, 11),
+ *   new Date(1989, 6, 10)
+ * ].sort(compareAsc)
+ * //=> [
+ * //   Wed Feb 11 1987 00:00:00,
+ * //   Mon Jul 10 1989 00:00:00,
+ * //   Sun Jul 02 1995 00:00:00
+ * // ]
+ */
+export default function compareAsc<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): number;

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

@@ -0,0 +1,32 @@
+/**
+ * @name compareDesc
+ * @category Common Helpers
+ * @summary Compare the two dates reverse chronologically and return -1, 0 or 1.
+ *
+ * @description
+ * 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
+ *
+ * @example
+ * // Compare 11 February 1987 and 10 July 1989 reverse chronologically:
+ * const result = compareDesc(new Date(1987, 1, 11), new Date(1989, 6, 10))
+ * //=> 1
+ *
+ * @example
+ * // Sort the array of dates in reverse chronological order:
+ * const result = [
+ *   new Date(1995, 6, 2),
+ *   new Date(1987, 1, 11),
+ *   new Date(1989, 6, 10)
+ * ].sort(compareDesc)
+ * //=> [
+ * //   Sun Jul 02 1995 00:00:00,
+ * //   Mon Jul 10 1989 00:00:00,
+ * //   Wed Feb 11 1987 00:00:00
+ * // ]
+ */
+export default function compareDesc<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): number;

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

@@ -0,0 +1,211 @@
+/**
+ * Days in 1 week.
+ *
+ * @name daysInWeek
+ * @constant
+ * @type {number}
+ * @default
+ */
+export declare const daysInWeek = 7;
+/**
+ * Days in 1 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;
+/**
+ * Maximum allowed time.
+ *
+ * @name maxTime
+ * @constant
+ * @type {number}
+ * @default
+ */
+export declare const maxTime: number;
+/**
+ * Milliseconds in 1 week.
+ *
+ * @name millisecondsInWeek
+ * @constant
+ * @type {number}
+ * @default
+ */
+export declare const millisecondsInWeek = 604800000;
+/**
+ * Milliseconds in 1 day.
+ *
+ * @name millisecondsInDay
+ * @constant
+ * @type {number}
+ * @default
+ */
+export declare const millisecondsInDay = 86400000;
+/**
+ * Milliseconds in 1 minute
+ *
+ * @name millisecondsInMinute
+ * @constant
+ * @type {number}
+ * @default
+ */
+export declare const millisecondsInMinute = 60000;
+/**
+ * Milliseconds in 1 hour
+ *
+ * @name millisecondsInHour
+ * @constant
+ * @type {number}
+ * @default
+ */
+export declare const millisecondsInHour = 3600000;
+/**
+ * Milliseconds in 1 second
+ *
+ * @name millisecondsInSecond
+ * @constant
+ * @type {number}
+ * @default
+ */
+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
+ */
+export declare const minutesInYear = 525600;
+/**
+ * Minutes in 1 month.
+ *
+ * @name minutesInMonth
+ * @constant
+ * @type {number}
+ * @default
+ */
+export declare const minutesInMonth = 43200;
+/**
+ * Minutes in 1 day.
+ *
+ * @name minutesInDay
+ * @constant
+ * @type {number}
+ * @default
+ */
+export declare const minutesInDay = 1440;
+/**
+ * Minutes in 1 hour.
+ *
+ * @name minutesInHour
+ * @constant
+ * @type {number}
+ * @default
+ */
+export declare const minutesInHour = 60;
+/**
+ * Months in 1 quarter.
+ *
+ * @name monthsInQuarter
+ * @constant
+ * @type {number}
+ * @default
+ */
+export declare const monthsInQuarter = 3;
+/**
+ * Months in 1 year.
+ *
+ * @name monthsInYear
+ * @constant
+ * @type {number}
+ * @default
+ */
+export declare const monthsInYear = 12;
+/**
+ * Quarters in 1 year
+ *
+ * @name quartersInYear
+ * @constant
+ * @type {number}
+ * @default
+ */
+export declare const quartersInYear = 4;
+/**
+ * Seconds in 1 hour.
+ *
+ * @name secondsInHour
+ * @constant
+ * @type {number}
+ * @default
+ */
+export declare const secondsInHour = 3600;
+/**
+ * Seconds in 1 minute.
+ *
+ * @name secondsInMinute
+ * @constant
+ * @type {number}
+ * @default
+ */
+export declare const secondsInMinute = 60;
+/**
+ * Seconds in 1 day.
+ *
+ * @name secondsInDay
+ * @constant
+ * @type {number}
+ * @default
+ */
+export declare const secondsInDay: number;
+/**
+ * Seconds in 1 week.
+ *
+ * @name secondsInWeek
+ * @constant
+ * @type {number}
+ * @default
+ */
+export declare const secondsInWeek: number;
+/**
+ * Seconds in 1 year.
+ *
+ * @name secondsInYear
+ * @constant
+ * @type {number}
+ * @default
+ */
+export declare const secondsInYear: number;
+/**
+ * Seconds in 1 month
+ *
+ * @name secondsInMonth
+ * @constant
+ * @type {number}
+ * @default
+ */
+export declare const secondsInMonth: number;
+/**
+ * Seconds in 1 quarter.
+ *
+ * @name secondsInQuarter
+ * @constant
+ * @type {number}
+ * @default
+ */
+export declare const secondsInQuarter: number;

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

@@ -0,0 +1,26 @@
+/**
+ * @name constructFrom
+ * @category Date Extension Helpers
+ * @summary Constructs a date using the reference date and the value
+ *
+ * @description
+ * The function constructs a new date using the constructor from the reference
+ * 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
+ *
+ * @example
+ * import { constructFrom } from 'date-fns'
+ *
+ * // A function that clones a date preserving the original type
+ * function cloneDate<DateType extends Date(date: DateType): DateType {
+ *   return constructFrom(
+ *     date, // Use contrustor from the given date
+ *     date.getTime() // Use the date value to create a new date
+ *   )
+ * }
+ */
+export default function constructFrom<DateType extends Date>(date: DateType | number, value: Date | number): DateType;

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

@@ -0,0 +1,23 @@
+/**
+ * @name daysToWeeks
+ * @category Conversion Helpers
+ * @summary Convert days to weeks.
+ *
+ * @description
+ * Convert a number of days to a full number of weeks.
+ *
+ * @param days - number of days to be converted
+ *
+ * @returns the number of days converted in weeks
+ *
+ * @example
+ * // Convert 14 days to weeks:
+ * const result = daysToWeeks(14)
+ * //=> 2
+ *
+ * @example
+ * // It uses floor rounding:
+ * const result = daysToWeeks(13)
+ * //=> 1
+ */
+export default function daysToWeeks(days: number): number;

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

@@ -0,0 +1,49 @@
+/**
+ * @name differenceInBusinessDays
+ * @category Day Helpers
+ * @summary Get the number of business days between the given dates.
+ *
+ * @description
+ * Get the number of business day periods between the given dates.
+ * Business days being days that arent in the weekend.
+ * 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
+ *
+ * @example
+ * // How many business days are between
+ * // 10 January 2014 and 20 July 2014?
+ * const result = differenceInBusinessDays(
+ *   new Date(2014, 6, 20),
+ *   new Date(2014, 0, 10)
+ * )
+ * //=> 136
+ *
+ * // How many business days are between
+ * // 30 November 2021 and 1 November 2021?
+ * const result = differenceInBusinessDays(
+ *   new Date(2021, 10, 30),
+ *   new Date(2021, 10, 1)
+ * )
+ * //=> 21
+ *
+ * // How many business days are between
+ * // 1 November 2021 and 1 December 2021?
+ * const result = differenceInBusinessDays(
+ *   new Date(2021, 10, 1),
+ *   new Date(2021, 11, 1)
+ * )
+ * //=> -22
+ *
+ * // How many business days are between
+ * // 1 November 2021 and 1 November 2021 ?
+ * const result = differenceInBusinessDays(
+ *   new Date(2021, 10, 1),
+ *   new Date(2021, 10, 1)
+ * )
+ * //=> 0
+ */
+export default function differenceInBusinessDays<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): number;

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

@@ -0,0 +1,30 @@
+/**
+ * @name differenceInCalendarDays
+ * @category Day Helpers
+ * @summary Get the number of calendar days between the given dates.
+ *
+ * @description
+ * Get the number of calendar days between the given dates. This means that the times are removed
+ * from the dates and then the difference in days is calculated.
+ *
+ * @param dateLeft - the later date
+ * @param dateRight - the earlier date
+ * @returns the number of calendar days
+ *
+ * @example
+ * // How many calendar days are between
+ * // 2 July 2011 23:00:00 and 2 July 2012 00:00:00?
+ * const result = differenceInCalendarDays(
+ *   new Date(2012, 6, 2, 0, 0),
+ *   new Date(2011, 6, 2, 23, 0)
+ * )
+ * //=> 366
+ * // How many calendar days are between
+ * // 2 July 2011 23:59:00 and 3 July 2011 00:01:00?
+ * const result = differenceInCalendarDays(
+ *   new Date(2011, 6, 3, 0, 1),
+ *   new Date(2011, 6, 2, 23, 59)
+ * )
+ * //=> 1
+ */
+export default function differenceInCalendarDays<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): number;

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

@@ -0,0 +1,23 @@
+/**
+ * @name differenceInCalendarISOWeekYears
+ * @category ISO Week-Numbering Year Helpers
+ * @summary Get the number of calendar ISO week-numbering years between the given dates.
+ *
+ * @description
+ * Get the number of calendar ISO week-numbering years between the given dates.
+ *
+ * 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 calendar ISO week-numbering years
+ *
+ * @example
+ * // How many calendar ISO week-numbering years are 1 January 2010 and 1 January 2012?
+ * const result = differenceInCalendarISOWeekYears(
+ *   new Date(2012, 0, 1),
+ *   new Date(2010, 0, 1)
+ * )
+ * //=> 2
+ */
+export default function differenceInCalendarISOWeekYears<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): number;

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

@@ -0,0 +1,23 @@
+/**
+ * @name differenceInCalendarISOWeeks
+ * @category ISO Week Helpers
+ * @summary Get the number of calendar ISO weeks between the given dates.
+ *
+ * @description
+ * Get the number of calendar ISO weeks between the given dates.
+ *
+ * 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 calendar ISO weeks
+ *
+ * @example
+ * // How many calendar ISO weeks are between 6 July 2014 and 21 July 2014?
+ * const result = differenceInCalendarISOWeeks(
+ *   new Date(2014, 6, 21),
+ *   new Date(2014, 6, 6)
+ * )
+ * //=> 3
+ */
+export default function differenceInCalendarISOWeeks<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): number;

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

@@ -0,0 +1,21 @@
+/**
+ * @name differenceInCalendarMonths
+ * @category Month Helpers
+ * @summary Get the number of calendar months between the given dates.
+ *
+ * @description
+ * Get the number of calendar months between the given dates.
+ *
+ * @param dateLeft - the later date
+ * @param dateRight - the earlier date
+ * @returns the number of calendar months
+ *
+ * @example
+ * // How many calendar months are between 31 January 2014 and 1 September 2014?
+ * const result = differenceInCalendarMonths(
+ *   new Date(2014, 8, 1),
+ *   new Date(2014, 0, 31)
+ * )
+ * //=> 8
+ */
+export default function differenceInCalendarMonths<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): number;

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

@@ -0,0 +1,21 @@
+/**
+ * @name differenceInCalendarQuarters
+ * @category Quarter Helpers
+ * @summary Get the number of calendar quarters between the given dates.
+ *
+ * @description
+ * Get the number of calendar quarters between the given dates.
+ *
+ * @param dateLeft - the later date
+ * @param dateRight - the earlier date
+ * @returns the number of calendar quarters
+ *
+ * @example
+ * // How many calendar quarters are between 31 December 2013 and 2 July 2014?
+ * const result = differenceInCalendarQuarters(
+ *   new Date(2014, 6, 2),
+ *   new Date(2013, 11, 31)
+ * )
+ * //=> 3
+ */
+export default function differenceInCalendarQuarters<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): number;

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

@@ -0,0 +1,38 @@
+import type { LocaleOptions, WeekStartOptions } from '../types';
+/**
+ * The {@link differenceInCalendarWeeks} function options.
+ */
+export interface DifferenceInCalendarWeeksOptions extends LocaleOptions, WeekStartOptions {
+}
+/**
+ * @name differenceInCalendarWeeks
+ * @category Week Helpers
+ * @summary Get the number of calendar weeks between the given dates.
+ *
+ * @description
+ * Get the number of calendar weeks between the given dates.
+ *
+ * @param dateLeft - the later date
+ * @param dateRight - the earlier date
+ * @param options - an object with options.
+ * @returns the number of calendar weeks
+ *
+ * @example
+ * // How many calendar weeks are between 5 July 2014 and 20 July 2014?
+ * const result = differenceInCalendarWeeks(
+ *   new Date(2014, 6, 20),
+ *   new Date(2014, 6, 5)
+ * )
+ * //=> 3
+ *
+ * @example
+ * // If the week starts on Monday,
+ * // how many calendar weeks are between 5 July 2014 and 20 July 2014?
+ * const result = differenceInCalendarWeeks(
+ *   new Date(2014, 6, 20),
+ *   new Date(2014, 6, 5),
+ *   { weekStartsOn: 1 }
+ * )
+ * //=> 2
+ */
+export default function differenceInCalendarWeeks<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number, options?: DifferenceInCalendarWeeksOptions): number;

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

@@ -0,0 +1,21 @@
+/**
+ * @name differenceInCalendarYears
+ * @category Year Helpers
+ * @summary Get the number of calendar years between the given dates.
+ *
+ * @description
+ * Get the number of calendar years between the given dates.
+ *
+ * @param dateLeft - the later date
+ * @param dateRight - the earlier date
+ * @returns the number of calendar years
+ *
+ * @example
+ * // How many calendar years are between 31 December 2013 and 11 February 2015?
+ * const result = differenceInCalendarYears(
+ *   new Date(2015, 1, 11),
+ *   new Date(2013, 11, 31)
+ * )
+ * //=> 2
+ */
+export default function differenceInCalendarYears<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): number;

package/dist/date-fns/differenceInDays/index.d.ts

@@ -0,0 +1,49 @@
+/**
+ * @name differenceInDays
+ * @category Day Helpers
+ * @summary Get the number of full days between the given dates.
+ *
+ * @description
+ * Get the number of full day periods between two dates. Fractional days are
+ * truncated towards zero.
+ *
+ * One "full day" is the distance between a local time in one day to the same
+ * local time on the next or previous day. A full day can sometimes be less than
+ * or more than 24 hours if a daylight savings change happens between two dates.
+ *
+ * To ignore DST and only measure exact 24-hour periods, use this instead:
+ * `Math.floor(differenceInHours(dateLeft, dateRight)/24)|0`.
+ *
+ *
+ * @param dateLeft - the later date
+ * @param dateRight - the earlier date
+ * @returns the number of full days according to the local timezone
+ *
+ * @example
+ * // How many full days are between
+ * // 2 July 2011 23:00:00 and 2 July 2012 00:00:00?
+ * const result = differenceInDays(
+ *   new Date(2012, 6, 2, 0, 0),
+ *   new Date(2011, 6, 2, 23, 0)
+ * )
+ * //=> 365
+ * // How many full days are between
+ * // 2 July 2011 23:59:00 and 3 July 2011 00:01:00?
+ * const result = differenceInDays(
+ *   new Date(2011, 6, 3, 0, 1),
+ *   new Date(2011, 6, 2, 23, 59)
+ * )
+ * //=> 0
+ * // How many full days are between
+ * // 1 March 2020 0:00 and 1 June 2020 0:00 ?
+ * // Note: because local time is used, the
+ * // result will always be 92 days, even in
+ * // time zones where DST starts and the
+ * // period has only 92*24-1 hours.
+ * const result = differenceInDays(
+ *   new Date(2020, 5, 1),
+ *   new Date(2020, 2, 1)
+ * )
+//=> 92
+ */
+export default function differenceInDays<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): number;