DateTime

value class DateTime(val unixMillis: Double) : Comparable<DateTime> , Serializable

Represents a Date in UTC (GMT+00) with millisecond precision.

It is internally represented as an inlined double, thus doesn't allocate in any target including JS. It can represent without loss dates between (-(2 ** 52) and (2 ** 52)):

Thu Aug 10 -140744 07:15:45 GMT-0014 (Central European Summer Time)
Wed May 23 144683 18:29:30 GMT+0200 (Central European Summer Time)

Constructors

DateTime

constructor(unixMillis: Double)

Types

Companion

object Companion

Properties

date

val date: Date

dateDayEnd

val dateDayEnd: DateTime

Returns a DateTime of this day with the hour at 23:59:59.999

dateDayStart

val dateDayStart: DateTime

Returns a DateTime of this day with the hour at 00:00:00

dayOfMonth

val dayOfMonth: Int

The dayOfMonth part

dayOfWeek

val dayOfWeek: DayOfWeek

The dayOfWeek part

dayOfWeekInt

val dayOfWeekInt: Int

The dayOfWeek part as Int

dayOfYear

val dayOfYear: Int

The dayOfYear part

endOfDay

val endOfDay: DateTime

endOfHour

val endOfHour: DateTime

endOfIsoWeek

val endOfIsoWeek: DateTime

endOfMinute

val endOfMinute: DateTime

endOfMonth

val endOfMonth: DateTime

endOfQuarter

val endOfQuarter: DateTime

endOfSecond

val endOfSecond: DateTime

endOfWeek

val endOfWeek: DateTime

endOfYear

val endOfYear: DateTime

hours

val hours: Int

The hours part

local

val local: DateTimeTz

Returns this date with the local offset of this device. Components might change because of the offset.

localOffset

val localOffset: TimezoneOffset

The local offset for this date for the timezone of the device

localUnadjusted

val localUnadjusted: DateTimeTz

Returns a new local date that will match these components.

milliseconds

val milliseconds: Int

The milliseconds part

minutes

val minutes: Int

The minutes part

month

val month: Month

The Month part

month0

val month0: Int

The Month part as Int where January is represented as 0

month1

val month1: Int

The Month part as Int where January is represented as 1

quarter

val quarter: Int

Returns the quarter 1, 2, 3 or 4

seconds

val seconds: Int

The seconds part

startOfDay

val startOfDay: DateTime

startOfHour

val startOfHour: DateTime

startOfIsoWeek

val startOfIsoWeek: DateTime

startOfMinute

val startOfMinute: DateTime

startOfMonth

val startOfMonth: DateTime

startOfQuarter

val startOfQuarter: DateTime

startOfSecond

val startOfSecond: DateTime

startOfWeek

val startOfWeek: DateTime

startOfYear

val startOfYear: DateTime

time

val time: Time

unixMillis

val unixMillis: Double

Number of milliseconds since UNIX EPOCH

unixMillisDouble

val unixMillisDouble: Double

Number of milliseconds since UNIX EPOCH as Double

unixMillisLong

val unixMillisLong: Long

Number of milliseconds since UNIX EPOCH as Long

utc

val utc: DateTimeTz

Returns this date with a 0 offset. Components are equal.

weekOfYear0

val DateTime.weekOfYear0: Int

weekOfYear1

val DateTime.weekOfYear1: Int

year

val year: Year

The Year part

yearInt

val yearInt: Int

The Year part as Int

yearMonth

val yearMonth: YearMonth

Represents a couple of Year and Month that has leap information and thus allows to get the number of days of that month

yearOneMillis

val yearOneMillis: Double

Number of milliseconds since the 00:00:00 UTC, Monday, 1 January 1

Functions

add

fun add(dateSpan: MonthSpan, timeSpan: TimeSpan): DateTime

Constructs a new DateTime after adding dateSpan and timeSpan

fun add(deltaMonths: Int, deltaMilliseconds: Double): DateTime

Constructs a new DateTime after adding deltaMonths and deltaMilliseconds

cfAbsoluteTime

fun DateTime.cfAbsoluteTime(): Double

clamp

fun DateTime.clamp(min: DateTime, max: DateTime): DateTime

compareTo

open operator override fun compareTo(other: DateTime): Int

convertRange

fun DateTime.convertRange(srcMin: DateTime, srcMax: DateTime, dstMin: DateTime, dstMax: DateTime): DateTime

copyDayOfMonth

fun copyDayOfMonth(year: Year = this.year, month: Month = this.month, dayOfMonth: Int = this.dayOfMonth, hours: Int = this.hours, minutes: Int = this.minutes, seconds: Int = this.seconds, milliseconds: Int = this.milliseconds): DateTime

endOfDayOfWeek