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

package/src/date-fns/index.ts

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

package/src/date-fns/interval/index.ts

@@ -0,0 +1,46 @@
+import { toDate } from '../toDate/index';
+import type { NormalizedInterval } from '../types';
+
+/**
+ * The {@link interval} function options.
+ */
+export interface IntervalOptions {
+  /** Asserts that the interval is positive (start is after the end). */
+  assertPositive?: boolean;
+}
+
+/**
+ * @name interval
+ * @category Interval Helpers
+ * @summary Creates an interval object and validates its values.
+ *
+ * @description
+ * Creates a normalized interval object and validates its values. If the interval is invalid, an exception is thrown.
+ *
+ * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+ *
+ * @param start - The start of the interval.
+ * @param end - The end of the interval.
+ * @param options - The options object.
+ *
+ * @throws `Start date is invalid` when `start` is invalid.
+ * @throws `End date is invalid` when `end` is invalid.
+ * @throws `End date must be after start date` when end is before `start` and `options.assertPositive` is true.
+ *
+ * @returns The normalized and validated interval object.
+ */
+export function interval<DateType extends Date>(
+  start: DateType | number | string,
+  end: DateType | number | string,
+  options?: IntervalOptions,
+): NormalizedInterval<DateType> {
+  const _start = toDate(start);
+  if (isNaN(+_start)) throw new TypeError('Start date is invalid');
+
+  const _end = toDate(end);
+  if (isNaN(+_end)) throw new TypeError('End date is invalid');
+
+  if (options?.assertPositive && +_start > +_end) throw new TypeError('End date must be after start date');
+
+  return { start: _start, end: _end };
+}

package/src/date-fns/interval/test.mts

@@ -0,0 +1,42 @@
+import { describe, expect, it } from 'vitest';
+import { interval } from './index';
+
+describe('Interval', () => {
+  it('exposes start and end', () => {
+    const result = interval(new Date(2000, 0), new Date(2023, 0));
+    expect(result.start).toEqual(new Date(2000, 0));
+    expect(result.end).toEqual(new Date(2023, 0));
+  });
+
+  it('normalizes the dates', () => {
+    const result = interval(+new Date(2000, 0), new Date(2023, 0).toISOString());
+    expect(result.start).toEqual(new Date(2000, 0));
+    expect(result.end).toEqual(new Date(2023, 0));
+  });
+
+  it('throws an error if one of the arguments is invalid', () => {
+    expect(() => {
+      interval(new Date(2000, 0), new Date(NaN));
+    }).toThrow(new TypeError('End date is invalid'));
+
+    expect(() => {
+      interval(new Date(NaN), new Date(2000, 0));
+    }).toThrow(new TypeError('Start date is invalid'));
+  });
+
+  it('throws an error if the interval is not positive', () => {
+    // Should be ok
+    interval(new Date(2023, 0), new Date(2000, 0));
+
+    expect(() => {
+      interval(new Date(2023, 0), new Date(2000, 0), {
+        assertPositive: true,
+      });
+    }).toThrow(new TypeError('End date must be after start date'));
+
+    // Should be ok too
+    interval(new Date(2000, 0), new Date(2000, 0), {
+      assertPositive: true,
+    });
+  });
+});