Module

JS.Temporal.ZonedDateTime

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

A date and time with time zone, representing a unique instant plus a time zone and calendar. Use when you need an absolute point in time with human-readable components in a specific zone.

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

#new Source

new :: BigInt -> String -> Effect ZonedDateTime

Creates a ZonedDateTime from epoch nanoseconds and a time zone ID.

#from Source

from :: forall provided. ConvertOptionsWithDefaults ToFromOptions (Record FromOptions) (Record provided) (Record FromOptions) => Record provided -> String -> Effect ZonedDateTime

Parses an ISO 8601 string with time zone (e.g. "2024-01-15T12:00-05:00[America/New_York]"). Options: overflow, disambiguation, offset.

#from_ Source

from_ :: String -> Effect ZonedDateTime

Same as from with default options.

#year Source

year :: ZonedDateTime -> Int

#month Source

month :: ZonedDateTime -> Int

#day Source

day :: ZonedDateTime -> Int

#monthCode Source

monthCode :: ZonedDateTime -> String

#hour Source

hour :: ZonedDateTime -> Int

#minute Source

minute :: ZonedDateTime -> Int

#second Source

second :: ZonedDateTime -> Int

#millisecond Source

millisecond :: ZonedDateTime -> Int

#microsecond Source

microsecond :: ZonedDateTime -> Int

#nanosecond Source

nanosecond :: ZonedDateTime -> Int

#dayOfWeek Source

dayOfWeek :: ZonedDateTime -> Int

#dayOfYear Source

dayOfYear :: ZonedDateTime -> Int

#weekOfYear Source

weekOfYear :: ZonedDateTime -> Maybe Int

#yearOfWeek Source

yearOfWeek :: ZonedDateTime -> Maybe Int

#daysInMonth Source

daysInMonth :: ZonedDateTime -> Int

#daysInYear Source

daysInYear :: ZonedDateTime -> Int

#daysInWeek Source

daysInWeek :: ZonedDateTime -> Int

#monthsInYear Source

monthsInYear :: ZonedDateTime -> Int

#inLeapYear Source

inLeapYear :: ZonedDateTime -> Boolean

#calendarId Source

calendarId :: ZonedDateTime -> String

#era Source

era :: ZonedDateTime -> Maybe String

#eraYear Source

eraYear :: ZonedDateTime -> Maybe Int

#timeZoneId Source

timeZoneId :: ZonedDateTime -> String

#offset Source

offset :: ZonedDateTime -> String

#offsetNanoseconds Source

offsetNanoseconds :: ZonedDateTime -> Int

#hoursInDay Source

hoursInDay :: ZonedDateTime -> Int

#epochMilliseconds Source

epochMilliseconds :: ZonedDateTime -> Number

#epochNanoseconds Source

epochNanoseconds :: ZonedDateTime -> BigInt

#add Source

add :: forall provided. ConvertOptionsWithDefaults ToArithmeticOptions (Record ArithmeticOptions) (Record provided) (Record ArithmeticOptions) => Record provided -> Duration -> ZonedDateTime -> Effect ZonedDateTime

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

#add_ Source

add_ :: Duration -> ZonedDateTime -> Effect ZonedDateTime

Same as add with default options.

#subtract Source

subtract :: forall provided. ConvertOptionsWithDefaults ToArithmeticOptions (Record ArithmeticOptions) (Record provided) (Record ArithmeticOptions) => Record provided -> Duration -> ZonedDateTime -> Effect ZonedDateTime

#subtract_ Source

subtract_ :: Duration -> ZonedDateTime -> Effect ZonedDateTime

#with Source

with :: forall optsProvided fields rest. Union fields rest WithFields => ConvertOptionsWithDefaults ToFromOptions (Record FromOptions) (Record optsProvided) (Record FromOptions) => Record optsProvided -> Record fields -> ZonedDateTime -> Effect ZonedDateTime

#with_ Source

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

#withTimeZone Source

withTimeZone :: String -> ZonedDateTime -> Effect ZonedDateTime

#withCalendar Source

withCalendar :: String -> ZonedDateTime -> Effect ZonedDateTime

#withPlainTime Source

withPlainTime :: PlainTime -> ZonedDateTime -> Effect ZonedDateTime

#withPlainDate Source

withPlainDate :: PlainDate -> ZonedDateTime -> Effect ZonedDateTime

#until Source

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

#until_ Source

until_ :: ZonedDateTime -> ZonedDateTime -> Effect Duration

#since Source

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

#since_ Source

since_ :: ZonedDateTime -> ZonedDateTime -> Effect Duration

#round Source

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

#startOfDay Source

startOfDay :: ZonedDateTime -> Effect ZonedDateTime

Returns the start of the calendar day in this time zone.

#getTimeZoneTransition Source

getTimeZoneTransition :: String -> ZonedDateTime -> Maybe ZonedDateTime

Gets the next or previous time zone transition. Direction: "next" or "previous".

#toInstant Source

toInstant :: ZonedDateTime -> Instant

Extracts the absolute instant (no time zone).

#toPlainDateTime Source

toPlainDateTime :: ZonedDateTime -> PlainDateTime

Extracts date and time in the zoned wall-clock view (drops time zone).

#toPlainDate Source

toPlainDate :: ZonedDateTime -> PlainDate

#toPlainTime Source

toPlainTime :: ZonedDateTime -> PlainTime

#toPlainYearMonth Source

toPlainYearMonth :: ZonedDateTime -> PlainYearMonth

#toPlainMonthDay Source

toPlainMonthDay :: ZonedDateTime -> PlainMonthDay

#toString Source

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