Module

JS.Temporal.PlainDateTime

Package: purescript-js-temporal
Repository: pete-murphy/purescript-js-temporal

A date and time (year, month, day, hour, minute, etc.) without time zone. Use for wall-clock times that are not tied to a specific instant (e.g. "Jan 15, 2024 at 3pm"). Combine with a time zone to get a ZonedDateTime.

See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Temporal/PlainDateTime

#new Source

new :: forall provided rest. Union provided rest PlainDateTimeComponents => Record provided -> Effect PlainDateTime

Creates a PlainDateTime from component fields. Corresponds to Temporal.PlainDateTime().

#from Source

from :: forall provided. ConvertOptionsWithDefaults ToOverflowOptions (Record OverflowOptions) (Record provided) (Record OverflowOptions) => Record provided -> String -> Effect PlainDateTime

Parses a date-time string (e.g. "2024-01-15T15:30:00"). Options: overflow.

#from_ Source

from_ :: String -> Effect PlainDateTime

Same as from with default options.

#year Source

year :: PlainDateTime -> Int

#month Source

month :: PlainDateTime -> Int

#day Source

day :: PlainDateTime -> Int

#monthCode Source

monthCode :: PlainDateTime -> String

#dayOfWeek Source

dayOfWeek :: PlainDateTime -> Int

#dayOfYear Source

dayOfYear :: PlainDateTime -> Int

#weekOfYear Source

weekOfYear :: PlainDateTime -> Maybe Int

#yearOfWeek Source

yearOfWeek :: PlainDateTime -> Maybe Int

#daysInMonth Source

daysInMonth :: PlainDateTime -> Int

#daysInYear Source

daysInYear :: PlainDateTime -> Int

#daysInWeek Source

daysInWeek :: PlainDateTime -> Int

#monthsInYear Source

monthsInYear :: PlainDateTime -> Int

#inLeapYear Source

inLeapYear :: PlainDateTime -> Boolean

#calendarId Source

calendarId :: PlainDateTime -> String

#era Source

era :: PlainDateTime -> Maybe String

#eraYear Source

eraYear :: PlainDateTime -> Maybe Int

#hour Source

hour :: PlainDateTime -> Int

#minute Source

minute :: PlainDateTime -> Int

#second Source

second :: PlainDateTime -> Int

#millisecond Source

millisecond :: PlainDateTime -> Int

#microsecond Source

microsecond :: PlainDateTime -> Int

#nanosecond Source

nanosecond :: PlainDateTime -> Int

#add Source

add :: forall provided. ConvertOptionsWithDefaults ToOverflowOptions (Record OverflowOptions) (Record provided) (Record OverflowOptions) => Record provided -> Duration -> PlainDateTime -> Effect PlainDateTime

Adds a duration. Supports calendar durations. Options: overflow.

#add_ Source

add_ :: Duration -> PlainDateTime -> Effect PlainDateTime

Same as add with default options.

#subtract Source

subtract :: forall provided. ConvertOptionsWithDefaults ToOverflowOptions (Record OverflowOptions) (Record provided) (Record OverflowOptions) => Record provided -> Duration -> PlainDateTime -> Effect PlainDateTime

Subtracts a duration. Options: overflow.

#subtract_ Source

subtract_ :: Duration -> PlainDateTime -> Effect PlainDateTime

Same as subtract with default options.

#with Source

with :: forall optsProvided fields rest. Union fields rest WithFields => ConvertOptionsWithDefaults ToOverflowOptions (Record OverflowOptions) (Record optsProvided) (Record OverflowOptions) => Record optsProvided -> Record fields -> PlainDateTime -> Effect PlainDateTime

#with_ Source

with_ :: forall fields rest. Union fields rest WithFields => Record fields -> PlainDateTime -> Effect PlainDateTime

#withPlainTime Source

withPlainTime :: PlainTime -> PlainDateTime -> Effect PlainDateTime

#withCalendar Source

withCalendar :: String -> PlainDateTime -> Effect PlainDateTime

#until Source

