Module

Data.DateTime

Package
purescript-datetime
Repository
purescript/purescript-datetime

#DateTimeSource

data DateTime

A date/time value in the Gregorian calendar/UTC time zone.

Constructors

Instances

#adjustSource

adjust :: forall d. Duration d => d -> DateTime -> Maybe DateTime

Adjusts a date/time value with a duration offset. Nothing is returned if the resulting date would be outside of the range of valid dates.

#diffSource

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

Calculates the difference between two date/time values, returning the result as a duration.

Re-exports from Data.Date

#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

#DateSource

data Date

A date value in the Gregorian calendar.

Instances

#yearSource

year :: Date -> Year

The year component of a date value.

#weekdaySource

weekday :: Date -> Weekday

The weekday for a date value.

#monthSource

month :: Date -> Month

The month component of a date value.

#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.

#daySource

day :: Date -> Day

The day component of a date value.

#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.

Re-exports from Data.Time

#SecondSource

newtype Second

An second component for a time value.

The constructor is private as values for the type are restricted to the range 0 to 59, inclusive. The toEnum function can be used to safely acquire an Second value from an integer. Correspondingly, a Second can be lowered to a plain integer with the fromEnum function.

Instances

#MinuteSource

newtype Minute

An minute component for a time value.

The constructor is private as values for the type are restricted to the range 0 to 59, inclusive. The toEnum function can be used to safely acquire an Minute value from an integer. Correspondingly, a Minute can be lowered to a plain integer with the fromEnum function.

Instances

#MillisecondSource

newtype Millisecond

An millisecond component for a time value.

The constructor is private as values for the type are restricted to the range 0 to 999, inclusive. The toEnum function can be used to safely acquire an Millisecond value from an integer. Correspondingly, a Millisecond can be lowered to a plain integer with the fromEnum function.

Instances

#HourSource

newtype Hour

An hour component for a time value.

The constructor is private as values for the type are restricted to the range 0 to 23, inclusive. The toEnum function can be used to safely acquire an Hour value from an integer. Correspondingly, an Hour can be lowered to a plain integer with the fromEnum function.

Instances

#setSecondSource

setSecond :: Second -> Time -> Time

Alters the second component of a time value.

#setMinuteSource

setMinute :: Minute -> Time -> Time

Alters the minute component of a time value.

#setMillisecondSource

setMillisecond :: Millisecond -> Time -> Time

Alters the millisecond component of a time value.

#setHourSource

setHour :: Hour -> Time -> Time

Alters the hour component of a time value.

#secondSource

second :: Time -> Second

The second component of a time value.

#minuteSource

minute :: Time -> Minute

The minute component of a time value.

#millisecondSource

millisecond :: Time -> Millisecond

The millisecond component of a time value.

#hourSource

hour :: Time -> Hour

The hour component of a time value.