This package has been deprecated

Author message:

this package has been deprecated, please use @mobily/rescript-date instead

@mobily/re-date

ReDate

📆 A collection of useful helpers for handling dates in Reason with the same modern API as the well-known `date-fns`.

Installation

yarn add @mobily/re-date

or with npm

npm install @mobily/re-date --save

Then add @mobily/re-date to bs-dependencies in your bsconfig.json:

{
  "bs-dependencies": [
    "@mobily/re-date"
  ]
}

Api Reference

If you are familiar with date-fns, then you already know how to use ReDate.

The list of helpers:

Common

• isEqual
• isBefore
• isAfter
• isFuture
• isPast
• compareAsc
• compareDesc
• maxOfArray
• maxOfList
• minOfArray
• minOfList
• isValid
• closestToArray
• closestToList

Interval

• isWithinInterval
• areIntervalsOverlapping
• getOverlappingDaysInIntervals
• eachDayOfIntervalArray
• eachDayOfIntervalList

Second

• addSeconds
• subSeconds
• differenceInSeconds
• startOfSecond
• endOfSecond
• isSameSecond

Minute

• addMinutes
• subMinutes
• differenceInMinutes
• startOfMinute
• endOfMinute
• isSameMinute
• roundToNearestMinute

Hour

• addHours
• subHours
• differenceInHours
• startOfHour
• endOfHour
• isSameHour

Day

• addDays
• addBusinessDays
• subDays
• startOfDay
• endOfDay
• differenceInCalendarDays
• differenceInDays
• differenceInBusinessDays
• getDayOfYear
• isSameDay
• isToday
• isTomorrow
• isYesterday

Week

• addWeeks
• subWeeks
• differenceInWeeks
• differenceInCalendarWeeks
• startOfWeek
• endOfWeek
• isSameWeek
• lastDayOfWeek
• getWeekOfMonth
• getWeeksInMonth
• getWeek

Week Numbering

• getWeekYear
• startOfWeekYear

Weekday

• isSunday
• isMonday
• isTuesday
• isWednesday
• isThursday
• isFriday
• isSaturday
• isWeekend

Month

• addMonths
• subMonths
• differenceInCalendarMonths
• differenceInMonths
• startOfMonth
• endOfMonth
• isFirstDayOfMonth
• isLastDayOfMonth
• isSameMonth
• lastDayOfMonth
• getDaysInMonth

Year

• addYears
• subYears
• startOfYear
• endOfYear
• isSameYear
• isLeapYear
• lastMonthOfYear
• lastDayOfYear
• getDaysInYear
• differenceInCalendarYears
• differenceInYears

ISO Week

• endOfISOWeek
• getISOWeek
• isSameISOWeek
• isThisISOWeek
• lastDayOfISOWeek
• setISOWeek
• startOfISOWeek
• differenceInCalendarISOWeeks

ISO Year

• getISOWeekYear
• startOfISOWeekYear

Status

Check the current status here.

Contributors

Marcin Dziewulski 💻 📖

Radek Kozieł 💻

mikaello 💻 📖

This project follows the all-contributors specification. Contributions of any kind welcome!

License

The MIT License.

See LICENSE