until :: forall provided. ConvertOptionsWithDefaults ToDifferenceOptions (Record DifferenceOptions) (Record provided) (Record DifferenceOptions) => Record provided -> PlainDateTime -> PlainDateTime -> Effect Duration

#until_ Source

until_ :: PlainDateTime -> PlainDateTime -> Effect Duration

#since Source

since :: forall provided. ConvertOptionsWithDefaults ToDifferenceOptions (Record DifferenceOptions) (Record provided) (Record DifferenceOptions) => Record provided -> PlainDateTime -> PlainDateTime -> Effect Duration

#since_ Source

since_ :: PlainDateTime -> PlainDateTime -> Effect Duration

#round Source

round :: forall provided. ConvertOptionsWithDefaults ToRoundOptions (Record RoundOptions) (Record provided) (Record RoundOptions) => Record provided -> PlainDateTime -> Effect PlainDateTime

#toString Source

toString :: forall provided. ConvertOptionsWithDefaults ToToStringOptions (Record ToStringOptions) (Record provided) (Record ToStringOptions) => Record provided -> PlainDateTime -> String

Serializes to ISO 8601 format. Options: fractionalSecondDigits, smallestUnit, roundingMode, calendarName.

#toString_ Source

toString_ :: PlainDateTime -> String

Default ISO 8601 serialization (no options). Prefer over toString {}.

#fromDateTime Source

fromDateTime :: DateTime -> Effect PlainDateTime

Converts a purescript-datetime DateTime to a PlainDateTime. See docs/purescript-datetime-interop.md.

#toDateTime Source

toDateTime :: PlainDateTime -> DateTime

Converts a PlainDateTime to a purescript-datetime DateTime. See docs/purescript-datetime-interop.md.

#toPlainDate Source

toPlainDate :: PlainDateTime -> PlainDate

Extracts the date component.

#toPlainTime Source

toPlainTime :: PlainDateTime -> PlainTime

Extracts the time component.

#toZonedDateTime Source

toZonedDateTime :: String -> PlainDateTime -> Effect ZonedDateTime

Interprets this date-time as occurring in the given time zone.

#ToOverflowOptions Source

data ToOverflowOptions

Instances

ConvertOption ToOverflowOptions "overflow" Overflow String
ConvertOption ToOverflowOptions "overflow" String String

#ToDifferenceOptions Source

data ToDifferenceOptions

Instances

ConvertOption ToDifferenceOptions "largestUnit" TemporalUnit String
ConvertOption ToDifferenceOptions "largestUnit" String String
ConvertOption ToDifferenceOptions "smallestUnit" TemporalUnit String
ConvertOption ToDifferenceOptions "smallestUnit" String String
ConvertOption ToDifferenceOptions "roundingIncrement" Int Int
ConvertOption ToDifferenceOptions "roundingMode" RoundingMode String
ConvertOption ToDifferenceOptions "roundingMode" String String

#ToRoundOptions Source

data ToRoundOptions

Instances

ConvertOption ToRoundOptions "smallestUnit" TemporalUnit String
ConvertOption ToRoundOptions "smallestUnit" String String
ConvertOption ToRoundOptions "roundingIncrement" Int Int
ConvertOption ToRoundOptions "roundingMode" RoundingMode String
ConvertOption ToRoundOptions "roundingMode" String String

#ToToStringOptions Source

data ToToStringOptions

Instances

ConvertOption ToToStringOptions "calendarName" CalendarName String
ConvertOption ToToStringOptions "calendarName" String String
ConvertOption ToToStringOptions "fractionalSecondDigits" Int Foreign
ConvertOption ToToStringOptions "fractionalSecondDigits" String Foreign
ConvertOption ToToStringOptions "smallestUnit" TemporalUnit String
ConvertOption ToToStringOptions "smallestUnit" String String
ConvertOption ToToStringOptions "roundingMode" RoundingMode String
ConvertOption ToToStringOptions "roundingMode" String String

Re-exports from JS.Temporal.PlainDateTime.Internal

#PlainDateTime Source

data PlainDateTime