@checkdigit/time 1.0.0

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

@@ -0,0 +1,39 @@
+import type { FirstWeekContainsDateOptions, LocaleOptions, WeekStartOptions } from '../types';
+/**
+ * The {@link getWeek} function options.
+ */
+export interface GetWeekOptions extends LocaleOptions, WeekStartOptions, FirstWeekContainsDateOptions {
+}
+/**
+ * @name getWeek
+ * @category Week Helpers
+ * @summary Get the local week index of the given date.
+ *
+ * @description
+ * Get the local week index of the given date.
+ * The exact calculation depends on the values of
+ * `options.weekStartsOn` (which is the index of the first day of the week)
+ * and `options.firstWeekContainsDate` (which is the day of January, which is always in
+ * the first week of the week-numbering year)
+ *
+ * Week numbering: https://en.wikipedia.org/wiki/Week#Week_numbering
+ *
+ * @param date - the given date
+ * @param options - an object with options.
+ * @returns the week
+ *
+ * @example
+ * // Which week of the local week numbering year is 2 January 2005 with default options?
+ * const result = getWeek(new Date(2005, 0, 2))
+ * //=> 2
+ *
+ * // Which week of the local week numbering year is 2 January 2005,
+ * // if Monday is the first day of the week,
+ * // and the first week of the year always contains 4 January?
+ * const result = getWeek(new Date(2005, 0, 2), {
+ *   weekStartsOn: 1,
+ *   firstWeekContainsDate: 4
+ * })
+ * //=> 53
+ */
+export default function getWeek<DateType extends Date>(dirtyDate: DateType | number, options?: GetWeekOptions): number;

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

@@ -0,0 +1,24 @@
+import type { LocaleOptions, WeekStartOptions } from '../types';
+/**
+ * The {@link getWeekOfMonth} function options.
+ */
+export interface GetWeekOfMonthOptions extends LocaleOptions, WeekStartOptions {
+}
+/**
+ * @name getWeekOfMonth
+ * @category Week Helpers
+ * @summary Get the week of the month of the given date.
+ *
+ * @description
+ * Get the week of the month of the given date.
+ *
+ * @param date - the given date
+ * @param options - an object with options.
+ * @returns the week of month
+ *
+ * @example
+ * // Which week of the month is 9 November 2017?
+ * const result = getWeekOfMonth(new Date(2017, 10, 9))
+ * //=> 2
+ */
+export default function getWeekOfMonth<DateType extends Date>(date: DateType | number, options?: GetWeekOfMonthOptions): number;

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

@@ -0,0 +1,40 @@
+import type { FirstWeekContainsDateOptions, LocaleOptions, WeekStartOptions } from '../types';
+/**
+ * The {@link getWeekYear} function options.
+ */
+export interface GetWeekYearOptions extends LocaleOptions, WeekStartOptions, FirstWeekContainsDateOptions {
+}
+/**
+ * @name getWeekYear
+ * @category Week-Numbering Year Helpers
+ * @summary Get the local week-numbering year of the given date.
+ *
+ * @description
+ * Get the local week-numbering year of the given date.
+ * The exact calculation depends on the values of
+ * `options.weekStartsOn` (which is the index of the first day of the week)
+ * and `options.firstWeekContainsDate` (which is the day of January, which is always in
+ * the first week of the week-numbering year)
+ *
+ * Week numbering: https://en.wikipedia.org/wiki/Week#Week_numbering
+ *
+ * @param date - the given date
+ * @param options - an object with options.
+ * @returns the local week-numbering year
+ *
+ * @example
+ * // Which week numbering year is 26 December 2004 with the default settings?
+ * const result = getWeekYear(new Date(2004, 11, 26))
+ * //=> 2005
+ *
+ * @example
+ * // Which week numbering year is 26 December 2004 if week starts on Saturday?
+ * const result = getWeekYear(new Date(2004, 11, 26), { weekStartsOn: 6 })
+ * //=> 2004
+ *
+ * @example
+ * // Which week numbering year is 26 December 2004 if the first week contains 4 January?
+ * const result = getWeekYear(new Date(2004, 11, 26), { firstWeekContainsDate: 4 })
+ * //=> 2004
+ */
+export default function getWeekYear<DateType extends Date>(dirtyDate: DateType | number, options?: GetWeekYearOptions): number;

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

