Module

Data.Date

Package
purescript-datetime
Repository
purescript/purescript-datetime

#DateSource

data Date

A date value in the Gregorian calendar.

Instances

#canonicalDateSource

canonicalDate :: Year -> Month -> Day -> Date

Constructs a date from year, month, and day components. The resulting date components may not be identical to the input values, as the date will be canonicalised according to the Gregorian calendar. For example, date values for the invalid date 2016-02-31 will be corrected to 2016-03-02.

#exactDateSource

exactDate :: Year -> Month -> Day -> Maybe Date

Constructs a date from year, month, and day components. The result will be Nothing if the provided values result in an invalid date.

#yearSource

year :: Date -> Year

The year component of a date value.

#monthSource

month :: Date -> Month

The month component of a date value.

#daySource

day :: Date -> Day

The day component of a date value.

#weekdaySource

weekday :: Date -> Weekday

The weekday for a date value.

#diffSource

diff :: forall d. Duration d => Date -> Date -> d

Calculates the difference between two dates, returning the result as a duration.

Re-exports from Data.Date.Component

#YearSource

newtype Year

A year component for a date.

The constructor is private as the Year type is bounded to the range -271820 to 275759, inclusive. The toEnum function can be used to safely acquire a year value from an integer.

Instances

#WeekdaySource

data Weekday

A type representing the days of the week in the Gregorian calendar.

Constructors

Instances

#DaySource

newtype Day

A day component for a date.

The constructor is private as the Day type is bounded to the range 1 to 31, inclusive. The toEnum function can be used to safely acquire a day value from an integer.

Instances