@checkdigit/time 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/ci.yml +72 -0
- package/.github/workflows/codeql-analysis.yml +31 -0
- package/.github/workflows/coverage.yml +46 -0
- package/LICENSE.txt +21 -0
- package/README.md +76 -0
- package/SECURITY.md +14 -0
- package/dist/date-fns/_lib/addLeadingZeros/index.d.ts +1 -0
- package/dist/date-fns/_lib/assign/index.d.ts +1 -0
- package/dist/date-fns/_lib/cloneObject/index.d.ts +1 -0
- package/dist/date-fns/_lib/defaultLocale/index.d.ts +2 -0
- package/dist/date-fns/_lib/defaultOptions/index.d.ts +4 -0
- package/dist/date-fns/_lib/format/formatters/index.d.ts +9 -0
- package/dist/date-fns/_lib/format/lightFormatters/index.d.ts +12 -0
- package/dist/date-fns/_lib/format/longFormatters/index.d.ts +4 -0
- package/dist/date-fns/_lib/getTimezoneOffsetInMilliseconds/index.d.ts +12 -0
- package/dist/date-fns/_lib/protectedTokens/index.d.ts +3 -0
- package/dist/date-fns/_lib/roundingMethods/index.d.ts +2 -0
- package/dist/date-fns/add/index.d.ts +40 -0
- package/dist/date-fns/addBusinessDays/index.d.ts +18 -0
- package/dist/date-fns/addDays/index.d.ts +18 -0
- package/dist/date-fns/addHours/index.d.ts +18 -0
- package/dist/date-fns/addISOWeekYears/index.d.ts +20 -0
- package/dist/date-fns/addMilliseconds/index.d.ts +18 -0
- package/dist/date-fns/addMinutes/index.d.ts +18 -0
- package/dist/date-fns/addMonths/index.d.ts +18 -0
- package/dist/date-fns/addQuarters/index.d.ts +18 -0
- package/dist/date-fns/addSeconds/index.d.ts +18 -0
- package/dist/date-fns/addWeeks/index.d.ts +18 -0
- package/dist/date-fns/addYears/index.d.ts +18 -0
- package/dist/date-fns/areIntervalsOverlapping/index.d.ts +61 -0
- package/dist/date-fns/clamp/index.d.ts +27 -0
- package/dist/date-fns/closestIndexTo/index.d.ts +24 -0
- package/dist/date-fns/closestTo/index.d.ts +22 -0
- package/dist/date-fns/compareAsc/index.d.ts +32 -0
- package/dist/date-fns/compareDesc/index.d.ts +32 -0
- package/dist/date-fns/constants/index.d.ts +211 -0
- package/dist/date-fns/constructFrom/index.d.ts +26 -0
- package/dist/date-fns/daysToWeeks/index.d.ts +23 -0
- package/dist/date-fns/differenceInBusinessDays/index.d.ts +49 -0
- package/dist/date-fns/differenceInCalendarDays/index.d.ts +30 -0
- package/dist/date-fns/differenceInCalendarISOWeekYears/index.d.ts +23 -0
- package/dist/date-fns/differenceInCalendarISOWeeks/index.d.ts +23 -0
- package/dist/date-fns/differenceInCalendarMonths/index.d.ts +21 -0
- package/dist/date-fns/differenceInCalendarQuarters/index.d.ts +21 -0
- package/dist/date-fns/differenceInCalendarWeeks/index.d.ts +38 -0
- package/dist/date-fns/differenceInCalendarYears/index.d.ts +21 -0
- package/dist/date-fns/differenceInDays/index.d.ts +49 -0
- package/dist/date-fns/differenceInHours/index.d.ts +28 -0
- package/dist/date-fns/differenceInISOWeekYears/index.d.ts +23 -0
- package/dist/date-fns/differenceInMilliseconds/index.d.ts +22 -0
- package/dist/date-fns/differenceInMinutes/index.d.ts +36 -0
- package/dist/date-fns/differenceInMonths/index.d.ts +18 -0
- package/dist/date-fns/differenceInQuarters/index.d.ts +25 -0
- package/dist/date-fns/differenceInSeconds/index.d.ts +29 -0
- package/dist/date-fns/differenceInWeeks/index.d.ts +46 -0
- package/dist/date-fns/differenceInYears/index.d.ts +18 -0
- package/dist/date-fns/eachDayOfInterval/index.d.ts +36 -0
- package/dist/date-fns/eachHourOfInterval/index.d.ts +35 -0
- package/dist/date-fns/eachMinuteOfInterval/index.d.ts +35 -0
- package/dist/date-fns/eachMonthOfInterval/index.d.ts +31 -0
- package/dist/date-fns/eachQuarterOfInterval/index.d.ts +27 -0
- package/dist/date-fns/eachWeekOfInterval/index.d.ts +38 -0
- package/dist/date-fns/eachWeekendOfInterval/index.d.ts +28 -0
- package/dist/date-fns/eachWeekendOfMonth/index.d.ts +27 -0
- package/dist/date-fns/eachWeekendOfYear/index.d.ts +24 -0
- package/dist/date-fns/eachYearOfInterval/index.d.ts +28 -0
- package/dist/date-fns/endOfDay/index.d.ts +18 -0
- package/dist/date-fns/endOfDecade/index.d.ts +17 -0
- package/dist/date-fns/endOfHour/index.d.ts +18 -0
- package/dist/date-fns/endOfISOWeek/index.d.ts +20 -0
- package/dist/date-fns/endOfISOWeekYear/index.d.ts +21 -0
- package/dist/date-fns/endOfMinute/index.d.ts +18 -0
- package/dist/date-fns/endOfMonth/index.d.ts +18 -0
- package/dist/date-fns/endOfQuarter/index.d.ts +18 -0
- package/dist/date-fns/endOfSecond/index.d.ts +18 -0
- package/dist/date-fns/endOfToday/index.d.ts +20 -0
- package/dist/date-fns/endOfTomorrow/index.d.ts +20 -0
- package/dist/date-fns/endOfWeek/index.d.ts +30 -0
- package/dist/date-fns/endOfYear/index.d.ts +18 -0
- package/dist/date-fns/endOfYesterday/index.d.ts +20 -0
- package/dist/date-fns/format/index.d.ts +289 -0
- package/dist/date-fns/formatDistance/index.d.ts +85 -0
- package/dist/date-fns/formatDistanceStrict/index.d.ts +85 -0
- package/dist/date-fns/formatDistanceToNow/index.d.ts +89 -0
- package/dist/date-fns/formatDistanceToNowStrict/index.d.ts +76 -0
- package/dist/date-fns/formatDuration/index.d.ts +67 -0
- package/dist/date-fns/formatISO/index.d.ts +40 -0
- package/dist/date-fns/formatISO9075/index.d.ts +40 -0
- package/dist/date-fns/formatISODuration/index.d.ts +26 -0
- package/dist/date-fns/formatRFC3339/index.d.ts +35 -0
- package/dist/date-fns/formatRFC7231/index.d.ts +19 -0
- package/dist/date-fns/formatRelative/index.d.ts +39 -0
- package/dist/date-fns/fp/_lib/convertToFP/index.d.ts +1 -0
- package/dist/date-fns/fp/add/index.d.ts +2 -0
- package/dist/date-fns/fp/addBusinessDays/index.d.ts +2 -0
- package/dist/date-fns/fp/addDays/index.d.ts +2 -0
- package/dist/date-fns/fp/addHours/index.d.ts +2 -0
- package/dist/date-fns/fp/addISOWeekYears/index.d.ts +2 -0
- package/dist/date-fns/fp/addMilliseconds/index.d.ts +2 -0
- package/dist/date-fns/fp/addMinutes/index.d.ts +2 -0
- package/dist/date-fns/fp/addMonths/index.d.ts +2 -0
- package/dist/date-fns/fp/addQuarters/index.d.ts +2 -0
- package/dist/date-fns/fp/addSeconds/index.d.ts +2 -0
- package/dist/date-fns/fp/addWeeks/index.d.ts +2 -0
- package/dist/date-fns/fp/addYears/index.d.ts +2 -0
- package/dist/date-fns/fp/areIntervalsOverlapping/index.d.ts +2 -0
- package/dist/date-fns/fp/areIntervalsOverlappingWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/clamp/index.d.ts +2 -0
- package/dist/date-fns/fp/closestIndexTo/index.d.ts +2 -0
- package/dist/date-fns/fp/closestTo/index.d.ts +2 -0
- package/dist/date-fns/fp/compareAsc/index.d.ts +2 -0
- package/dist/date-fns/fp/compareDesc/index.d.ts +2 -0
- package/dist/date-fns/fp/daysToWeeks/index.d.ts +2 -0
- package/dist/date-fns/fp/differenceInBusinessDays/index.d.ts +2 -0
- package/dist/date-fns/fp/differenceInCalendarDays/index.d.ts +2 -0
- package/dist/date-fns/fp/differenceInCalendarISOWeekYears/index.d.ts +2 -0
- package/dist/date-fns/fp/differenceInCalendarISOWeeks/index.d.ts +2 -0
- package/dist/date-fns/fp/differenceInCalendarMonths/index.d.ts +2 -0
- package/dist/date-fns/fp/differenceInCalendarQuarters/index.d.ts +2 -0
- package/dist/date-fns/fp/differenceInCalendarWeeks/index.d.ts +2 -0
- package/dist/date-fns/fp/differenceInCalendarWeeksWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/differenceInCalendarYears/index.d.ts +2 -0
- package/dist/date-fns/fp/differenceInDays/index.d.ts +2 -0
- package/dist/date-fns/fp/differenceInHours/index.d.ts +2 -0
- package/dist/date-fns/fp/differenceInHoursWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/differenceInISOWeekYears/index.d.ts +2 -0
- package/dist/date-fns/fp/differenceInMilliseconds/index.d.ts +2 -0
- package/dist/date-fns/fp/differenceInMinutes/index.d.ts +2 -0
- package/dist/date-fns/fp/differenceInMinutesWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/differenceInMonths/index.d.ts +2 -0
- package/dist/date-fns/fp/differenceInQuarters/index.d.ts +2 -0
- package/dist/date-fns/fp/differenceInQuartersWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/differenceInSeconds/index.d.ts +2 -0
- package/dist/date-fns/fp/differenceInSecondsWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/differenceInWeeks/index.d.ts +2 -0
- package/dist/date-fns/fp/differenceInWeeksWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/differenceInYears/index.d.ts +2 -0
- package/dist/date-fns/fp/eachDayOfInterval/index.d.ts +2 -0
- package/dist/date-fns/fp/eachDayOfIntervalWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/eachHourOfInterval/index.d.ts +2 -0
- package/dist/date-fns/fp/eachHourOfIntervalWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/eachMinuteOfInterval/index.d.ts +2 -0
- package/dist/date-fns/fp/eachMinuteOfIntervalWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/eachMonthOfInterval/index.d.ts +2 -0
- package/dist/date-fns/fp/eachQuarterOfInterval/index.d.ts +2 -0
- package/dist/date-fns/fp/eachWeekOfInterval/index.d.ts +2 -0
- package/dist/date-fns/fp/eachWeekOfIntervalWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/eachWeekendOfInterval/index.d.ts +2 -0
- package/dist/date-fns/fp/eachWeekendOfMonth/index.d.ts +2 -0
- package/dist/date-fns/fp/eachWeekendOfYear/index.d.ts +2 -0
- package/dist/date-fns/fp/eachYearOfInterval/index.d.ts +2 -0
- package/dist/date-fns/fp/endOfDay/index.d.ts +2 -0
- package/dist/date-fns/fp/endOfDecade/index.d.ts +2 -0
- package/dist/date-fns/fp/endOfDecadeWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/endOfHour/index.d.ts +2 -0
- package/dist/date-fns/fp/endOfISOWeek/index.d.ts +2 -0
- package/dist/date-fns/fp/endOfISOWeekYear/index.d.ts +2 -0
- package/dist/date-fns/fp/endOfMinute/index.d.ts +2 -0
- package/dist/date-fns/fp/endOfMonth/index.d.ts +2 -0
- package/dist/date-fns/fp/endOfQuarter/index.d.ts +2 -0
- package/dist/date-fns/fp/endOfSecond/index.d.ts +2 -0
- package/dist/date-fns/fp/endOfWeek/index.d.ts +2 -0
- package/dist/date-fns/fp/endOfWeekWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/endOfYear/index.d.ts +2 -0
- package/dist/date-fns/fp/format/index.d.ts +2 -0
- package/dist/date-fns/fp/formatDistance/index.d.ts +2 -0
- package/dist/date-fns/fp/formatDistanceStrict/index.d.ts +2 -0
- package/dist/date-fns/fp/formatDistanceStrictWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/formatDistanceWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/formatDuration/index.d.ts +2 -0
- package/dist/date-fns/fp/formatDurationWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/formatISO/index.d.ts +2 -0
- package/dist/date-fns/fp/formatISO9075/index.d.ts +2 -0
- package/dist/date-fns/fp/formatISO9075WithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/formatISODuration/index.d.ts +2 -0
- package/dist/date-fns/fp/formatISOWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/formatRFC3339/index.d.ts +2 -0
- package/dist/date-fns/fp/formatRFC3339WithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/formatRFC7231/index.d.ts +2 -0
- package/dist/date-fns/fp/formatRelative/index.d.ts +2 -0
- package/dist/date-fns/fp/formatRelativeWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/formatWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/fromUnixTime/index.d.ts +2 -0
- package/dist/date-fns/fp/getDate/index.d.ts +2 -0
- package/dist/date-fns/fp/getDay/index.d.ts +2 -0
- package/dist/date-fns/fp/getDayOfYear/index.d.ts +2 -0
- package/dist/date-fns/fp/getDaysInMonth/index.d.ts +2 -0
- package/dist/date-fns/fp/getDaysInYear/index.d.ts +2 -0
- package/dist/date-fns/fp/getDecade/index.d.ts +2 -0
- package/dist/date-fns/fp/getHours/index.d.ts +2 -0
- package/dist/date-fns/fp/getISODay/index.d.ts +2 -0
- package/dist/date-fns/fp/getISOWeek/index.d.ts +2 -0
- package/dist/date-fns/fp/getISOWeekYear/index.d.ts +2 -0
- package/dist/date-fns/fp/getISOWeeksInYear/index.d.ts +2 -0
- package/dist/date-fns/fp/getMilliseconds/index.d.ts +2 -0
- package/dist/date-fns/fp/getMinutes/index.d.ts +2 -0
- package/dist/date-fns/fp/getMonth/index.d.ts +2 -0
- package/dist/date-fns/fp/getOverlappingDaysInIntervals/index.d.ts +2 -0
- package/dist/date-fns/fp/getQuarter/index.d.ts +2 -0
- package/dist/date-fns/fp/getSeconds/index.d.ts +2 -0
- package/dist/date-fns/fp/getTime/index.d.ts +2 -0
- package/dist/date-fns/fp/getUnixTime/index.d.ts +2 -0
- package/dist/date-fns/fp/getWeek/index.d.ts +2 -0
- package/dist/date-fns/fp/getWeekOfMonth/index.d.ts +2 -0
- package/dist/date-fns/fp/getWeekOfMonthWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/getWeekWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/getWeekYear/index.d.ts +2 -0
- package/dist/date-fns/fp/getWeekYearWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/getWeeksInMonth/index.d.ts +2 -0
- package/dist/date-fns/fp/getWeeksInMonthWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/getYear/index.d.ts +2 -0
- package/dist/date-fns/fp/hoursToMilliseconds/index.d.ts +2 -0
- package/dist/date-fns/fp/hoursToMinutes/index.d.ts +2 -0
- package/dist/date-fns/fp/hoursToSeconds/index.d.ts +2 -0
- package/dist/date-fns/fp/index.d.ts +255 -0
- package/dist/date-fns/fp/intervalToDuration/index.d.ts +2 -0
- package/dist/date-fns/fp/intlFormat/index.d.ts +2 -0
- package/dist/date-fns/fp/intlFormatDistance/index.d.ts +2 -0
- package/dist/date-fns/fp/intlFormatDistanceWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/isAfter/index.d.ts +2 -0
- package/dist/date-fns/fp/isBefore/index.d.ts +2 -0
- package/dist/date-fns/fp/isDate/index.d.ts +2 -0
- package/dist/date-fns/fp/isEqual/index.d.ts +2 -0
- package/dist/date-fns/fp/isExists/index.d.ts +2 -0
- package/dist/date-fns/fp/isFirstDayOfMonth/index.d.ts +2 -0
- package/dist/date-fns/fp/isFriday/index.d.ts +2 -0
- package/dist/date-fns/fp/isLastDayOfMonth/index.d.ts +2 -0
- package/dist/date-fns/fp/isLeapYear/index.d.ts +2 -0
- package/dist/date-fns/fp/isMatch/index.d.ts +2 -0
- package/dist/date-fns/fp/isMatchWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/isMonday/index.d.ts +2 -0
- package/dist/date-fns/fp/isSameDay/index.d.ts +2 -0
- package/dist/date-fns/fp/isSameHour/index.d.ts +2 -0
- package/dist/date-fns/fp/isSameISOWeek/index.d.ts +2 -0
- package/dist/date-fns/fp/isSameISOWeekYear/index.d.ts +2 -0
- package/dist/date-fns/fp/isSameMinute/index.d.ts +2 -0
- package/dist/date-fns/fp/isSameMonth/index.d.ts +2 -0
- package/dist/date-fns/fp/isSameQuarter/index.d.ts +2 -0
- package/dist/date-fns/fp/isSameSecond/index.d.ts +2 -0
- package/dist/date-fns/fp/isSameWeek/index.d.ts +2 -0
- package/dist/date-fns/fp/isSameWeekWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/isSameYear/index.d.ts +2 -0
- package/dist/date-fns/fp/isSaturday/index.d.ts +2 -0
- package/dist/date-fns/fp/isSunday/index.d.ts +2 -0
- package/dist/date-fns/fp/isThursday/index.d.ts +2 -0
- package/dist/date-fns/fp/isTuesday/index.d.ts +2 -0
- package/dist/date-fns/fp/isValid/index.d.ts +2 -0
- package/dist/date-fns/fp/isWednesday/index.d.ts +2 -0
- package/dist/date-fns/fp/isWeekend/index.d.ts +2 -0
- package/dist/date-fns/fp/isWithinInterval/index.d.ts +2 -0
- package/dist/date-fns/fp/lastDayOfDecade/index.d.ts +2 -0
- package/dist/date-fns/fp/lastDayOfISOWeek/index.d.ts +2 -0
- package/dist/date-fns/fp/lastDayOfISOWeekYear/index.d.ts +2 -0
- package/dist/date-fns/fp/lastDayOfMonth/index.d.ts +2 -0
- package/dist/date-fns/fp/lastDayOfQuarter/index.d.ts +2 -0
- package/dist/date-fns/fp/lastDayOfQuarterWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/lastDayOfWeek/index.d.ts +2 -0
- package/dist/date-fns/fp/lastDayOfWeekWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/lastDayOfYear/index.d.ts +2 -0
- package/dist/date-fns/fp/lightFormat/index.d.ts +2 -0
- package/dist/date-fns/fp/max/index.d.ts +2 -0
- package/dist/date-fns/fp/milliseconds/index.d.ts +2 -0
- package/dist/date-fns/fp/millisecondsToHours/index.d.ts +2 -0
- package/dist/date-fns/fp/millisecondsToMinutes/index.d.ts +2 -0
- package/dist/date-fns/fp/millisecondsToSeconds/index.d.ts +2 -0
- package/dist/date-fns/fp/min/index.d.ts +2 -0
- package/dist/date-fns/fp/minutesToHours/index.d.ts +2 -0
- package/dist/date-fns/fp/minutesToMilliseconds/index.d.ts +2 -0
- package/dist/date-fns/fp/minutesToSeconds/index.d.ts +2 -0
- package/dist/date-fns/fp/monthsToQuarters/index.d.ts +2 -0
- package/dist/date-fns/fp/monthsToYears/index.d.ts +2 -0
- package/dist/date-fns/fp/nextDay/index.d.ts +2 -0
- package/dist/date-fns/fp/nextFriday/index.d.ts +2 -0
- package/dist/date-fns/fp/nextMonday/index.d.ts +2 -0
- package/dist/date-fns/fp/nextSaturday/index.d.ts +2 -0
- package/dist/date-fns/fp/nextSunday/index.d.ts +2 -0
- package/dist/date-fns/fp/nextThursday/index.d.ts +2 -0
- package/dist/date-fns/fp/nextTuesday/index.d.ts +2 -0
- package/dist/date-fns/fp/nextWednesday/index.d.ts +2 -0
- package/dist/date-fns/fp/parse/index.d.ts +2 -0
- package/dist/date-fns/fp/parseISO/index.d.ts +2 -0
- package/dist/date-fns/fp/parseISOWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/parseJSON/index.d.ts +2 -0
- package/dist/date-fns/fp/parseWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/previousDay/index.d.ts +2 -0
- package/dist/date-fns/fp/previousFriday/index.d.ts +2 -0
- package/dist/date-fns/fp/previousMonday/index.d.ts +2 -0
- package/dist/date-fns/fp/previousSaturday/index.d.ts +2 -0
- package/dist/date-fns/fp/previousSunday/index.d.ts +2 -0
- package/dist/date-fns/fp/previousThursday/index.d.ts +2 -0
- package/dist/date-fns/fp/previousTuesday/index.d.ts +2 -0
- package/dist/date-fns/fp/previousWednesday/index.d.ts +2 -0
- package/dist/date-fns/fp/quartersToMonths/index.d.ts +2 -0
- package/dist/date-fns/fp/quartersToYears/index.d.ts +2 -0
- package/dist/date-fns/fp/roundToNearestMinutes/index.d.ts +2 -0
- package/dist/date-fns/fp/roundToNearestMinutesWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/secondsToHours/index.d.ts +2 -0
- package/dist/date-fns/fp/secondsToMilliseconds/index.d.ts +2 -0
- package/dist/date-fns/fp/secondsToMinutes/index.d.ts +2 -0
- package/dist/date-fns/fp/set/index.d.ts +2 -0
- package/dist/date-fns/fp/setDate/index.d.ts +2 -0
- package/dist/date-fns/fp/setDay/index.d.ts +2 -0
- package/dist/date-fns/fp/setDayOfYear/index.d.ts +2 -0
- package/dist/date-fns/fp/setDayWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/setHours/index.d.ts +2 -0
- package/dist/date-fns/fp/setISODay/index.d.ts +2 -0
- package/dist/date-fns/fp/setISOWeek/index.d.ts +2 -0
- package/dist/date-fns/fp/setISOWeekYear/index.d.ts +2 -0
- package/dist/date-fns/fp/setMilliseconds/index.d.ts +2 -0
- package/dist/date-fns/fp/setMinutes/index.d.ts +2 -0
- package/dist/date-fns/fp/setMonth/index.d.ts +2 -0
- package/dist/date-fns/fp/setQuarter/index.d.ts +2 -0
- package/dist/date-fns/fp/setSeconds/index.d.ts +2 -0
- package/dist/date-fns/fp/setWeek/index.d.ts +2 -0
- package/dist/date-fns/fp/setWeekWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/setWeekYear/index.d.ts +2 -0
- package/dist/date-fns/fp/setWeekYearWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/setYear/index.d.ts +2 -0
- package/dist/date-fns/fp/startOfDay/index.d.ts +2 -0
- package/dist/date-fns/fp/startOfDecade/index.d.ts +2 -0
- package/dist/date-fns/fp/startOfHour/index.d.ts +2 -0
- package/dist/date-fns/fp/startOfISOWeek/index.d.ts +2 -0
- package/dist/date-fns/fp/startOfISOWeekYear/index.d.ts +2 -0
- package/dist/date-fns/fp/startOfMinute/index.d.ts +2 -0
- package/dist/date-fns/fp/startOfMonth/index.d.ts +2 -0
- package/dist/date-fns/fp/startOfQuarter/index.d.ts +2 -0
- package/dist/date-fns/fp/startOfSecond/index.d.ts +2 -0
- package/dist/date-fns/fp/startOfWeek/index.d.ts +2 -0
- package/dist/date-fns/fp/startOfWeekWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/startOfWeekYear/index.d.ts +2 -0
- package/dist/date-fns/fp/startOfWeekYearWithOptions/index.d.ts +2 -0
- package/dist/date-fns/fp/startOfYear/index.d.ts +2 -0
- package/dist/date-fns/fp/sub/index.d.ts +2 -0
- package/dist/date-fns/fp/subBusinessDays/index.d.ts +2 -0
- package/dist/date-fns/fp/subDays/index.d.ts +2 -0
- package/dist/date-fns/fp/subHours/index.d.ts +2 -0
- package/dist/date-fns/fp/subISOWeekYears/index.d.ts +2 -0
- package/dist/date-fns/fp/subMilliseconds/index.d.ts +2 -0
- package/dist/date-fns/fp/subMinutes/index.d.ts +2 -0
- package/dist/date-fns/fp/subMonths/index.d.ts +2 -0
- package/dist/date-fns/fp/subQuarters/index.d.ts +2 -0
- package/dist/date-fns/fp/subSeconds/index.d.ts +2 -0
- package/dist/date-fns/fp/subWeeks/index.d.ts +2 -0
- package/dist/date-fns/fp/subYears/index.d.ts +2 -0
- package/dist/date-fns/fp/toDate/index.d.ts +2 -0
- package/dist/date-fns/fp/weeksToDays/index.d.ts +2 -0
- package/dist/date-fns/fp/yearsToMonths/index.d.ts +2 -0
- package/dist/date-fns/fp/yearsToQuarters/index.d.ts +2 -0
- package/dist/date-fns/fromUnixTime/index.d.ts +17 -0
- package/dist/date-fns/getDate/index.d.ts +17 -0
- package/dist/date-fns/getDay/index.d.ts +17 -0
- package/dist/date-fns/getDayOfYear/index.d.ts +17 -0
- package/dist/date-fns/getDaysInMonth/index.d.ts +17 -0
- package/dist/date-fns/getDaysInYear/index.d.ts +17 -0
- package/dist/date-fns/getDecade/index.d.ts +17 -0
- package/dist/date-fns/getDefaultOptions/index.d.ts +26 -0
- package/dist/date-fns/getHours/index.d.ts +17 -0
- package/dist/date-fns/getISODay/index.d.ts +20 -0
- package/dist/date-fns/getISOWeek/index.d.ts +19 -0
- package/dist/date-fns/getISOWeekYear/index.d.ts +20 -0
- package/dist/date-fns/getISOWeeksInYear/index.d.ts +19 -0
- package/dist/date-fns/getMilliseconds/index.d.ts +17 -0
- package/dist/date-fns/getMinutes/index.d.ts +17 -0
- package/dist/date-fns/getMonth/index.d.ts +17 -0
- package/dist/date-fns/getOverlappingDaysInIntervals/index.d.ts +32 -0
- package/dist/date-fns/getQuarter/index.d.ts +17 -0
- package/dist/date-fns/getSeconds/index.d.ts +17 -0
- package/dist/date-fns/getTime/index.d.ts +17 -0
- package/dist/date-fns/getUnixTime/index.d.ts +17 -0
- package/dist/date-fns/getWeek/index.d.ts +39 -0
- package/dist/date-fns/getWeekOfMonth/index.d.ts +24 -0
- package/dist/date-fns/getWeekYear/index.d.ts +40 -0
- package/dist/date-fns/getWeeksInMonth/index.d.ts +30 -0
- package/dist/date-fns/getYear/index.d.ts +17 -0
- package/dist/date-fns/hoursToMilliseconds/index.d.ts +18 -0
- package/dist/date-fns/hoursToMinutes/index.d.ts +18 -0
- package/dist/date-fns/hoursToSeconds/index.d.ts +18 -0
- package/dist/date-fns/index.d.ts +240 -0
- package/dist/date-fns/intervalToDuration/index.d.ts +25 -0
- package/dist/date-fns/intlFormat/index.d.ts +10 -0
- package/dist/date-fns/intlFormatDistance/index.d.ts +107 -0
- package/dist/date-fns/isAfter/index.d.ts +18 -0
- package/dist/date-fns/isBefore/index.d.ts +18 -0
- package/dist/date-fns/isDate/index.d.ts +32 -0
- package/dist/date-fns/isEqual/index.d.ts +21 -0
- package/dist/date-fns/isExists/index.d.ts +24 -0
- package/dist/date-fns/isFirstDayOfMonth/index.d.ts +17 -0
- package/dist/date-fns/isFriday/index.d.ts +17 -0
- package/dist/date-fns/isFuture/index.d.ts +21 -0
- package/dist/date-fns/isLastDayOfMonth/index.d.ts +17 -0
- package/dist/date-fns/isLeapYear/index.d.ts +17 -0
- package/dist/date-fns/isMatch/index.d.ts +291 -0
- package/dist/date-fns/isMonday/index.d.ts +17 -0
- package/dist/date-fns/isPast/index.d.ts +21 -0
- package/dist/date-fns/isSameDay/index.d.ts +28 -0
- package/dist/date-fns/isSameHour/index.d.ts +23 -0
- package/dist/date-fns/isSameISOWeek/index.d.ts +25 -0
- package/dist/date-fns/isSameISOWeekYear/index.d.ts +20 -0
- package/dist/date-fns/isSameMinute/index.d.ts +29 -0
- package/dist/date-fns/isSameMonth/index.d.ts +23 -0
- package/dist/date-fns/isSameQuarter/index.d.ts +23 -0
- package/dist/date-fns/isSameSecond/index.d.ts +37 -0
- package/dist/date-fns/isSameWeek/index.d.ts +38 -0
- package/dist/date-fns/isSameYear/index.d.ts +18 -0
- package/dist/date-fns/isSaturday/index.d.ts +17 -0
- package/dist/date-fns/isSunday/index.d.ts +17 -0
- package/dist/date-fns/isThisHour/index.d.ts +22 -0
- package/dist/date-fns/isThisISOWeek/index.d.ts +23 -0
- package/dist/date-fns/isThisMinute/index.d.ts +22 -0
- package/dist/date-fns/isThisMonth/index.d.ts +21 -0
- package/dist/date-fns/isThisQuarter/index.d.ts +21 -0
- package/dist/date-fns/isThisSecond/index.d.ts +22 -0
- package/dist/date-fns/isThisWeek/index.d.ts +34 -0
- package/dist/date-fns/isThisYear/index.d.ts +21 -0
- package/dist/date-fns/isThursday/index.d.ts +17 -0
- package/dist/date-fns/isToday/index.d.ts +21 -0
- package/dist/date-fns/isTomorrow/index.d.ts +21 -0
- package/dist/date-fns/isTuesday/index.d.ts +17 -0
- package/dist/date-fns/isValid/index.d.ts +31 -0
- package/dist/date-fns/isWednesday/index.d.ts +17 -0
- package/dist/date-fns/isWeekend/index.d.ts +17 -0
- package/dist/date-fns/isWithinInterval/index.d.ts +40 -0
- package/dist/date-fns/isYesterday/index.d.ts +21 -0
- package/dist/date-fns/lastDayOfDecade/index.d.ts +17 -0
- package/dist/date-fns/lastDayOfISOWeek/index.d.ts +20 -0
- package/dist/date-fns/lastDayOfISOWeekYear/index.d.ts +21 -0
- package/dist/date-fns/lastDayOfMonth/index.d.ts +18 -0
- package/dist/date-fns/lastDayOfQuarter/index.d.ts +18 -0
- package/dist/date-fns/lastDayOfWeek/index.d.ts +30 -0
- package/dist/date-fns/lastDayOfYear/index.d.ts +18 -0
- package/dist/date-fns/lightFormat/index.d.ts +1 -0
- package/dist/date-fns/locale/_lib/buildFormatLongFn/index.d.ts +10 -0
- package/dist/date-fns/locale/_lib/buildLocalizeFn/index.d.ts +37 -0
- package/dist/date-fns/locale/_lib/buildMatchFn/index.d.ts +2 -0
- package/dist/date-fns/locale/_lib/buildMatchPatternFn/index.d.ts +7 -0
- package/dist/date-fns/locale/en-US/_lib/formatDistance/index.d.ts +3 -0
- package/dist/date-fns/locale/en-US/_lib/formatLong/index.d.ts +3 -0
- package/dist/date-fns/locale/en-US/_lib/formatRelative/index.d.ts +3 -0
- package/dist/date-fns/locale/en-US/_lib/localize/index.d.ts +3 -0
- package/dist/date-fns/locale/en-US/_lib/match/index.d.ts +3 -0
- package/dist/date-fns/locale/en-US/index.d.ts +12 -0
- package/dist/date-fns/locale/index.d.ts +1 -0
- package/dist/date-fns/locale/types.d.ts +115 -0
- package/dist/date-fns/max/index.d.ts +22 -0
- package/dist/date-fns/milliseconds/index.d.ts +30 -0
- package/dist/date-fns/millisecondsToHours/index.d.ts +23 -0
- package/dist/date-fns/millisecondsToMinutes/index.d.ts +23 -0
- package/dist/date-fns/millisecondsToSeconds/index.d.ts +23 -0
- package/dist/date-fns/min/index.d.ts +22 -0
- package/dist/date-fns/minutesToHours/index.d.ts +23 -0
- package/dist/date-fns/minutesToMilliseconds/index.d.ts +18 -0
- package/dist/date-fns/minutesToSeconds/index.d.ts +18 -0
- package/dist/date-fns/monthsToQuarters/index.d.ts +23 -0
- package/dist/date-fns/monthsToYears/index.d.ts +22 -0
- package/dist/date-fns/nextDay/index.d.ts +24 -0
- package/dist/date-fns/nextFriday/index.d.ts +17 -0
- package/dist/date-fns/nextMonday/index.d.ts +17 -0
- package/dist/date-fns/nextSaturday/index.d.ts +17 -0
- package/dist/date-fns/nextSunday/index.d.ts +17 -0
- package/dist/date-fns/nextThursday/index.d.ts +17 -0
- package/dist/date-fns/nextTuesday/index.d.ts +17 -0
- package/dist/date-fns/nextWednesday/index.d.ts +17 -0
- package/dist/date-fns/parse/_lib/Parser.d.ts +15 -0
- package/dist/date-fns/parse/_lib/Setter.d.ts +21 -0
- package/dist/date-fns/parse/_lib/constants.d.ts +28 -0
- package/dist/date-fns/parse/_lib/parsers/AMPMMidnightParser.d.ts +9 -0
- package/dist/date-fns/parse/_lib/parsers/AMPMParser.d.ts +9 -0
- package/dist/date-fns/parse/_lib/parsers/DateParser.d.ts +11 -0
- package/dist/date-fns/parse/_lib/parsers/DayOfYearParser.d.ts +11 -0
- package/dist/date-fns/parse/_lib/parsers/DayParser.d.ts +10 -0
- package/dist/date-fns/parse/_lib/parsers/DayPeriodParser.d.ts +9 -0
- package/dist/date-fns/parse/_lib/parsers/EraParser.d.ts +10 -0
- package/dist/date-fns/parse/_lib/parsers/ExtendedYearParser.d.ts +8 -0
- package/dist/date-fns/parse/_lib/parsers/FractionOfSecondParser.d.ts +8 -0
- package/dist/date-fns/parse/_lib/parsers/Hour0To11Parser.d.ts +10 -0
- package/dist/date-fns/parse/_lib/parsers/Hour0to23Parser.d.ts +10 -0
- package/dist/date-fns/parse/_lib/parsers/Hour1To24Parser.d.ts +10 -0
- package/dist/date-fns/parse/_lib/parsers/Hour1to12Parser.d.ts +10 -0
- package/dist/date-fns/parse/_lib/parsers/ISODayParser.d.ts +10 -0
- package/dist/date-fns/parse/_lib/parsers/ISOTimezoneParser.d.ts +8 -0
- package/dist/date-fns/parse/_lib/parsers/ISOTimezoneWithZParser.d.ts +8 -0
- package/dist/date-fns/parse/_lib/parsers/ISOWeekParser.d.ts +10 -0
- package/dist/date-fns/parse/_lib/parsers/ISOWeekYearParser.d.ts +8 -0
- package/dist/date-fns/parse/_lib/parsers/LocalDayParser.d.ts +10 -0
- package/dist/date-fns/parse/_lib/parsers/LocalWeekParser.d.ts +10 -0
- package/dist/date-fns/parse/_lib/parsers/LocalWeekYearParser.d.ts +11 -0
- package/dist/date-fns/parse/_lib/parsers/MinuteParser.d.ts +10 -0
- package/dist/date-fns/parse/_lib/parsers/MonthParser.d.ts +10 -0
- package/dist/date-fns/parse/_lib/parsers/QuarterParser.d.ts +10 -0
- package/dist/date-fns/parse/_lib/parsers/SecondParser.d.ts +10 -0
- package/dist/date-fns/parse/_lib/parsers/StandAloneLocalDayParser.d.ts +10 -0
- package/dist/date-fns/parse/_lib/parsers/StandAloneMonthParser.d.ts +10 -0
- package/dist/date-fns/parse/_lib/parsers/StandAloneQuarterParser.d.ts +10 -0
- package/dist/date-fns/parse/_lib/parsers/TimestampMillisecondsParser.d.ts +8 -0
- package/dist/date-fns/parse/_lib/parsers/TimestampSecondsParser.d.ts +8 -0
- package/dist/date-fns/parse/_lib/parsers/YearParser.d.ts +14 -0
- package/dist/date-fns/parse/_lib/parsers/index.d.ts +2 -0
- package/dist/date-fns/parse/_lib/types.d.ts +10 -0
- package/dist/date-fns/parse/_lib/utils.d.ts +11 -0
- package/dist/date-fns/parse/index.d.ts +300 -0
- package/dist/date-fns/parseISO/index.d.ts +36 -0
- package/dist/date-fns/parseJSON/index.d.ts +34 -0
- package/dist/date-fns/previousDay/index.d.ts +24 -0
- package/dist/date-fns/previousFriday/index.d.ts +17 -0
- package/dist/date-fns/previousMonday/index.d.ts +17 -0
- package/dist/date-fns/previousSaturday/index.d.ts +17 -0
- package/dist/date-fns/previousSunday/index.d.ts +17 -0
- package/dist/date-fns/previousThursday/index.d.ts +17 -0
- package/dist/date-fns/previousTuesday/index.d.ts +17 -0
- package/dist/date-fns/previousWednesday/index.d.ts +17 -0
- package/dist/date-fns/quartersToMonths/index.d.ts +18 -0
- package/dist/date-fns/quartersToYears/index.d.ts +23 -0
- package/dist/date-fns/roundToNearestMinutes/index.d.ts +33 -0
- package/dist/date-fns/secondsToHours/index.d.ts +23 -0
- package/dist/date-fns/secondsToMilliseconds/index.d.ts +18 -0
- package/dist/date-fns/secondsToMinutes/index.d.ts +23 -0
- package/dist/date-fns/set/index.d.ts +38 -0
- package/dist/date-fns/setDate/index.d.ts +18 -0
- package/dist/date-fns/setDay/index.d.ts +30 -0
- package/dist/date-fns/setDayOfYear/index.d.ts +18 -0
- package/dist/date-fns/setDefaultOptions/index.d.ts +50 -0
- package/dist/date-fns/setHours/index.d.ts +18 -0
- package/dist/date-fns/setISODay/index.d.ts +20 -0
- package/dist/date-fns/setISOWeek/index.d.ts +20 -0
- package/dist/date-fns/setISOWeekYear/index.d.ts +21 -0
- package/dist/date-fns/setMilliseconds/index.d.ts +18 -0
- package/dist/date-fns/setMinutes/index.d.ts +18 -0
- package/dist/date-fns/setMonth/index.d.ts +18 -0
- package/dist/date-fns/setQuarter/index.d.ts +18 -0
- package/dist/date-fns/setSeconds/index.d.ts +18 -0
- package/dist/date-fns/setWeek/index.d.ts +41 -0
- package/dist/date-fns/setWeekYear/index.d.ts +42 -0
- package/dist/date-fns/setYear/index.d.ts +18 -0
- package/dist/date-fns/startOfDay/index.d.ts +18 -0
- package/dist/date-fns/startOfDecade/index.d.ts +17 -0
- package/dist/date-fns/startOfHour/index.d.ts +18 -0
- package/dist/date-fns/startOfISOWeek/index.d.ts +20 -0
- package/dist/date-fns/startOfISOWeekYear/index.d.ts +21 -0
- package/dist/date-fns/startOfMinute/index.d.ts +18 -0
- package/dist/date-fns/startOfMonth/index.d.ts +18 -0
- package/dist/date-fns/startOfQuarter/index.d.ts +18 -0
- package/dist/date-fns/startOfSecond/index.d.ts +18 -0
- package/dist/date-fns/startOfToday/index.d.ts +20 -0
- package/dist/date-fns/startOfTomorrow/index.d.ts +20 -0
- package/dist/date-fns/startOfWeek/index.d.ts +30 -0
- package/dist/date-fns/startOfWeekYear/index.d.ts +40 -0
- package/dist/date-fns/startOfYear/index.d.ts +18 -0
- package/dist/date-fns/startOfYesterday/index.d.ts +20 -0
- package/dist/date-fns/sub/index.d.ts +40 -0
- package/dist/date-fns/subBusinessDays/index.d.ts +18 -0
- package/dist/date-fns/subDays/index.d.ts +18 -0
- package/dist/date-fns/subHours/index.d.ts +18 -0
- package/dist/date-fns/subISOWeekYears/index.d.ts +20 -0
- package/dist/date-fns/subMilliseconds/index.d.ts +18 -0
- package/dist/date-fns/subMinutes/index.d.ts +18 -0
- package/dist/date-fns/subMonths/index.d.ts +18 -0
- package/dist/date-fns/subQuarters/index.d.ts +18 -0
- package/dist/date-fns/subSeconds/index.d.ts +18 -0
- package/dist/date-fns/subWeeks/index.d.ts +18 -0
- package/dist/date-fns/subYears/index.d.ts +18 -0
- package/dist/date-fns/toDate/index.d.ts +31 -0
- package/dist/date-fns/transpose/index.d.ts +25 -0
- package/dist/date-fns/types.d.ts +70 -0
- package/dist/date-fns/weeksToDays/index.d.ts +18 -0
- package/dist/date-fns/yearsToMonths/index.d.ts +18 -0
- package/dist/date-fns/yearsToQuarters/index.d.ts +18 -0
- package/dist/date-fns-tz/_lib/newDateUTC/index.d.ts +8 -0
- package/dist/date-fns-tz/_lib/tzIntlTimeZoneName/index.d.ts +10 -0
- package/dist/date-fns-tz/_lib/tzParseTimezone/index.d.ts +1 -0
- package/dist/date-fns-tz/_lib/tzPattern/index.d.ts +3 -0
- package/dist/date-fns-tz/_lib/tzTokenizeDate/index.d.ts +5 -0
- package/dist/date-fns-tz/format/formatters/index.d.ts +19 -0
- package/dist/date-fns-tz/format/index.d.ts +312 -0
- package/dist/date-fns-tz/formatInTimeZone/index.d.ts +24 -0
- package/dist/date-fns-tz/getTimezoneOffset/index.d.ts +28 -0
- package/dist/date-fns-tz/index.d.ts +6 -0
- package/dist/date-fns-tz/toDate/index.d.ts +43 -0
- package/dist/date-fns-tz/types.d.ts +13 -0
- package/dist/date-fns-tz/utcToZonedTime/index.d.ts +26 -0
- package/dist/date-fns-tz/zonedTimeToUtc/index.d.ts +26 -0
- package/dist/format-utc.d.ts +1 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -0
- package/dist/instant.d.ts +28 -0
- package/dist/now.d.ts +9 -0
- package/dist/temporal.d.ts +2 -0
- package/package.json +55 -0
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type { RoundingOptions } from '../types';
|
|
2
|
+
/**
|
|
3
|
+
* The {@link differenceInHours} function options.
|
|
4
|
+
*/
|
|
5
|
+
export interface DifferenceInHoursOptions extends RoundingOptions {
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* @name differenceInHours
|
|
9
|
+
* @category Hour Helpers
|
|
10
|
+
* @summary Get the number of hours between the given dates.
|
|
11
|
+
*
|
|
12
|
+
* @description
|
|
13
|
+
* Get the number of hours between the given dates.
|
|
14
|
+
*
|
|
15
|
+
* @param dateLeft - the later date
|
|
16
|
+
* @param dateRight - the earlier date
|
|
17
|
+
* @param options - an object with options.
|
|
18
|
+
* @returns the number of hours
|
|
19
|
+
*
|
|
20
|
+
* @example
|
|
21
|
+
* // How many hours are between 2 July 2014 06:50:00 and 2 July 2014 19:00:00?
|
|
22
|
+
* const result = differenceInHours(
|
|
23
|
+
* new Date(2014, 6, 2, 19, 0),
|
|
24
|
+
* new Date(2014, 6, 2, 6, 50)
|
|
25
|
+
* )
|
|
26
|
+
* //=> 12
|
|
27
|
+
*/
|
|
28
|
+
export default function differenceInHours<DateType extends Date>(dateLeft: DateType | number, dateRight: DateType | number, options?: DifferenceInHoursOptions): number;
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name differenceInISOWeekYears
|
|
3
|
+
* @category ISO Week-Numbering Year Helpers
|
|
4
|
+
* @summary Get the number of full ISO week-numbering years between the given dates.
|
|
5
|
+
*
|
|
6
|
+
* @description
|
|
7
|
+
* Get the number of full ISO week-numbering years between the given dates.
|
|
8
|
+
*
|
|
9
|
+
* ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_date
|
|
10
|
+
*
|
|
11
|
+
* @param dateLeft - the later date
|
|
12
|
+
* @param dateRight - the earlier date
|
|
13
|
+
* @returns the number of full ISO week-numbering years
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* // How many full ISO week-numbering years are between 1 January 2010 and 1 January 2012?
|
|
17
|
+
* const result = differenceInISOWeekYears(
|
|
18
|
+
* new Date(2012, 0, 1),
|
|
19
|
+
* new Date(2010, 0, 1)
|
|
20
|
+
* )
|
|
21
|
+
* //=> 1
|
|
22
|
+
*/
|
|
23
|
+
export default function differenceInISOWeekYears<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): number;
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name differenceInMilliseconds
|
|
3
|
+
* @category Millisecond Helpers
|
|
4
|
+
* @summary Get the number of milliseconds between the given dates.
|
|
5
|
+
*
|
|
6
|
+
* @description
|
|
7
|
+
* Get the number of milliseconds between the given dates.
|
|
8
|
+
*
|
|
9
|
+
* @param dateLeft - the later date
|
|
10
|
+
* @param dateRight - the earlier date
|
|
11
|
+
* @returns the number of milliseconds
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* // How many milliseconds are between
|
|
15
|
+
* // 2 July 2014 12:30:20.600 and 2 July 2014 12:30:21.700?
|
|
16
|
+
* const result = differenceInMilliseconds(
|
|
17
|
+
* new Date(2014, 6, 2, 12, 30, 21, 700),
|
|
18
|
+
* new Date(2014, 6, 2, 12, 30, 20, 600)
|
|
19
|
+
* )
|
|
20
|
+
* //=> 1100
|
|
21
|
+
*/
|
|
22
|
+
export default function differenceInMilliseconds<DateType extends Date>(dateLeft: DateType | number, dateRight: DateType | number): number;
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import type { RoundingOptions } from '../types';
|
|
2
|
+
/**
|
|
3
|
+
* The {@link differenceInMinutes} function options.
|
|
4
|
+
*/
|
|
5
|
+
export interface DifferenceInMinutesOptions extends RoundingOptions {
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* @name differenceInMinutes
|
|
9
|
+
* @category Minute Helpers
|
|
10
|
+
* @summary Get the number of minutes between the given dates.
|
|
11
|
+
*
|
|
12
|
+
* @description
|
|
13
|
+
* Get the signed number of full (rounded towards 0) minutes between the given dates.
|
|
14
|
+
*
|
|
15
|
+
* @param dateLeft - the later date
|
|
16
|
+
* @param dateRight - the earlier date
|
|
17
|
+
* @param options - an object with options.
|
|
18
|
+
* @returns the number of minutes
|
|
19
|
+
*
|
|
20
|
+
* @example
|
|
21
|
+
* // How many minutes are between 2 July 2014 12:07:59 and 2 July 2014 12:20:00?
|
|
22
|
+
* const result = differenceInMinutes(
|
|
23
|
+
* new Date(2014, 6, 2, 12, 20, 0),
|
|
24
|
+
* new Date(2014, 6, 2, 12, 7, 59)
|
|
25
|
+
* )
|
|
26
|
+
* //=> 12
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* // How many minutes are between 10:01:59 and 10:00:00
|
|
30
|
+
* const result = differenceInMinutes(
|
|
31
|
+
* new Date(2000, 0, 1, 10, 0, 0),
|
|
32
|
+
* new Date(2000, 0, 1, 10, 1, 59)
|
|
33
|
+
* )
|
|
34
|
+
* //=> -1
|
|
35
|
+
*/
|
|
36
|
+
export default function differenceInMinutes<DateType extends Date>(dateLeft: DateType | number, dateRight: DateType | number, options?: DifferenceInMinutesOptions): number;
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name differenceInMonths
|
|
3
|
+
* @category Month Helpers
|
|
4
|
+
* @summary Get the number of full months between the given dates.
|
|
5
|
+
*
|
|
6
|
+
* @description
|
|
7
|
+
* Get the number of full months between the given dates using trunc as a default rounding method.
|
|
8
|
+
*
|
|
9
|
+
* @param dateLeft - the later date
|
|
10
|
+
* @param dateRight - the earlier date
|
|
11
|
+
* @returns the number of full months
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* // How many full months are between 31 January 2014 and 1 September 2014?
|
|
15
|
+
* const result = differenceInMonths(new Date(2014, 8, 1), new Date(2014, 0, 31))
|
|
16
|
+
* //=> 7
|
|
17
|
+
*/
|
|
18
|
+
export default function differenceInMonths<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): number;
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import type { RoundingOptions } from '../types';
|
|
2
|
+
/**
|
|
3
|
+
* The {@link differenceInQuarters} function options.
|
|
4
|
+
*/
|
|
5
|
+
export interface DifferenceInQuartersOptions extends RoundingOptions {
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* @name differenceInQuarters
|
|
9
|
+
* @category Quarter Helpers
|
|
10
|
+
* @summary Get the number of quarters between the given dates.
|
|
11
|
+
*
|
|
12
|
+
* @description
|
|
13
|
+
* Get the number of quarters between the given dates.
|
|
14
|
+
*
|
|
15
|
+
* @param dateLeft - the later date
|
|
16
|
+
* @param dateRight - the earlier date
|
|
17
|
+
* @param options - an object with options.
|
|
18
|
+
* @returns the number of full quarters
|
|
19
|
+
*
|
|
20
|
+
* @example
|
|
21
|
+
* // How many full quarters are between 31 December 2013 and 2 July 2014?
|
|
22
|
+
* const result = differenceInQuarters(new Date(2014, 6, 2), new Date(2013, 11, 31))
|
|
23
|
+
* //=> 2
|
|
24
|
+
*/
|
|
25
|
+
export default function differenceInQuarters<DateType extends Date>(dateLeft: DateType | number, dateRight: DateType | number, options?: DifferenceInQuartersOptions): number;
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import type { RoundingOptions } from '../types';
|
|
2
|
+
/**
|
|
3
|
+
* The {@link differenceInSeconds} function options.
|
|
4
|
+
*/
|
|
5
|
+
export interface DifferenceInSecondsOptions extends RoundingOptions {
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* @name differenceInSeconds
|
|
9
|
+
* @category Second Helpers
|
|
10
|
+
* @summary Get the number of seconds between the given dates.
|
|
11
|
+
*
|
|
12
|
+
* @description
|
|
13
|
+
* Get the number of seconds between the given dates.
|
|
14
|
+
*
|
|
15
|
+
* @param dateLeft - the later date
|
|
16
|
+
* @param dateRight - the earlier date
|
|
17
|
+
* @param options - an object with options.
|
|
18
|
+
* @returns the number of seconds
|
|
19
|
+
*
|
|
20
|
+
* @example
|
|
21
|
+
* // How many seconds are between
|
|
22
|
+
* // 2 July 2014 12:30:07.999 and 2 July 2014 12:30:20.000?
|
|
23
|
+
* const result = differenceInSeconds(
|
|
24
|
+
* new Date(2014, 6, 2, 12, 30, 20, 0),
|
|
25
|
+
* new Date(2014, 6, 2, 12, 30, 7, 999)
|
|
26
|
+
* )
|
|
27
|
+
* //=> 12
|
|
28
|
+
*/
|
|
29
|
+
export default function differenceInSeconds<DateType extends Date>(dateLeft: DateType | number, dateRight: DateType | number, options?: DifferenceInSecondsOptions): number;
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import type { RoundingOptions } from '../types';
|
|
2
|
+
/**
|
|
3
|
+
* The {@link differenceInWeeks} function options.
|
|
4
|
+
*/
|
|
5
|
+
export interface DifferenceInWeeksOptions extends RoundingOptions {
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* @name differenceInWeeks
|
|
9
|
+
* @category Week Helpers
|
|
10
|
+
* @summary Get the number of full weeks between the given dates.
|
|
11
|
+
*
|
|
12
|
+
* @description
|
|
13
|
+
* Get the number of full weeks between two dates. Fractional weeks are
|
|
14
|
+
* truncated towards zero by default.
|
|
15
|
+
*
|
|
16
|
+
* One "full week" is the distance between a local time in one day to the same
|
|
17
|
+
* local time 7 days earlier or later. A full week can sometimes be less than
|
|
18
|
+
* or more than 7*24 hours if a daylight savings change happens between two dates.
|
|
19
|
+
*
|
|
20
|
+
* To ignore DST and only measure exact 7*24-hour periods, use this instead:
|
|
21
|
+
* `Math.floor(differenceInHours(dateLeft, dateRight)/(7*24))|0`.
|
|
22
|
+
*
|
|
23
|
+
*
|
|
24
|
+
* @param dateLeft - the later date
|
|
25
|
+
* @param dateRight - the earlier date
|
|
26
|
+
* @param options - an object with options.
|
|
27
|
+
* @returns the number of full weeks
|
|
28
|
+
*
|
|
29
|
+
* @example
|
|
30
|
+
* // How many full weeks are between 5 July 2014 and 20 July 2014?
|
|
31
|
+
* const result = differenceInWeeks(new Date(2014, 6, 20), new Date(2014, 6, 5))
|
|
32
|
+
* //=> 2
|
|
33
|
+
*
|
|
34
|
+
* // How many full weeks are between
|
|
35
|
+
* // 1 March 2020 0:00 and 6 June 2020 0:00 ?
|
|
36
|
+
* // Note: because local time is used, the
|
|
37
|
+
* // result will always be 8 weeks (54 days),
|
|
38
|
+
* // even if DST starts and the period has
|
|
39
|
+
* // only 54*24-1 hours.
|
|
40
|
+
* const result = differenceInWeeks(
|
|
41
|
+
* new Date(2020, 5, 1),
|
|
42
|
+
* new Date(2020, 2, 6)
|
|
43
|
+
* )
|
|
44
|
+
* //=> 8
|
|
45
|
+
*/
|
|
46
|
+
export default function differenceInWeeks<DateType extends Date>(dateLeft: DateType | number, dateRight: DateType | number, options?: DifferenceInWeeksOptions): number;
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name differenceInYears
|
|
3
|
+
* @category Year Helpers
|
|
4
|
+
* @summary Get the number of full years between the given dates.
|
|
5
|
+
*
|
|
6
|
+
* @description
|
|
7
|
+
* Get the number of full years between the given dates.
|
|
8
|
+
*
|
|
9
|
+
* @param dateLeft - the later date
|
|
10
|
+
* @param dateRight - the earlier date
|
|
11
|
+
* @returns the number of full years
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* // How many full years are between 31 December 2013 and 11 February 2015?
|
|
15
|
+
* const result = differenceInYears(new Date(2015, 1, 11), new Date(2013, 11, 31))
|
|
16
|
+
* //=> 1
|
|
17
|
+
*/
|
|
18
|
+
export default function differenceInYears<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): number;
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import type { Interval, StepOptions } from '../types';
|
|
2
|
+
/**
|
|
3
|
+
* The {@link eachDayOfInterval} function options.
|
|
4
|
+
*/
|
|
5
|
+
export interface EachDayOfIntervalOptions extends StepOptions {
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* @name eachDayOfInterval
|
|
9
|
+
* @category Interval Helpers
|
|
10
|
+
* @summary Return the array of dates within the specified time interval.
|
|
11
|
+
*
|
|
12
|
+
* @description
|
|
13
|
+
* Return the array of dates within the specified time interval.
|
|
14
|
+
*
|
|
15
|
+
* @param interval - the interval. See [Interval]{@link https://date-fns.org/docs/Interval}
|
|
16
|
+
* @param options - an object with options.
|
|
17
|
+
* @returns the array with starts of days from the day of the interval start to the day of the interval end
|
|
18
|
+
* @throws {RangeError} `options.step` must be a number greater than 1
|
|
19
|
+
* @throws {RangeError} The start of an interval cannot be after its end
|
|
20
|
+
* @throws {RangeError} Date in interval cannot be `Invalid Date`
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* // Each day between 6 October 2014 and 10 October 2014:
|
|
24
|
+
* const result = eachDayOfInterval({
|
|
25
|
+
* start: new Date(2014, 9, 6),
|
|
26
|
+
* end: new Date(2014, 9, 10)
|
|
27
|
+
* })
|
|
28
|
+
* //=> [
|
|
29
|
+
* // Mon Oct 06 2014 00:00:00,
|
|
30
|
+
* // Tue Oct 07 2014 00:00:00,
|
|
31
|
+
* // Wed Oct 08 2014 00:00:00,
|
|
32
|
+
* // Thu Oct 09 2014 00:00:00,
|
|
33
|
+
* // Fri Oct 10 2014 00:00:00
|
|
34
|
+
* // ]
|
|
35
|
+
*/
|
|
36
|
+
export default function eachDayOfInterval<DateType extends Date>(interval: Interval<DateType>, options?: EachDayOfIntervalOptions): DateType[];
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import type { Interval, StepOptions } from '../types';
|
|
2
|
+
/**
|
|
3
|
+
* The {@link eachHourOfInterval} function options.
|
|
4
|
+
*/
|
|
5
|
+
export interface EachHourOfIntervalOptions extends StepOptions {
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* @name eachHourOfInterval
|
|
9
|
+
* @category Interval Helpers
|
|
10
|
+
* @summary Return the array of hours within the specified time interval.
|
|
11
|
+
*
|
|
12
|
+
* @description
|
|
13
|
+
* Return the array of hours within the specified time interval.
|
|
14
|
+
*
|
|
15
|
+
* @param interval - the interval. See [Interval]{@link https://date-fns.org/docs/Interval}
|
|
16
|
+
* @param options - an object with options.
|
|
17
|
+
* @returns the array with starts of hours from the hour of the interval start to the hour of the interval end
|
|
18
|
+
* @throws {RangeError} `options.step` must be a number greater than 1
|
|
19
|
+
* @throws {RangeError} The start of an interval cannot be after its end
|
|
20
|
+
* @throws {RangeError} Date in interval cannot be `Invalid Date`
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* // Each hour between 6 October 2014, 12:00 and 6 October 2014, 15:00
|
|
24
|
+
* const result = eachHourOfInterval({
|
|
25
|
+
* start: new Date(2014, 9, 6, 12),
|
|
26
|
+
* end: new Date(2014, 9, 6, 15)
|
|
27
|
+
* })
|
|
28
|
+
* //=> [
|
|
29
|
+
* // Mon Oct 06 2014 12:00:00,
|
|
30
|
+
* // Mon Oct 06 2014 13:00:00,
|
|
31
|
+
* // Mon Oct 06 2014 14:00:00,
|
|
32
|
+
* // Mon Oct 06 2014 15:00:00
|
|
33
|
+
* // ]
|
|
34
|
+
*/
|
|
35
|
+
export default function eachHourOfInterval<DateType extends Date>(interval: Interval<DateType>, options?: EachHourOfIntervalOptions): DateType[];
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import type { Interval, StepOptions } from '../types';
|
|
2
|
+
/**
|
|
3
|
+
* The {@link eachMinuteOfInterval} function options.
|
|
4
|
+
*/
|
|
5
|
+
export interface EachMinuteOfIntervalOptions extends StepOptions {
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* @name eachMinuteOfInterval
|
|
9
|
+
* @category Interval Helpers
|
|
10
|
+
* @summary Return the array of minutes within the specified time interval.
|
|
11
|
+
*
|
|
12
|
+
* @description
|
|
13
|
+
* Returns the array of minutes within the specified time interval.
|
|
14
|
+
*
|
|
15
|
+
* @param interval - the interval. See [Interval]{@link https://date-fns.org/docs/Interval}
|
|
16
|
+
* @param options - an object with options.
|
|
17
|
+
* @returns the array with starts of minutes from the minute of the interval start to the minute of the interval end
|
|
18
|
+
* @throws {RangeError} `options.step` must be a number equal to or greater than 1
|
|
19
|
+
* @throws {RangeError} The start of an interval cannot be after its end
|
|
20
|
+
* @throws {RangeError} Date in interval cannot be `Invalid Date`
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* // Each minute between 14 October 2020, 13:00 and 14 October 2020, 13:03
|
|
24
|
+
* const result = eachMinuteOfInterval({
|
|
25
|
+
* start: new Date(2014, 9, 14, 13),
|
|
26
|
+
* end: new Date(2014, 9, 14, 13, 3)
|
|
27
|
+
* })
|
|
28
|
+
* //=> [
|
|
29
|
+
* // Wed Oct 14 2014 13:00:00,
|
|
30
|
+
* // Wed Oct 14 2014 13:01:00,
|
|
31
|
+
* // Wed Oct 14 2014 13:02:00,
|
|
32
|
+
* // Wed Oct 14 2014 13:03:00
|
|
33
|
+
* // ]
|
|
34
|
+
*/
|
|
35
|
+
export default function eachMinuteOfInterval<DateType extends Date>(interval: Interval<DateType>, options?: EachMinuteOfIntervalOptions): DateType[];
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import type { Interval } from '../types';
|
|
2
|
+
/**
|
|
3
|
+
* @name eachMonthOfInterval
|
|
4
|
+
* @category Interval Helpers
|
|
5
|
+
* @summary Return the array of months within the specified time interval.
|
|
6
|
+
*
|
|
7
|
+
* @description
|
|
8
|
+
* Return the array of months within the specified time interval.
|
|
9
|
+
*
|
|
10
|
+
* @param interval - the interval. See [Interval]{@link https://date-fns.org/docs/Interval}
|
|
11
|
+
* @returns the array with starts of months from the month of the interval start to the month of the interval end
|
|
12
|
+
* @throws {RangeError} The start of an interval cannot be after its end
|
|
13
|
+
* @throws {RangeError} Date in interval cannot be `Invalid Date`
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* // Each month between 6 February 2014 and 10 August 2014:
|
|
17
|
+
* const result = eachMonthOfInterval({
|
|
18
|
+
* start: new Date(2014, 1, 6),
|
|
19
|
+
* end: new Date(2014, 7, 10)
|
|
20
|
+
* })
|
|
21
|
+
* //=> [
|
|
22
|
+
* // Sat Feb 01 2014 00:00:00,
|
|
23
|
+
* // Sat Mar 01 2014 00:00:00,
|
|
24
|
+
* // Tue Apr 01 2014 00:00:00,
|
|
25
|
+
* // Thu May 01 2014 00:00:00,
|
|
26
|
+
* // Sun Jun 01 2014 00:00:00,
|
|
27
|
+
* // Tue Jul 01 2014 00:00:00,
|
|
28
|
+
* // Fri Aug 01 2014 00:00:00
|
|
29
|
+
* // ]
|
|
30
|
+
*/
|
|
31
|
+
export default function eachMonthOfInterval<DateType extends Date>(interval: Interval<DateType>): DateType[];
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import type { Interval } from '../types';
|
|
2
|
+
/**
|
|
3
|
+
* @name eachQuarterOfInterval
|
|
4
|
+
* @category Interval Helpers
|
|
5
|
+
* @summary Return the array of quarters within the specified time interval.
|
|
6
|
+
*
|
|
7
|
+
* @description
|
|
8
|
+
* Return the array of quarters within the specified time interval.
|
|
9
|
+
*
|
|
10
|
+
* @param interval - the interval. See [Interval]{@link https://date-fns.org/docs/Interval}
|
|
11
|
+
* @returns the array with starts of quarters from the quarter of the interval start to the quarter of the interval end
|
|
12
|
+
* @throws {RangeError} The start of an interval cannot be after its end
|
|
13
|
+
* @throws {RangeError} Date in interval cannot be `Invalid Date`
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* // Each quarter within interval 6 February 2014 - 10 August 2014:
|
|
17
|
+
* const result = eachQuarterOfInterval({
|
|
18
|
+
* start: new Date(2014, 1, 6),
|
|
19
|
+
* end: new Date(2014, 7, 10)
|
|
20
|
+
* })
|
|
21
|
+
* //=> [
|
|
22
|
+
* // Wed Jan 01 2014 00:00:00,
|
|
23
|
+
* // Tue Apr 01 2014 00:00:00,
|
|
24
|
+
* // Tue Jul 01 2014 00:00:00,
|
|
25
|
+
* // ]
|
|
26
|
+
*/
|
|
27
|
+
export default function eachQuarterOfInterval<DateType extends Date>(interval: Interval<DateType>): DateType[];
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import type { Interval, LocaleOptions, WeekStartOptions } from '../types';
|
|
2
|
+
/**
|
|
3
|
+
* The {@link eachWeekOfInterval} function options.
|
|
4
|
+
*/
|
|
5
|
+
export interface EachWeekOfIntervalOptions extends WeekStartOptions, LocaleOptions {
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* @name eachWeekOfInterval
|
|
9
|
+
* @category Interval Helpers
|
|
10
|
+
* @summary Return the array of weeks within the specified time interval.
|
|
11
|
+
*
|
|
12
|
+
* @description
|
|
13
|
+
* Return the array of weeks within the specified time interval.
|
|
14
|
+
*
|
|
15
|
+
* @param interval - the interval. See [Interval]{@link https://date-fns.org/docs/Interval}
|
|
16
|
+
* @param options - an object with options.
|
|
17
|
+
* @returns the array with starts of weeks from the week of the interval start to the week of the interval end
|
|
18
|
+
* @throws {RangeError} The start of an interval cannot be after its end
|
|
19
|
+
* @throws {RangeError} Date in interval cannot be `Invalid Date`
|
|
20
|
+
*
|
|
21
|
+
* @example
|
|
22
|
+
* // Each week within interval 6 October 2014 - 23 November 2014:
|
|
23
|
+
* const result = eachWeekOfInterval({
|
|
24
|
+
* start: new Date(2014, 9, 6),
|
|
25
|
+
* end: new Date(2014, 10, 23)
|
|
26
|
+
* })
|
|
27
|
+
* //=> [
|
|
28
|
+
* // Sun Oct 05 2014 00:00:00,
|
|
29
|
+
* // Sun Oct 12 2014 00:00:00,
|
|
30
|
+
* // Sun Oct 19 2014 00:00:00,
|
|
31
|
+
* // Sun Oct 26 2014 00:00:00,
|
|
32
|
+
* // Sun Nov 02 2014 00:00:00,
|
|
33
|
+
* // Sun Nov 09 2014 00:00:00,
|
|
34
|
+
* // Sun Nov 16 2014 00:00:00,
|
|
35
|
+
* // Sun Nov 23 2014 00:00:00
|
|
36
|
+
* // ]
|
|
37
|
+
*/
|
|
38
|
+
export default function eachWeekOfInterval<DateType extends Date>(interval: Interval<DateType>, options?: EachWeekOfIntervalOptions): DateType[];
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type { Interval } from '../types';
|
|
2
|
+
/**
|
|
3
|
+
* @name eachWeekendOfInterval
|
|
4
|
+
* @category Interval Helpers
|
|
5
|
+
* @summary List all the Saturdays and Sundays in the given date interval.
|
|
6
|
+
*
|
|
7
|
+
* @description
|
|
8
|
+
* Get all the Saturdays and Sundays in the given date interval.
|
|
9
|
+
*
|
|
10
|
+
* @param interval - the given interval. See [Interval]{@link https://date-fns.org/docs/Interval}
|
|
11
|
+
* @returns an array containing all the Saturdays and Sundays
|
|
12
|
+
* @throws {RangeError} The start of an interval cannot be after its end
|
|
13
|
+
* @throws {RangeError} Date in interval cannot be `Invalid Date`
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* // Lists all Saturdays and Sundays in the given date interval
|
|
17
|
+
* const result = eachWeekendOfInterval({
|
|
18
|
+
* start: new Date(2018, 8, 17),
|
|
19
|
+
* end: new Date(2018, 8, 30)
|
|
20
|
+
* })
|
|
21
|
+
* //=> [
|
|
22
|
+
* // Sat Sep 22 2018 00:00:00,
|
|
23
|
+
* // Sun Sep 23 2018 00:00:00,
|
|
24
|
+
* // Sat Sep 29 2018 00:00:00,
|
|
25
|
+
* // Sun Sep 30 2018 00:00:00
|
|
26
|
+
* // ]
|
|
27
|
+
*/
|
|
28
|
+
export default function eachWeekendOfInterval<DateType extends Date>(interval: Interval<DateType>): DateType[];
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name eachWeekendOfMonth
|
|
3
|
+
* @category Month Helpers
|
|
4
|
+
* @summary List all the Saturdays and Sundays in the given month.
|
|
5
|
+
*
|
|
6
|
+
* @description
|
|
7
|
+
* Get all the Saturdays and Sundays in the given month.
|
|
8
|
+
*
|
|
9
|
+
* @param date - the given month
|
|
10
|
+
* @returns an array containing all the Saturdays and Sundays
|
|
11
|
+
* @throws {RangeError} The passed date is invalid
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* // Lists all Saturdays and Sundays in the given month
|
|
15
|
+
* const result = eachWeekendOfMonth(new Date(2022, 1, 1))
|
|
16
|
+
* //=> [
|
|
17
|
+
* // Sat Feb 05 2022 00:00:00,
|
|
18
|
+
* // Sun Feb 06 2022 00:00:00,
|
|
19
|
+
* // Sat Feb 12 2022 00:00:00,
|
|
20
|
+
* // Sun Feb 13 2022 00:00:00,
|
|
21
|
+
* // Sat Feb 19 2022 00:00:00,
|
|
22
|
+
* // Sun Feb 20 2022 00:00:00,
|
|
23
|
+
* // Sat Feb 26 2022 00:00:00,
|
|
24
|
+
* // Sun Feb 27 2022 00:00:00
|
|
25
|
+
* // ]
|
|
26
|
+
*/
|
|
27
|
+
export default function eachWeekendOfMonth<DateType extends Date>(dirtyDate: DateType): DateType[];
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name eachWeekendOfYear
|
|
3
|
+
* @category Year Helpers
|
|
4
|
+
* @summary List all the Saturdays and Sundays in the year.
|
|
5
|
+
*
|
|
6
|
+
* @description
|
|
7
|
+
* Get all the Saturdays and Sundays in the year.
|
|
8
|
+
*
|
|
9
|
+
* @param date - the given year
|
|
10
|
+
* @returns an array containing all the Saturdays and Sundays
|
|
11
|
+
* @throws {RangeError} The passed date is invalid
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* // Lists all Saturdays and Sundays in the year
|
|
15
|
+
* const result = eachWeekendOfYear(new Date(2020, 1, 1))
|
|
16
|
+
* //=> [
|
|
17
|
+
* // Sat Jan 03 2020 00:00:00,
|
|
18
|
+
* // Sun Jan 04 2020 00:00:00,
|
|
19
|
+
* // ...
|
|
20
|
+
* // Sun Dec 27 2020 00:00:00
|
|
21
|
+
* // ]
|
|
22
|
+
* ]
|
|
23
|
+
*/
|
|
24
|
+
export default function eachWeekendOfYear<DateType extends Date>(dirtyDate: DateType | number): DateType[];
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type { Interval } from '../types';
|
|
2
|
+
/**
|
|
3
|
+
* @name eachYearOfInterval
|
|
4
|
+
* @category Interval Helpers
|
|
5
|
+
* @summary Return the array of yearly timestamps within the specified time interval.
|
|
6
|
+
*
|
|
7
|
+
* @description
|
|
8
|
+
* Return the array of yearly timestamps within the specified time interval.
|
|
9
|
+
*
|
|
10
|
+
* @param interval - the interval. See [Interval]{@link https://date-fns.org/docs/Interval}
|
|
11
|
+
* @returns the array with starts of yearly timestamps from the month of the interval start to the month of the interval end
|
|
12
|
+
* @throws {RangeError} The start of an interval cannot be after its end
|
|
13
|
+
* @throws {RangeError} Date in interval cannot be `Invalid Date`
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* // Each year between 6 February 2014 and 10 August 2017:
|
|
17
|
+
* const result = eachYearOfInterval({
|
|
18
|
+
* start: new Date(2014, 1, 6),
|
|
19
|
+
* end: new Date(2017, 7, 10)
|
|
20
|
+
* })
|
|
21
|
+
* //=> [
|
|
22
|
+
* // Wed Jan 01 2014 00:00:00,
|
|
23
|
+
* // Thu Jan 01 2015 00:00:00,
|
|
24
|
+
* // Fri Jan 01 2016 00:00:00,
|
|
25
|
+
* // Sun Jan 01 2017 00:00:00
|
|
26
|
+
* // ]
|
|
27
|
+
*/
|
|
28
|
+
export default function eachYearOfInterval<DateType extends Date>(interval: Interval<DateType>): DateType[];
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name endOfDay
|
|
3
|
+
* @category Day Helpers
|
|
4
|
+
* @summary Return the end of a day for the given date.
|
|
5
|
+
*
|
|
6
|
+
* @description
|
|
7
|
+
* Return the end of a day for the given date.
|
|
8
|
+
* The result will be in the local timezone.
|
|
9
|
+
*
|
|
10
|
+
* @param date - the original date
|
|
11
|
+
* @returns the end of a day
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* // The end of a day for 2 September 2014 11:55:00:
|
|
15
|
+
* const result = endOfDay(new Date(2014, 8, 2, 11, 55, 0))
|
|
16
|
+
* //=> Tue Sep 02 2014 23:59:59.999
|
|
17
|
+
*/
|
|
18
|
+
export default function endOfDay<DateType extends Date>(dirtyDate: DateType | number): DateType;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name endOfDecade
|
|
3
|
+
* @category Decade Helpers
|
|
4
|
+
* @summary Return the end of a decade for the given date.
|
|
5
|
+
*
|
|
6
|
+
* @description
|
|
7
|
+
* Return the end of a decade for the given date.
|
|
8
|
+
*
|
|
9
|
+
* @param date - the original date
|
|
10
|
+
* @returns the end of a decade
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* // The end of a decade for 12 May 1984 00:00:00:
|
|
14
|
+
* const result = endOfDecade(new Date(1984, 4, 12, 00, 00, 00))
|
|
15
|
+
* //=> Dec 31 1989 23:59:59.999
|
|
16
|
+
*/
|
|
17
|
+
export default function endOfDecade<DateType extends Date>(dirtyDate: DateType | number): DateType;
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name endOfHour
|
|
3
|
+
* @category Hour Helpers
|
|
4
|
+
* @summary Return the end of an hour for the given date.
|
|
5
|
+
*
|
|
6
|
+
* @description
|
|
7
|
+
* Return the end of an hour for the given date.
|
|
8
|
+
* The result will be in the local timezone.
|
|
9
|
+
*
|
|
10
|
+
* @param date - the original date
|
|
11
|
+
* @returns the end of an hour
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* // The end of an hour for 2 September 2014 11:55:00:
|
|
15
|
+
* const result = endOfHour(new Date(2014, 8, 2, 11, 55))
|
|
16
|
+
* //=> Tue Sep 02 2014 11:59:59.999
|
|
17
|
+
*/
|
|
18
|
+
export default function endOfHour<DateType extends Date>(dirtyDate: DateType | number): DateType;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name endOfISOWeek
|
|
3
|
+
* @category ISO Week Helpers
|
|
4
|
+
* @summary Return the end of an ISO week for the given date.
|
|
5
|
+
*
|
|
6
|
+
* @description
|
|
7
|
+
* Return the end of an ISO week for the given date.
|
|
8
|
+
* The result will be in the local timezone.
|
|
9
|
+
*
|
|
10
|
+
* ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_date
|
|
11
|
+
*
|
|
12
|
+
* @param date - the original date
|
|
13
|
+
* @returns the end of an ISO week
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* // The end of an ISO week for 2 September 2014 11:55:00:
|
|
17
|
+
* const result = endOfISOWeek(new Date(2014, 8, 2, 11, 55, 0))
|
|
18
|
+
* //=> Sun Sep 07 2014 23:59:59.999
|
|
19
|
+
*/
|
|
20
|
+
export default function endOfISOWeek<DateType extends Date>(dirtyDate: DateType | number): DateType;
|