@@ -0,0 +1,30 @@
+import type { LocaleOptions, WeekStartOptions } from '../types';
+/**
+ * The {@link getWeeksInMonth} function options.
+ */
+export interface GetWeeksInMonthOptions extends LocaleOptions, WeekStartOptions {
+}
+/**
+ * @name getWeeksInMonth
+ * @category Week Helpers
+ * @summary Get the number of calendar weeks a month spans.
+ *
+ * @description
+ * Get the number of calendar weeks the month in the given date spans.
+ *
+ * @param date - the given date
+ * @param options - an object with options.
+ * @returns the number of calendar weeks
+ *
+ * @example
+ * // How many calendar weeks does February 2015 span?
+ * const result = getWeeksInMonth(new Date(2015, 1, 8))
+ * //=> 4
+ *
+ * @example
+ * // If the week starts on Monday,
+ * // how many calendar weeks does July 2017 span?
+ * const result = getWeeksInMonth(new Date(2017, 6, 5), { weekStartsOn: 1 })
+ * //=> 6
+ */
+export default function getWeeksInMonth<DateType extends Date>(date: DateType | number, options?: GetWeeksInMonthOptions): number;

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

@@ -0,0 +1,17 @@
+/**
+ * @name getYear
+ * @category Year Helpers
+ * @summary Get the year of the given date.
+ *
+ * @description
+ * Get the year of the given date.
+ *
+ * @param date - the given date
+ * @returns the year
+ *
+ * @example
+ * // Which year is 2 July 2014?
+ * const result = getYear(new Date(2014, 6, 2))
+ * //=> 2014
+ */
+export default function getYear<DateType extends Date>(dirtyDate: DateType | number): number;

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

@@ -0,0 +1,18 @@
+/**
+ * @name hoursToMilliseconds
+ * @category  Conversion Helpers
+ * @summary Convert hours to milliseconds.
+ *
+ * @description
+ * Convert a number of hours to a full number of milliseconds.
+ *
+ * @param hours - number of hours to be converted
+ *
+ * @returns the number of hours converted to milliseconds
+ *
+ * @example
+ * // Convert 2 hours to milliseconds:
+ * const result = hoursToMilliseconds(2)
+ * //=> 7200000
+ */
+export default function hoursToMilliseconds(hours: number): number;

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

@@ -0,0 +1,18 @@
+/**
+ * @name hoursToMinutes
+ * @category Conversion Helpers
+ * @summary Convert hours to minutes.
+ *
+ * @description
+ * Convert a number of hours to a full number of minutes.
+ *
+ * @param hours - number of hours to be converted
+ *
+ * @returns the number of hours converted in minutes
+ *
+ * @example
+ * // Convert 2 hours to minutes:
+ * const result = hoursToMinutes(2)
+ * //=> 120
+ */
+export default function hoursToMinutes(hours: number): number;

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

@@ -0,0 +1,18 @@
+/**
+ * @name hoursToSeconds
+ * @category Conversion Helpers
+ * @summary Convert hours to seconds.
+ *
+ * @description
+ * Convert a number of hours to a full number of seconds.
+ *
+ * @param hours - number of hours to be converted
+ *
+ * @returns the number of hours converted in seconds
+ *
+ * @example
+ * // Convert 2 hours to seconds:
+ * const result = hoursToSeconds(2)
+ * //=> 7200
+ */
+export default function hoursToSeconds(hours: number): number;

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

