@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,23 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name isSameMonth
|
|
3
|
+
* @category Month Helpers
|
|
4
|
+
* @summary Are the given dates in the same month (and year)?
|
|
5
|
+
*
|
|
6
|
+
* @description
|
|
7
|
+
* Are the given dates in the same month (and year)?
|
|
8
|
+
*
|
|
9
|
+
* @param dateLeft - the first date to check
|
|
10
|
+
* @param dateRight - the second date to check
|
|
11
|
+
* @returns the dates are in the same month (and year)
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* // Are 2 September 2014 and 25 September 2014 in the same month?
|
|
15
|
+
* const result = isSameMonth(new Date(2014, 8, 2), new Date(2014, 8, 25))
|
|
16
|
+
* //=> true
|
|
17
|
+
*
|
|
18
|
+
* @example
|
|
19
|
+
* // Are 2 September 2014 and 25 September 2015 in the same month?
|
|
20
|
+
* const result = isSameMonth(new Date(2014, 8, 2), new Date(2015, 8, 25))
|
|
21
|
+
* //=> false
|
|
22
|
+
*/
|
|
23
|
+
export default function isSameMonth<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): boolean;
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name isSameQuarter
|
|
3
|
+
* @category Quarter Helpers
|
|
4
|
+
* @summary Are the given dates in the same quarter (and year)?
|
|
5
|
+
*
|
|
6
|
+
* @description
|
|
7
|
+
* Are the given dates in the same quarter (and year)?
|
|
8
|
+
*
|
|
9
|
+
* @param dateLeft - the first date to check
|
|
10
|
+
* @param dateRight - the second date to check
|
|
11
|
+
* @returns the dates are in the same quarter (and year)
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* // Are 1 January 2014 and 8 March 2014 in the same quarter?
|
|
15
|
+
* const result = isSameQuarter(new Date(2014, 0, 1), new Date(2014, 2, 8))
|
|
16
|
+
* //=> true
|
|
17
|
+
*
|
|
18
|
+
* @example
|
|
19
|
+
* // Are 1 January 2014 and 1 January 2015 in the same quarter?
|
|
20
|
+
* const result = isSameQuarter(new Date(2014, 0, 1), new Date(2015, 0, 1))
|
|
21
|
+
* //=> false
|
|
22
|
+
*/
|
|
23
|
+
export default function isSameQuarter<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): boolean;
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name isSameSecond
|
|
3
|
+
* @category Second Helpers
|
|
4
|
+
* @summary Are the given dates in the same second (and hour and day)?
|
|
5
|
+
*
|
|
6
|
+
* @description
|
|
7
|
+
* Are the given dates in the same second (and hour and day)?
|
|
8
|
+
*
|
|
9
|
+
* @param dateLeft - the first date to check
|
|
10
|
+
* @param dateRight - the second date to check
|
|
11
|
+
* @returns the dates are in the same second (and hour and day)
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* // Are 4 September 2014 06:30:15.000 and 4 September 2014 06:30.15.500 in the same second?
|
|
15
|
+
* const result = isSameSecond(
|
|
16
|
+
* new Date(2014, 8, 4, 6, 30, 15),
|
|
17
|
+
* new Date(2014, 8, 4, 6, 30, 15, 500)
|
|
18
|
+
* )
|
|
19
|
+
* //=> true
|
|
20
|
+
*
|
|
21
|
+
* @example
|
|
22
|
+
* // Are 4 September 2014 06:00:15.000 and 4 September 2014 06:01.15.000 in the same second?
|
|
23
|
+
* const result = isSameSecond(
|
|
24
|
+
* new Date(2014, 8, 4, 6, 0, 15),
|
|
25
|
+
* new Date(2014, 8, 4, 6, 1, 15)
|
|
26
|
+
* )
|
|
27
|
+
* //=> false
|
|
28
|
+
*
|
|
29
|
+
* @example
|
|
30
|
+
* // Are 4 September 2014 06:00:15.000 and 5 September 2014 06:00.15.000 in the same second?
|
|
31
|
+
* const result = isSameSecond(
|
|
32
|
+
* new Date(2014, 8, 4, 6, 0, 15),
|
|
33
|
+
* new Date(2014, 8, 5, 6, 0, 15)
|
|
34
|
+
* )
|
|
35
|
+
* //=> false
|
|
36
|
+
*/
|
|
37
|
+
export default function isSameSecond<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): boolean;
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import type { LocaleOptions, WeekStartOptions } from '../types';
|
|
2
|
+
/**
|
|
3
|
+
* The {@link isSameWeek} function options.
|
|
4
|
+
*/
|
|
5
|
+
export interface IsSameWeekOptions extends WeekStartOptions, LocaleOptions {
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* @name isSameWeek
|
|
9
|
+
* @category Week Helpers
|
|
10
|
+
* @summary Are the given dates in the same week (and month and year)?
|
|
11
|
+
*
|
|
12
|
+
* @description
|
|
13
|
+
* Are the given dates in the same week (and month and year)?
|
|
14
|
+
*
|
|
15
|
+
* @param dateLeft - the first date to check
|
|
16
|
+
* @param dateRight - the second date to check
|
|
17
|
+
* @param options - an object with options.
|
|
18
|
+
* @returns the dates are in the same week (and month and year)
|
|
19
|
+
*
|
|
20
|
+
* @example
|
|
21
|
+
* // Are 31 August 2014 and 4 September 2014 in the same week?
|
|
22
|
+
* const result = isSameWeek(new Date(2014, 7, 31), new Date(2014, 8, 4))
|
|
23
|
+
* //=> true
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
* // If week starts with Monday,
|
|
27
|
+
* // are 31 August 2014 and 4 September 2014 in the same week?
|
|
28
|
+
* const result = isSameWeek(new Date(2014, 7, 31), new Date(2014, 8, 4), {
|
|
29
|
+
* weekStartsOn: 1
|
|
30
|
+
* })
|
|
31
|
+
* //=> false
|
|
32
|
+
*
|
|
33
|
+
* @example
|
|
34
|
+
* // Are 1 January 2014 and 1 January 2015 in the same week?
|
|
35
|
+
* const result = isSameWeek(new Date(2014, 0, 1), new Date(2015, 0, 1))
|
|
36
|
+
* //=> false
|
|
37
|
+
*/
|
|
38
|
+
export default function isSameWeek<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number, options?: IsSameWeekOptions): boolean;
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name isSameYear
|
|
3
|
+
* @category Year Helpers
|
|
4
|
+
* @summary Are the given dates in the same year?
|
|
5
|
+
*
|
|
6
|
+
* @description
|
|
7
|
+
* Are the given dates in the same year?
|
|
8
|
+
*
|
|
9
|
+
* @param dateLeft - the first date to check
|
|
10
|
+
* @param dateRight - the second date to check
|
|
11
|
+
* @returns the dates are in the same year
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* // Are 2 September 2014 and 25 September 2014 in the same year?
|
|
15
|
+
* const result = isSameYear(new Date(2014, 8, 2), new Date(2014, 8, 25))
|
|
16
|
+
* //=> true
|
|
17
|
+
*/
|
|
18
|
+
export default function isSameYear<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): boolean;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name isSaturday
|
|
3
|
+
* @category Weekday Helpers
|
|
4
|
+
* @summary Is the given date Saturday?
|
|
5
|
+
*
|
|
6
|
+
* @description
|
|
7
|
+
* Is the given date Saturday?
|
|
8
|
+
*
|
|
9
|
+
* @param date - the date to check
|
|
10
|
+
* @returns the date is Saturday
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* // Is 27 September 2014 Saturday?
|
|
14
|
+
* const result = isSaturday(new Date(2014, 8, 27))
|
|
15
|
+
* //=> true
|
|
16
|
+
*/
|
|
17
|
+
export default function isSaturday<DateType extends Date>(dirtyDate: DateType | number): boolean;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name isSunday
|
|
3
|
+
* @category Weekday Helpers
|
|
4
|
+
* @summary Is the given date Sunday?
|
|
5
|
+
*
|
|
6
|
+
* @description
|
|
7
|
+
* Is the given date Sunday?
|
|
8
|
+
*
|
|
9
|
+
* @param date - the date to check
|
|
10
|
+
* @returns the date is Sunday
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* // Is 21 September 2014 Sunday?
|
|
14
|
+
* const result = isSunday(new Date(2014, 8, 21))
|
|
15
|
+
* //=> true
|
|
16
|
+
*/
|
|
17
|
+
export default function isSunday<DateType extends Date>(dirtyDate: DateType | number): boolean;
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name isThisHour
|
|
3
|
+
* @category Hour Helpers
|
|
4
|
+
* @summary Is the given date in the same hour as the current date?
|
|
5
|
+
* @pure false
|
|
6
|
+
*
|
|
7
|
+
* @description
|
|
8
|
+
* Is the given date in the same hour as the current date?
|
|
9
|
+
*
|
|
10
|
+
* > ⚠️ Please note that this function is not present in the FP submodule as
|
|
11
|
+
* > it uses `Date.now()` internally hence impure and can't be safely curried.
|
|
12
|
+
*
|
|
13
|
+
* @param date - the date to check
|
|
14
|
+
* @returns the date is in this hour
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* // If now is 25 September 2014 18:30:15.500,
|
|
18
|
+
* // is 25 September 2014 18:00:00 in this hour?
|
|
19
|
+
* const result = isThisHour(new Date(2014, 8, 25, 18))
|
|
20
|
+
* //=> true
|
|
21
|
+
*/
|
|
22
|
+
export default function isThisHour<DateType extends Date>(dirtyDate: DateType | number): boolean;
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name isThisISOWeek
|
|
3
|
+
* @category ISO Week Helpers
|
|
4
|
+
* @summary Is the given date in the same ISO week as the current date?
|
|
5
|
+
* @pure false
|
|
6
|
+
*
|
|
7
|
+
* @description
|
|
8
|
+
* Is the given date in the same ISO week as the current date?
|
|
9
|
+
*
|
|
10
|
+
* ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_date
|
|
11
|
+
*
|
|
12
|
+
* > ⚠️ Please note that this function is not present in the FP submodule as
|
|
13
|
+
* > it uses `Date.now()` internally hence impure and can't be safely curried.
|
|
14
|
+
*
|
|
15
|
+
* @param date - the date to check
|
|
16
|
+
* @returns the date is in this ISO week
|
|
17
|
+
*
|
|
18
|
+
* @example
|
|
19
|
+
* // If today is 25 September 2014, is 22 September 2014 in this ISO week?
|
|
20
|
+
* const result = isThisISOWeek(new Date(2014, 8, 22))
|
|
21
|
+
* //=> true
|
|
22
|
+
*/
|
|
23
|
+
export default function isThisISOWeek<DateType extends Date>(dirtyDate: DateType | number): boolean;
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name isThisMinute
|
|
3
|
+
* @category Minute Helpers
|
|
4
|
+
* @summary Is the given date in the same minute as the current date?
|
|
5
|
+
* @pure false
|
|
6
|
+
*
|
|
7
|
+
* @description
|
|
8
|
+
* Is the given date in the same minute as the current date?
|
|
9
|
+
*
|
|
10
|
+
* > ⚠️ Please note that this function is not present in the FP submodule as
|
|
11
|
+
* > it uses `Date.now()` internally hence impure and can't be safely curried.
|
|
12
|
+
*
|
|
13
|
+
* @param date - the date to check
|
|
14
|
+
* @returns the date is in this minute
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* // If now is 25 September 2014 18:30:15.500,
|
|
18
|
+
* // is 25 September 2014 18:30:00 in this minute?
|
|
19
|
+
* const result = isThisMinute(new Date(2014, 8, 25, 18, 30))
|
|
20
|
+
* //=> true
|
|
21
|
+
*/
|
|
22
|
+
export default function isThisMinute<DateType extends Date>(dirtyDate: DateType | number): boolean;
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name isThisMonth
|
|
3
|
+
* @category Month Helpers
|
|
4
|
+
* @summary Is the given date in the same month as the current date?
|
|
5
|
+
* @pure false
|
|
6
|
+
*
|
|
7
|
+
* @description
|
|
8
|
+
* Is the given date in the same month as the current date?
|
|
9
|
+
*
|
|
10
|
+
* > ⚠️ Please note that this function is not present in the FP submodule as
|
|
11
|
+
* > it uses `Date.now()` internally hence impure and can't be safely curried.
|
|
12
|
+
*
|
|
13
|
+
* @param date - the date to check
|
|
14
|
+
* @returns the date is in this month
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* // If today is 25 September 2014, is 15 September 2014 in this month?
|
|
18
|
+
* const result = isThisMonth(new Date(2014, 8, 15))
|
|
19
|
+
* //=> true
|
|
20
|
+
*/
|
|
21
|
+
export default function isThisMonth<DateType extends Date>(dirtyDate: DateType | number): boolean;
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name isThisQuarter
|
|
3
|
+
* @category Quarter Helpers
|
|
4
|
+
* @summary Is the given date in the same quarter as the current date?
|
|
5
|
+
* @pure false
|
|
6
|
+
*
|
|
7
|
+
* @description
|
|
8
|
+
* Is the given date in the same quarter as the current date?
|
|
9
|
+
*
|
|
10
|
+
* > ⚠️ Please note that this function is not present in the FP submodule as
|
|
11
|
+
* > it uses `Date.now()` internally hence impure and can't be safely curried.
|
|
12
|
+
*
|
|
13
|
+
* @param date - the date to check
|
|
14
|
+
* @returns the date is in this quarter
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* // If today is 25 September 2014, is 2 July 2014 in this quarter?
|
|
18
|
+
* const result = isThisQuarter(new Date(2014, 6, 2))
|
|
19
|
+
* //=> true
|
|
20
|
+
*/
|
|
21
|
+
export default function isThisQuarter<DateType extends Date>(dirtyDate: DateType | number): boolean;
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name isThisSecond
|
|
3
|
+
* @category Second Helpers
|
|
4
|
+
* @summary Is the given date in the same second as the current date?
|
|
5
|
+
* @pure false
|
|
6
|
+
*
|
|
7
|
+
* @description
|
|
8
|
+
* Is the given date in the same second as the current date?
|
|
9
|
+
*
|
|
10
|
+
* > ⚠️ Please note that this function is not present in the FP submodule as
|
|
11
|
+
* > it uses `Date.now()` internally hence impure and can't be safely curried.
|
|
12
|
+
*
|
|
13
|
+
* @param date - the date to check
|
|
14
|
+
* @returns the date is in this second
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* // If now is 25 September 2014 18:30:15.500,
|
|
18
|
+
* // is 25 September 2014 18:30:15.000 in this second?
|
|
19
|
+
* const result = isThisSecond(new Date(2014, 8, 25, 18, 30, 15))
|
|
20
|
+
* //=> true
|
|
21
|
+
*/
|
|
22
|
+
export default function isThisSecond<DateType extends Date>(dirtyDate: DateType | number): boolean;
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import type { LocaleOptions, WeekStartOptions } from '../types';
|
|
2
|
+
/**
|
|
3
|
+
* The {@link isThisWeek} function options.
|
|
4
|
+
*/
|
|
5
|
+
export interface IsThisWeekOptions extends WeekStartOptions, LocaleOptions {
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* @name isThisWeek
|
|
9
|
+
* @category Week Helpers
|
|
10
|
+
* @summary Is the given date in the same week as the current date?
|
|
11
|
+
* @pure false
|
|
12
|
+
*
|
|
13
|
+
* @description
|
|
14
|
+
* Is the given date in the same week as the current date?
|
|
15
|
+
*
|
|
16
|
+
* > ⚠️ Please note that this function is not present in the FP submodule as
|
|
17
|
+
* > it uses `Date.now()` internally hence impure and can't be safely curried.
|
|
18
|
+
*
|
|
19
|
+
* @param date - the date to check
|
|
20
|
+
* @param options - the object with options
|
|
21
|
+
* @returns the date is in this week
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* // If today is 25 September 2014, is 21 September 2014 in this week?
|
|
25
|
+
* const result = isThisWeek(new Date(2014, 8, 21))
|
|
26
|
+
* //=> true
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* // If today is 25 September 2014 and week starts with Monday
|
|
30
|
+
* // is 21 September 2014 in this week?
|
|
31
|
+
* const result = isThisWeek(new Date(2014, 8, 21), { weekStartsOn: 1 })
|
|
32
|
+
* //=> false
|
|
33
|
+
*/
|
|
34
|
+
export default function is<DateType extends Date>(dirtyDate: DateType | number, options?: IsThisWeekOptions): boolean;
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name isThisYear
|
|
3
|
+
* @category Year Helpers
|
|
4
|
+
* @summary Is the given date in the same year as the current date?
|
|
5
|
+
* @pure false
|
|
6
|
+
*
|
|
7
|
+
* @description
|
|
8
|
+
* Is the given date in the same year as the current date?
|
|
9
|
+
*
|
|
10
|
+
* > ⚠️ Please note that this function is not present in the FP submodule as
|
|
11
|
+
* > it uses `Date.now()` internally hence impure and can't be safely curried.
|
|
12
|
+
*
|
|
13
|
+
* @param date - the date to check
|
|
14
|
+
* @returns the date is in this year
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* // If today is 25 September 2014, is 2 July 2014 in this year?
|
|
18
|
+
* const result = isThisYear(new Date(2014, 6, 2))
|
|
19
|
+
* //=> true
|
|
20
|
+
*/
|
|
21
|
+
export default function isThisYear<DateType extends Date>(dirtyDate: DateType | number): boolean;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name isThursday
|
|
3
|
+
* @category Weekday Helpers
|
|
4
|
+
* @summary Is the given date Thursday?
|
|
5
|
+
*
|
|
6
|
+
* @description
|
|
7
|
+
* Is the given date Thursday?
|
|
8
|
+
*
|
|
9
|
+
* @param date - the date to check
|
|
10
|
+
* @returns the date is Thursday
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* // Is 25 September 2014 Thursday?
|
|
14
|
+
* const result = isThursday(new Date(2014, 8, 25))
|
|
15
|
+
* //=> true
|
|
16
|
+
*/
|
|
17
|
+
export default function isThursday<DateType extends Date>(dirtyDate: DateType | number): boolean;
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name isToday
|
|
3
|
+
* @category Day Helpers
|
|
4
|
+
* @summary Is the given date today?
|
|
5
|
+
* @pure false
|
|
6
|
+
*
|
|
7
|
+
* @description
|
|
8
|
+
* Is the given date today?
|
|
9
|
+
*
|
|
10
|
+
* > ⚠️ Please note that this function is not present in the FP submodule as
|
|
11
|
+
* > it uses `Date.now()` internally hence impure and can't be safely curried.
|
|
12
|
+
*
|
|
13
|
+
* @param date - the date to check
|
|
14
|
+
* @returns the date is today
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* // If today is 6 October 2014, is 6 October 14:00:00 today?
|
|
18
|
+
* const result = isToday(new Date(2014, 9, 6, 14, 0))
|
|
19
|
+
* //=> true
|
|
20
|
+
*/
|
|
21
|
+
export default function isToday<DateType extends Date>(dirtyDate: DateType | number): boolean;
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name isTomorrow
|
|
3
|
+
* @category Day Helpers
|
|
4
|
+
* @summary Is the given date tomorrow?
|
|
5
|
+
* @pure false
|
|
6
|
+
*
|
|
7
|
+
* @description
|
|
8
|
+
* Is the given date tomorrow?
|
|
9
|
+
*
|
|
10
|
+
* > ⚠️ Please note that this function is not present in the FP submodule as
|
|
11
|
+
* > it uses `Date.now()` internally hence impure and can't be safely curried.
|
|
12
|
+
*
|
|
13
|
+
* @param date - the date to check
|
|
14
|
+
* @returns the date is tomorrow
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* // If today is 6 October 2014, is 7 October 14:00:00 tomorrow?
|
|
18
|
+
* const result = isTomorrow(new Date(2014, 9, 7, 14, 0))
|
|
19
|
+
* //=> true
|
|
20
|
+
*/
|
|
21
|
+
export default function isTomorrow<DateType extends Date>(dirtyDate: DateType | number): boolean;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name isTuesday
|
|
3
|
+
* @category Weekday Helpers
|
|
4
|
+
* @summary Is the given date Tuesday?
|
|
5
|
+
*
|
|
6
|
+
* @description
|
|
7
|
+
* Is the given date Tuesday?
|
|
8
|
+
*
|
|
9
|
+
* @param date - the date to check
|
|
10
|
+
* @returns the date is Tuesday
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* // Is 23 September 2014 Tuesday?
|
|
14
|
+
* const result = isTuesday(new Date(2014, 8, 23))
|
|
15
|
+
* //=> true
|
|
16
|
+
*/
|
|
17
|
+
export default function isTuesday<DateType extends Date>(dirtyDate: DateType | number): boolean;
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name isValid
|
|
3
|
+
* @category Common Helpers
|
|
4
|
+
* @summary Is the given date valid?
|
|
5
|
+
*
|
|
6
|
+
* @description
|
|
7
|
+
* Returns false if argument is Invalid Date and true otherwise.
|
|
8
|
+
* Argument is converted to Date using `toDate`. See [toDate]{@link https://date-fns.org/docs/toDate}
|
|
9
|
+
* Invalid Date is a Date, whose time value is NaN.
|
|
10
|
+
*
|
|
11
|
+
* Time value of Date: http://es5.github.io/#x15.9.1.1
|
|
12
|
+
*
|
|
13
|
+
* @param date - the date to check
|
|
14
|
+
* @returns the date is valid
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* // For the valid date:
|
|
18
|
+
* const result = isValid(new Date(2014, 1, 31))
|
|
19
|
+
* //=> true
|
|
20
|
+
*
|
|
21
|
+
* @example
|
|
22
|
+
* // For the value, convertable into a date:
|
|
23
|
+
* const result = isValid(1393804800000)
|
|
24
|
+
* //=> true
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* // For the invalid date:
|
|
28
|
+
* const result = isValid(new Date(''))
|
|
29
|
+
* //=> false
|
|
30
|
+
*/
|
|
31
|
+
export default function isValid(dirtyDate: unknown): boolean;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name isWednesday
|
|
3
|
+
* @category Weekday Helpers
|
|
4
|
+
* @summary Is the given date Wednesday?
|
|
5
|
+
*
|
|
6
|
+
* @description
|
|
7
|
+
* Is the given date Wednesday?
|
|
8
|
+
*
|
|
9
|
+
* @param date - the date to check
|
|
10
|
+
* @returns the date is Wednesday
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* // Is 24 September 2014 Wednesday?
|
|
14
|
+
* const result = isWednesday(new Date(2014, 8, 24))
|
|
15
|
+
* //=> true
|
|
16
|
+
*/
|
|
17
|
+
export default function isWednesday<DateType extends Date>(dirtyDate: DateType | number): boolean;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name isWeekend
|
|
3
|
+
* @category Weekday Helpers
|
|
4
|
+
* @summary Does the given date fall on a weekend?
|
|
5
|
+
*
|
|
6
|
+
* @description
|
|
7
|
+
* Does the given date fall on a weekend?
|
|
8
|
+
*
|
|
9
|
+
* @param date - the date to check
|
|
10
|
+
* @returns the date falls on a weekend
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* // Does 5 October 2014 fall on a weekend?
|
|
14
|
+
* const result = isWeekend(new Date(2014, 9, 5))
|
|
15
|
+
* //=> true
|
|
16
|
+
*/
|
|
17
|
+
export default function isWeekend<DateType extends Date>(dirtyDate: DateType | number): boolean;
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import type { Interval } from '../types';
|
|
2
|
+
/**
|
|
3
|
+
* @name isWithinInterval
|
|
4
|
+
* @category Interval Helpers
|
|
5
|
+
* @summary Is the given date within the interval?
|
|
6
|
+
*
|
|
7
|
+
* @description
|
|
8
|
+
* Is the given date within the interval? (Including start and end.)
|
|
9
|
+
*
|
|
10
|
+
* @param date - the date to check
|
|
11
|
+
* @param interval - the interval to check
|
|
12
|
+
* @returns the date is within the interval
|
|
13
|
+
* @throws {RangeError} The start of an interval cannot be after its end
|
|
14
|
+
* @throws {RangeError} Date in interval cannot be `Invalid Date`
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* // For the date within the interval:
|
|
18
|
+
* isWithinInterval(new Date(2014, 0, 3), {
|
|
19
|
+
* start: new Date(2014, 0, 1),
|
|
20
|
+
* end: new Date(2014, 0, 7)
|
|
21
|
+
* })
|
|
22
|
+
* //=> true
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* // For the date outside of the interval:
|
|
26
|
+
* isWithinInterval(new Date(2014, 0, 10), {
|
|
27
|
+
* start: new Date(2014, 0, 1),
|
|
28
|
+
* end: new Date(2014, 0, 7)
|
|
29
|
+
* })
|
|
30
|
+
* //=> false
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* // For date equal to interval start:
|
|
34
|
+
* isWithinInterval(date, { start, end: date }) // => true
|
|
35
|
+
*
|
|
36
|
+
* @example
|
|
37
|
+
* // For date equal to interval end:
|
|
38
|
+
* isWithinInterval(date, { start: date, end }) // => true
|
|
39
|
+
*/
|
|
40
|
+
export default function isWithinInterval<DateType extends Date>(dirtyDate: DateType | number, interval: Interval<DateType>): boolean;
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name isYesterday
|
|
3
|
+
* @category Day Helpers
|
|
4
|
+
* @summary Is the given date yesterday?
|
|
5
|
+
* @pure false
|
|
6
|
+
*
|
|
7
|
+
* @description
|
|
8
|
+
* Is the given date yesterday?
|
|
9
|
+
*
|
|
10
|
+
* > ⚠️ Please note that this function is not present in the FP submodule as
|
|
11
|
+
* > it uses `Date.now()` internally hence impure and can't be safely curried.
|
|
12
|
+
*
|
|
13
|
+
* @param date - the date to check
|
|
14
|
+
* @returns the date is yesterday
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* // If today is 6 October 2014, is 5 October 14:00:00 yesterday?
|
|
18
|
+
* const result = isYesterday(new Date(2014, 9, 5, 14, 0))
|
|
19
|
+
* //=> true
|
|
20
|
+
*/
|
|
21
|
+
export default function isYesterday<DateType extends Date>(dirtyDate: DateType | number): boolean;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name lastDayOfDecade
|
|
3
|
+
* @category Decade Helpers
|
|
4
|
+
* @summary Return the last day of a decade for the given date.
|
|
5
|
+
*
|
|
6
|
+
* @description
|
|
7
|
+
* Return the last day of a decade for the given date.
|
|
8
|
+
*
|
|
9
|
+
* @param date - the original date
|
|
10
|
+
* @returns the last day of a decade
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* // The last day of a decade for 21 December 2012 21:12:00:
|
|
14
|
+
* const result = lastDayOfDecade(new Date(2012, 11, 21, 21, 12, 00))
|
|
15
|
+
* //=> Wed Dec 31 2019 00:00:00
|
|
16
|
+
*/
|
|
17
|
+
export default function lastDayOfDecade<DateType extends Date>(dirtyDate: DateType | number): DateType;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name lastDayOfISOWeek
|
|
3
|
+
* @category ISO Week Helpers
|
|
4
|
+
* @summary Return the last day of an ISO week for the given date.
|
|
5
|
+
*
|
|
6
|
+
* @description
|
|
7
|
+
* Return the last day 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 last day of an ISO week
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* // The last day of an ISO week for 2 September 2014 11:55:00:
|
|
17
|
+
* const result = lastDayOfISOWeek(new Date(2014, 8, 2, 11, 55, 0))
|
|
18
|
+
* //=> Sun Sep 07 2014 00:00:00
|
|
19
|
+
*/
|
|
20
|
+
export default function lastDayOfISOWeek<DateType extends Date>(dirtyDate: DateType | number): DateType;
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name lastDayOfISOWeekYear
|
|
3
|
+
* @category ISO Week-Numbering Year Helpers
|
|
4
|
+
* @summary Return the last day of an ISO week-numbering year for the given date.
|
|
5
|
+
*
|
|
6
|
+
* @description
|
|
7
|
+
* Return the last day of an ISO week-numbering year,
|
|
8
|
+
* which always starts 3 days before the year's first Thursday.
|
|
9
|
+
* The result will be in the local timezone.
|
|
10
|
+
*
|
|
11
|
+
* ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_date
|
|
12
|
+
*
|
|
13
|
+
* @param date - the original date
|
|
14
|
+
* @returns the end of an ISO week-numbering year
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* // The last day of an ISO week-numbering year for 2 July 2005:
|
|
18
|
+
* const result = lastDayOfISOWeekYear(new Date(2005, 6, 2))
|
|
19
|
+
* //=> Sun Jan 01 2006 00:00:00
|
|
20
|
+
*/
|
|
21
|
+
export default function lastDayOfISOWeekYear<DateType extends Date>(dirtyDate: DateType | number): DateType;
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @name lastDayOfMonth
|
|
3
|
+
* @category Month Helpers
|
|
4
|
+
* @summary Return the last day of a month for the given date.
|
|
5
|
+
*
|
|
6
|
+
* @description
|
|
7
|
+
* Return the last day of a month for the given date.
|
|
8
|
+
* The result will be in the local timezone.
|
|
9
|
+
*
|
|
10
|
+
* @param date - the original date
|
|
11
|
+
* @returns the last day of a month
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* // The last day of a month for 2 September 2014 11:55:00:
|
|
15
|
+
* const result = lastDayOfMonth(new Date(2014, 8, 2, 11, 55, 0))
|
|
16
|
+
* //=> Tue Sep 30 2014 00:00:00
|
|
17
|
+
*/
|
|
18
|
+
export default function lastDayOfMonth<DateType extends Date>(dirtyDate: DateType | number): DateType;
|