korlibs-time/korlibs.time/DateComponents

DateComponents

data class DateComponents(val mode: DateComponents.Mode = Mode.DATE, val years: Int = 0, val months: Int = 0, val days: Int = 0, val hours: Int = 0, val minutes: Int = 0, val seconds: Int = 0, val nanoseconds: Int = 0, val offset: Duration? = null, val sign: Int = +1, val isTime: Boolean = false)

Constructors

constructor(mode: DateComponents.Mode = Mode.DATE, years: Int = 0, months: Int = 0, days: Int = 0, hours: Int = 0, minutes: Int = 0, seconds: Int = 0, nanoseconds: Int = 0, offset: Duration? = null, sign: Int = +1, isTime: Boolean = false)

Types

enum Mode : Enum<DateComponents.Mode>

Properties

val clampHours: Boolean

When parsing time without dates, hours shouldn't be clamped

val dayOfWeek: DayOfWeek

val dayOfYear: Int

For dates, days is the day in the month []1..31]

val isTime: Boolean

val milliseconds: Int

millisecondsDouble

val millisecondsDouble: Double

val minutes: Int

val mode: DateComponents.Mode

How properties must be interpreted

val months: Int

For dates, months is 1..12

val nanoseconds: Int

val offset: Duration?

val seconds: Int

val timezoneOffset: TimezoneOffset

For dates, years is the full year. For example 1970 or 2024

Functions

fun DateComponents.toDateTimeSpan(): DateTimeSpan

fun DateComponents.toDateTimeTz(doThrow: Boolean = false, doAdjust: Boolean = true): DateTimeTz?

fun DateComponents.toDuration(): Duration