@@ -0,0 +1,240 @@
+export { default as add } from './add/index';
+export { default as addBusinessDays } from './addBusinessDays/index';
+export { default as addDays } from './addDays/index';
+export { default as addHours } from './addHours/index';
+export { default as addISOWeekYears } from './addISOWeekYears/index';
+export { default as addMilliseconds } from './addMilliseconds/index';
+export { default as addMinutes } from './addMinutes/index';
+export { default as addMonths } from './addMonths/index';
+export { default as addQuarters } from './addQuarters/index';
+export { default as addSeconds } from './addSeconds/index';
+export { default as addWeeks } from './addWeeks/index';
+export { default as addYears } from './addYears/index';
+export { default as areIntervalsOverlapping } from './areIntervalsOverlapping/index';
+export { default as clamp } from './clamp/index';
+export { default as closestIndexTo } from './closestIndexTo/index';
+export { default as closestTo } from './closestTo/index';
+export { default as compareAsc } from './compareAsc/index';
+export { default as compareDesc } from './compareDesc/index';
+export { default as daysToWeeks } from './daysToWeeks/index';
+export { default as differenceInBusinessDays } from './differenceInBusinessDays/index';
+export { default as differenceInCalendarDays } from './differenceInCalendarDays/index';
+export { default as differenceInCalendarISOWeekYears } from './differenceInCalendarISOWeekYears/index';
+export { default as differenceInCalendarISOWeeks } from './differenceInCalendarISOWeeks/index';
+export { default as differenceInCalendarMonths } from './differenceInCalendarMonths/index';
+export { default as differenceInCalendarQuarters } from './differenceInCalendarQuarters/index';
+export { default as differenceInCalendarWeeks } from './differenceInCalendarWeeks/index';
+export { default as differenceInCalendarYears } from './differenceInCalendarYears/index';
+export { default as differenceInDays } from './differenceInDays/index';
+export { default as differenceInHours } from './differenceInHours/index';
+export { default as differenceInISOWeekYears } from './differenceInISOWeekYears/index';
+export { default as differenceInMilliseconds } from './differenceInMilliseconds/index';
+export { default as differenceInMinutes } from './differenceInMinutes/index';
+export { default as differenceInMonths } from './differenceInMonths/index';
+export { default as differenceInQuarters } from './differenceInQuarters/index';
+export { default as differenceInSeconds } from './differenceInSeconds/index';
+export { default as differenceInWeeks } from './differenceInWeeks/index';
+export { default as differenceInYears } from './differenceInYears/index';
+export { default as eachDayOfInterval } from './eachDayOfInterval/index';
+export { default as eachHourOfInterval } from './eachHourOfInterval/index';
+export { default as eachMinuteOfInterval } from './eachMinuteOfInterval/index';
+export { default as eachMonthOfInterval } from './eachMonthOfInterval/index';
+export { default as eachQuarterOfInterval } from './eachQuarterOfInterval/index';
+export { default as eachWeekOfInterval } from './eachWeekOfInterval/index';
+export { default as eachWeekendOfInterval } from './eachWeekendOfInterval/index';
+export { default as eachWeekendOfMonth } from './eachWeekendOfMonth/index';
+export { default as eachWeekendOfYear } from './eachWeekendOfYear/index';
+export { default as eachYearOfInterval } from './eachYearOfInterval/index';
+export { default as endOfDay } from './endOfDay/index';
+export { default as endOfDecade } from './endOfDecade/index';
+export { default as endOfHour } from './endOfHour/index';
+export { default as endOfISOWeek } from './endOfISOWeek/index';
+export { default as endOfISOWeekYear } from './endOfISOWeekYear/index';
+export { default as endOfMinute } from './endOfMinute/index';
+export { default as endOfMonth } from './endOfMonth/index';
+export { default as endOfQuarter } from './endOfQuarter/index';
+export { default as endOfSecond } from './endOfSecond/index';
+export { default as endOfToday } from './endOfToday/index';
+export { default as endOfTomorrow } from './endOfTomorrow/index';
+export { default as endOfWeek } from './endOfWeek/index';
+export { default as endOfYear } from './endOfYear/index';
+export { default as endOfYesterday } from './endOfYesterday/index';
+export { default as format } from './format/index';
+export { default as formatDistance } from './formatDistance/index';
+export { default as formatDistanceStrict } from './formatDistanceStrict/index';
+export { default as formatDistanceToNow } from './formatDistanceToNow/index';
+export { default as formatDistanceToNowStrict } from './formatDistanceToNowStrict/index';
+export { default as formatDuration } from './formatDuration/index';
+export { default as formatISO } from './formatISO/index';
+export { default as formatISO9075 } from './formatISO9075/index';
+export { default as formatISODuration } from './formatISODuration/index';
+export { default as formatRFC3339 } from './formatRFC3339/index';
+export { default as formatRFC7231 } from './formatRFC7231/index';
+export { default as formatRelative } from './formatRelative/index';
+export { default as fromUnixTime } from './fromUnixTime/index';
+export { default as getDate } from './getDate/index';
+export { default as getDay } from './getDay/index';
+export { default as getDayOfYear } from './getDayOfYear/index';
+export { default as getDaysInMonth } from './getDaysInMonth/index';
+export { default as getDaysInYear } from './getDaysInYear/index';
+export { default as getDecade } from './getDecade/index';
+export { default as getDefaultOptions } from './getDefaultOptions/index';
+export { default as getHours } from './getHours/index';
+export { default as getISODay } from './getISODay/index';
+export { default as getISOWeek } from './getISOWeek/index';
+export { default as getISOWeekYear } from './getISOWeekYear/index';
+export { default as getISOWeeksInYear } from './getISOWeeksInYear/index';
+export { default as getMilliseconds } from './getMilliseconds/index';
+export { default as getMinutes } from './getMinutes/index';
+export { default as getMonth } from './getMonth/index';
+export { default as getOverlappingDaysInIntervals } from './getOverlappingDaysInIntervals/index';
+export { default as getQuarter } from './getQuarter/index';
+export { default as getSeconds } from './getSeconds/index';
+export { default as getTime } from './getTime/index';
+export { default as getUnixTime } from './getUnixTime/index';
+export { default as getWeek } from './getWeek/index';
+export { default as getWeekOfMonth } from './getWeekOfMonth/index';
+export { default as getWeekYear } from './getWeekYear/index';
+export { default as getWeeksInMonth } from './getWeeksInMonth/index';
+export { default as getYear } from './getYear/index';
+export { default as hoursToMilliseconds } from './hoursToMilliseconds/index';
+export { default as hoursToMinutes } from './hoursToMinutes/index';
+export { default as hoursToSeconds } from './hoursToSeconds/index';
+export { default as intervalToDuration } from './intervalToDuration/index';
+export { default as intlFormat } from './intlFormat/index';
+export { default as intlFormatDistance } from './intlFormatDistance/index';
+export { default as isAfter } from './isAfter/index';
+export { default as isBefore } from './isBefore/index';
+export { default as isDate } from './isDate/index';
+export { default as isEqual } from './isEqual/index';
+export { default as isExists } from './isExists/index';
+export { default as isFirstDayOfMonth } from './isFirstDayOfMonth/index';
+export { default as isFriday } from './isFriday/index';
+export { default as isFuture } from './isFuture/index';
+export { default as isLastDayOfMonth } from './isLastDayOfMonth/index';
+export { default as isLeapYear } from './isLeapYear/index';
+export { default as isMatch } from './isMatch/index';
+export { default as isMonday } from './isMonday/index';
+export { default as isPast } from './isPast/index';
+export { default as isSameDay } from './isSameDay/index';
+export { default as isSameHour } from './isSameHour/index';
+export { default as isSameISOWeek } from './isSameISOWeek/index';
+export { default as isSameISOWeekYear } from './isSameISOWeekYear/index';
+export { default as isSameMinute } from './isSameMinute/index';
+export { default as isSameMonth } from './isSameMonth/index';
+export { default as isSameQuarter } from './isSameQuarter/index';
+export { default as isSameSecond } from './isSameSecond/index';
+export { default as isSameWeek } from './isSameWeek/index';
+export { default as isSameYear } from './isSameYear/index';
+export { default as isSaturday } from './isSaturday/index';
+export { default as isSunday } from './isSunday/index';
+export { default as isThisHour } from './isThisHour/index';
+export { default as isThisISOWeek } from './isThisISOWeek/index';
+export { default as isThisMinute } from './isThisMinute/index';
+export { default as isThisMonth } from './isThisMonth/index';
+export { default as isThisQuarter } from './isThisQuarter/index';
+export { default as isThisSecond } from './isThisSecond/index';
+export { default as isThisWeek } from './isThisWeek/index';
+export { default as isThisYear } from './isThisYear/index';
+export { default as isThursday } from './isThursday/index';
+export { default as isToday } from './isToday/index';
+export { default as isTomorrow } from './isTomorrow/index';
+export { default as isTuesday } from './isTuesday/index';
+export { default as isValid } from './isValid/index';
+export { default as isWednesday } from './isWednesday/index';
+export { default as isWeekend } from './isWeekend/index';
+export { default as isWithinInterval } from './isWithinInterval/index';
+export { default as isYesterday } from './isYesterday/index';
+export { default as lastDayOfDecade } from './lastDayOfDecade/index';
+export { default as lastDayOfISOWeek } from './lastDayOfISOWeek/index';
+export { default as lastDayOfISOWeekYear } from './lastDayOfISOWeekYear/index';
+export { default as lastDayOfMonth } from './lastDayOfMonth/index';
+export { default as lastDayOfQuarter } from './lastDayOfQuarter/index';
+export { default as lastDayOfWeek } from './lastDayOfWeek/index';
+export { default as lastDayOfYear } from './lastDayOfYear/index';
+export { default as lightFormat } from './lightFormat/index';
+export { default as max } from './max/index';
+export { default as milliseconds } from './milliseconds/index';
+export { default as millisecondsToHours } from './millisecondsToHours/index';
+export { default as millisecondsToMinutes } from './millisecondsToMinutes/index';
+export { default as millisecondsToSeconds } from './millisecondsToSeconds/index';
+export { default as min } from './min/index';
+export { default as minutesToHours } from './minutesToHours/index';
+export { default as minutesToMilliseconds } from './minutesToMilliseconds/index';
+export { default as minutesToSeconds } from './minutesToSeconds/index';
+export { default as monthsToQuarters } from './monthsToQuarters/index';
+export { default as monthsToYears } from './monthsToYears/index';
+export { default as nextDay } from './nextDay/index';
+export { default as nextFriday } from './nextFriday/index';
+export { default as nextMonday } from './nextMonday/index';
+export { default as nextSaturday } from './nextSaturday/index';
+export { default as nextSunday } from './nextSunday/index';
+export { default as nextThursday } from './nextThursday/index';
+export { default as nextTuesday } from './nextTuesday/index';
+export { default as nextWednesday } from './nextWednesday/index';
+export { default as parse } from './parse/index';
+export { default as parseISO } from './parseISO/index';
+export { default as parseJSON } from './parseJSON/index';
+export { default as previousDay } from './previousDay/index';
+export { default as previousFriday } from './previousFriday/index';
+export { default as previousMonday } from './previousMonday/index';
+export { default as previousSaturday } from './previousSaturday/index';
+export { default as previousSunday } from './previousSunday/index';
+export { default as previousThursday } from './previousThursday/index';
+export { default as previousTuesday } from './previousTuesday/index';
+export { default as previousWednesday } from './previousWednesday/index';
+export { default as quartersToMonths } from './quartersToMonths/index';
+export { default as quartersToYears } from './quartersToYears/index';
+export { default as roundToNearestMinutes } from './roundToNearestMinutes/index';
+export { default as secondsToHours } from './secondsToHours/index';
+export { default as secondsToMilliseconds } from './secondsToMilliseconds/index';
+export { default as secondsToMinutes } from './secondsToMinutes/index';
+export { default as set } from './set/index';
+export { default as setDate } from './setDate/index';
+export { default as setDay } from './setDay/index';
+export { default as setDayOfYear } from './setDayOfYear/index';
+export { default as setDefaultOptions } from './setDefaultOptions/index';
+export { default as setHours } from './setHours/index';
+export { default as setISODay } from './setISODay/index';
+export { default as setISOWeek } from './setISOWeek/index';
+export { default as setISOWeekYear } from './setISOWeekYear/index';
+export { default as setMilliseconds } from './setMilliseconds/index';
+export { default as setMinutes } from './setMinutes/index';
+export { default as setMonth } from './setMonth/index';
+export { default as setQuarter } from './setQuarter/index';
+export { default as setSeconds } from './setSeconds/index';
+export { default as setWeek } from './setWeek/index';
+export { default as setWeekYear } from './setWeekYear/index';
+export { default as setYear } from './setYear/index';
+export { default as startOfDay } from './startOfDay/index';
+export { default as startOfDecade } from './startOfDecade/index';
+export { default as startOfHour } from './startOfHour/index';
+export { default as startOfISOWeek } from './startOfISOWeek/index';
+export { default as startOfISOWeekYear } from './startOfISOWeekYear/index';
+export { default as startOfMinute } from './startOfMinute/index';
+export { default as startOfMonth } from './startOfMonth/index';
+export { default as startOfQuarter } from './startOfQuarter/index';
+export { default as startOfSecond } from './startOfSecond/index';
+export { default as startOfToday } from './startOfToday/index';
+export { default as startOfTomorrow } from './startOfTomorrow/index';
+export { default as startOfWeek } from './startOfWeek/index';
+export { default as startOfWeekYear } from './startOfWeekYear/index';
+export { default as startOfYear } from './startOfYear/index';
+export { default as startOfYesterday } from './startOfYesterday/index';
+export { default as sub } from './sub/index';
+export { default as subBusinessDays } from './subBusinessDays/index';
+export { default as subDays } from './subDays/index';
+export { default as subHours } from './subHours/index';
+export { default as subISOWeekYears } from './subISOWeekYears/index';
+export { default as subMilliseconds } from './subMilliseconds/index';
+export { default as subMinutes } from './subMinutes/index';
+export { default as subMonths } from './subMonths/index';
+export { default as subQuarters } from './subQuarters/index';
+export { default as subSeconds } from './subSeconds/index';
+export { default as subWeeks } from './subWeeks/index';
+export { default as subYears } from './subYears/index';
+export { default as toDate } from './toDate/index';
+export { default as weeksToDays } from './weeksToDays/index';
+export { default as yearsToMonths } from './yearsToMonths/index';
+export { default as yearsToQuarters } from './yearsToQuarters/index';
+export * from './constants/index';

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

@@ -0,0 +1,25 @@
+import type { Duration, Interval } from '../types';
+/**
+ * @name intervalToDuration
+ * @category Common Helpers
+ * @summary Convert interval to duration
+ *
+ * @description
+ * Convert a interval object to a duration object.
+ *
+ * @param interval - the interval to convert to duration
+ *
+ * @returns The duration Object
+ * @throws {RangeError} `start` must not be Invalid Date
+ * @throws {RangeError} `end` must not be Invalid Date
+ * @throws {RangeError} The start of an interval cannot be after its end
+ *
+ * @example
+ * // Get the duration between January 15, 1929 and April 4, 1968.
+ * 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 }
+ */
+export default function interval<DateType extends Date>(interval: Interval<DateType>): Duration;

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

@@ -0,0 +1,10 @@
+declare type Locale = Intl.ResolvedDateTimeFormatOptions['locale'];
+declare type FormatOptions = Intl.DateTimeFormatOptions;
+declare type LocaleOptions = {
+    locale: Locale | Locale[];
+};
+export default function intlFormat<DateType extends Date>(date: DateType): string;
+export default function intlFormat<DateType extends Date>(date: DateType, localeOptions: LocaleOptions): string;
+export default function intlFormat<DateType extends Date>(date: DateType, formatOptions: FormatOptions): string;
+export default function intlFormat<DateType extends Date>(date: DateType, formatOptions: FormatOptions, localeOptions: LocaleOptions): string;
+export {};

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

@@ -0,0 +1,107 @@
+import type { IntlOptionsUnit } from '../types';
+/**
+ * The {@link intlFormatDistance} function options.
+ */
+export interface IntlFormatDistanceOptions {
+    unit?: IntlOptionsUnit;
+    locale?: Intl.BCP47LanguageTag;
+    localeMatcher?: Intl.RelativeTimeFormatLocaleMatcher;
+    numeric?: Intl.RelativeTimeFormatNumeric;
+    style?: Intl.RelativeTimeFormatStyle;
+}
+/**
+ * @name intlFormatDistance
+ * @category Common Helpers
+ * @summary Formats distance between two dates in a human-readable format
+ * @description
+ * The function calculates the difference between two dates and formats it as a human-readable string.
+ *
+ * The function will pick the most appropriate unit depending on the distance between dates. For example, if the distance is a few hours, it might return `x hours`. If the distance is a few months, it might return `x months`.
+ *
+ * You can also specify a unit to force using it regardless of the distance to get a result like `123456 hours`.
+ *
+ * See the table below for the unit picking logic:
+ *
+ * | Distance between dates | Result (past)  | Result (future) |
+ * | ---------------------- | -------------- | --------------- |
+ * | 0 seconds              | now            | now             |
+ * | 1-59 seconds           | X seconds ago  | in X seconds    |
+ * | 1-59 minutes           | X minutes ago  | in X minutes    |
+ * | 1-23 hours             | X hours ago    | in X hours      |
+ * | 1 day                  | yesterday      | tomorrow        |
+ * | 2-6 days               | X days ago     | in X days       |
+ * | 7 days                 | last week      | next week       |
+ * | 8 days-1 month         | X weeks ago    | in X weeks      |
+ * | 1 month                | last month     | next month      |
+ * | 2-3 months             | X months ago   | in X months     |
+ * | 1 quarter              | last quarter   | next quarter    |
+ * | 2-3 quarters           | X quarters ago | in X quarters   |
+ * | 1 year                 | last year      | next year       |
+ * | 2+ years               | X years ago    | in X years      |
+ *
+ * @param date - the date
+ * @param baseDate - 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.
+ * @returns the distance in words according to language-sensitive relative time formatting.
+ * @throws {RangeError} `date` must not be Invalid Date
+ * @throws {RangeError} `baseDate` must not be Invalid Date
+ * @throws {RangeError} `options.unit` must not be invalid Unit
+ * @throws {RangeError} `options.locale` must not be invalid locale
+ * @throws {RangeError} `options.localeMatcher` must not be invalid localeMatcher
+ * @throws {RangeError} `options.numeric` must not be invalid numeric
+ * @throws {RangeError} `options.style` must not be invalid style
+ *
+ * @example
+ * // What is the distance between the dates when the fist date is after the second?
+ * intlFormatDistance(
+ *   new Date(1986, 3, 4, 11, 30, 0),
+ *   new Date(1986, 3, 4, 10, 30, 0)
+ * )
+ * //=> 'in 1 hour'
+ *
+ * // What is the distance between the dates when the fist date is before the second?
+ * intlFormatDistance(
+ *   new Date(1986, 3, 4, 10, 30, 0),
+ *   new Date(1986, 3, 4, 11, 30, 0)
+ * )
+ * //=> '1 hour ago'
+ *
+ * @example
+ * // Use the unit option to force the function to output the result in quarters. Without setting it, the example would return "next year"
+ * intlFormatDistance(
+ *   new Date(1987, 6, 4, 10, 30, 0),
+ *   new Date(1986, 3, 4, 10, 30, 0),
+ *   { unit: 'quarter' }
+ * )
+ * //=> 'in 5 quarters'
+ *
+ * @example
+ * // Use the locale option to get the result in Spanish. Without setting it, the example would return "in 1 hour".
+ * intlFormatDistance(
+ *   new Date(1986, 3, 4, 11, 30, 0),
+ *   new Date(1986, 3, 4, 10, 30, 0),
+ *   { locale: 'es' }
+ * )
+ * //=> 'dentro de 1 hora'
+ *
+ * @example
+ * // Use the numeric option to force the function to use numeric values. Without setting it, the example would return "tomorrow".
+ * intlFormatDistance(
+ *   new Date(1986, 3, 5, 11, 30, 0),
+ *   new Date(1986, 3, 4, 11, 30, 0),
+ *   { numeric: 'always' }
+ * )
+ * //=> 'in 1 day'
+ *
+ * @example
+ * // Use the style option to force the function to use short values. Without setting it, the example would return "in 2 years".
+ * intlFormatDistance(
+ *   new Date(1988, 3, 4, 11, 30, 0),
+ *   new Date(1986, 3, 4, 11, 30, 0),
+ *   { style: 'short' }
+ * )
+ * //=> 'in 2 yr'
+ */
+export default function intlFormatDistance(date: Date | number, baseDate: Date | number, options?: IntlFormatDistanceOptions): string;

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

@@ -0,0 +1,18 @@
+/**
+ * @name isAfter
+ * @category Common Helpers
+ * @summary Is the first date after the second one?
+ *
+ * @description
+ * Is the first date after the second one?
+ *
+ * @param date - the date that should be after the other one to return true
+ * @param dateToCompare - the date to compare with
+ * @returns the first date is after the second date
+ *
+ * @example
+ * // Is 10 July 1989 after 11 February 1987?
+ * const result = isAfter(new Date(1989, 6, 10), new Date(1987, 1, 11))
+ * //=> true
+ */
+export default function isAfter<DateType extends Date>(dirtyDate: DateType | number, dirtyDateToCompare: DateType | number): boolean;

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

@@ -0,0 +1,18 @@
+/**
+ * @name isBefore
+ * @category Common Helpers
+ * @summary Is the first date before the second one?
+ *
+ * @description
+ * Is the first date before the second one?
+ *
+ * @param date - the date that should be before the other one to return true
+ * @param dateToCompare - the date to compare with
+ * @returns the first date is before the second date
+ *
+ * @example
+ * // Is 10 July 1989 before 11 February 1987?
+ * const result = isBefore(new Date(1989, 6, 10), new Date(1987, 1, 11))
+ * //=> false
+ */
+export default function isBefore<DateType extends Date>(dirtyDate: DateType | number, dirtyDateToCompare: DateType | number): boolean;