A time zone, provides the conversion between Instant and LocalDateTime values using a collection of rules specifying which LocalDateTime value corresponds to each Instant.

expect open class TimeZone

A time zone, provides the conversion between Instant and LocalDateTime values using a collection of rules specifying which LocalDateTime value corresponds to each Instant.

actual open class TimeZone

A time zone, provides the conversion between Instant and LocalDateTime values using a collection of rules specifying which LocalDateTime value corresponds to each Instant.

UtcOffset

@Serializable(with = UtcOffsetSerializer::class)

actual class UtcOffset

An offset from UTC.

@Serializable(with = UtcOffsetSerializer::class)

expect class UtcOffset

An offset from UTC.

@Serializable(with = UtcOffsetSerializer::class)

actual class UtcOffset(zoneOffset: ZoneOffset) : Serializable

An offset from UTC.

YearMonth

@Serializable(with = YearMonthSerializer::class)

actual class YearMonth(val year: Int, month: Int) : Comparable<YearMonth>

The year-month part of LocalDate, without a day-of-month.

@Serializable(with = YearMonthSerializer::class)

expect class YearMonth(year: Int, month: Int) : Comparable<YearMonth>

The year-month part of LocalDate, without a day-of-month.

@Serializable(with = YearMonthSerializer::class)

actual class YearMonth(year: Int, month: Int) : Comparable<YearMonth> , Serializable

The year-month part of LocalDate, without a day-of-month.

YearMonthProgression

open class YearMonthProgression : Collection<YearMonth>

A progression of values of type YearMonth.

YearMonthRange

class YearMonthRange(start: YearMonth, endInclusive: YearMonth) : YearMonthProgression, ClosedRange<YearMonth> , OpenEndRange<YearMonth>

A range of values of type YearMonth.

Properties

isoDayNumber

val DayOfWeek.isoDayNumber: Int

The ISO 8601 number of the given day of the week. Monday is 1, Sunday is 7.

number

val Month.number: Int

The number of the Month. January is 1, December is 12.

yearMonth

val LocalDate.yearMonth: YearMonth

Returns the year-month part of this date.

Functions

asClock

fun TimeSource.asClock(origin: Instant): Clock

Creates a Clock that uses the time mark at the moment of creation to determine how far the current moment is from the origin.

asTimeZone

fun UtcOffset.asTimeZone(): FixedOffsetTimeZone

Returns the fixed-offset time zone with the given UTC offset.

atDate

fun LocalTime.atDate(date: LocalDate): LocalDateTime

Combines this time's components with the specified LocalDate components into a LocalDateTime value.

fun LocalTime.atDate(year: Int, month: Int, day: Int): LocalDateTime

fun LocalTime.atDate(year: Int, month: Month, day: Int): LocalDateTime

Combines this time's components with the specified date components into a LocalDateTime value.

atStartOfDayIn

actual fun LocalDate.atStartOfDayIn(timeZone: TimeZone, youShallNotPass: OverloadMarker): Instant

Returns an instant that corresponds to the start of this date in the specified timeZone.

expect fun LocalDate.atStartOfDayIn(timeZone: TimeZone, youShallNotPass: OverloadMarker = OverloadMarker.INSTANCE): Instant

Returns an instant that corresponds to the start of this date in the specified timeZone.

actual fun LocalDate.atStartOfDayIn(timeZone: TimeZone, youShallNotPass: OverloadMarker): Instant

Returns an instant that corresponds to the start of this date in the specified timeZone.

atTime

fun LocalDate.atTime(time: LocalTime): LocalDateTime

Combines this date's components with the specified LocalTime components into a LocalDateTime value.

fun LocalDate.atTime(hour: Int, minute: Int, second: Int = 0, nanosecond: Int = 0): LocalDateTime

Combines this date's components with the specified time components into a LocalDateTime value.

DateTimePeriod

fun DateTimePeriod(years: Int = 0, months: Int = 0, days: Int = 0, hours: Int = 0, minutes: Int = 0, seconds: Int = 0, nanoseconds: Long = 0): DateTimePeriod

Constructs a new DateTimePeriod. If all the time components are zero, returns a DatePeriod.

DayOfWeek

fun DayOfWeek(isoDayNumber: Int): DayOfWeek

Returns the DayOfWeek instance for the given ISO 8601 weekday number. Monday is 1, and Sunday is 7.

daysUntil

actual fun LocalDate.daysUntil(other: LocalDate): Int

Returns the number of whole days between two dates.

expect fun LocalDate.daysUntil(other: LocalDate): Int

Returns the number of whole days between two dates.

fun Instant.daysUntil(other: Instant, timeZone: TimeZone): Int

Returns the number of whole days between two instants in the specified timeZone.

actual fun LocalDate.daysUntil(other: LocalDate): Int

Returns the number of whole days between two dates.

downTo

infix fun LocalDate.downTo(that: LocalDate): LocalDateProgression

Creates a LocalDateProgression from this down to that, inclusive.

infix fun YearMonth.downTo(that: YearMonth): YearMonthProgression

Creates a YearMonthProgression from this down to that, inclusive.

first

fun LocalDateProgression.first(): LocalDate

Returns the first LocalDate of the LocalDateProgression.

fun YearMonthProgression.first(): YearMonth

Returns the first YearMonth of the YearMonthProgression.

firstOrNull

fun LocalDateProgression.firstOrNull(): LocalDate?

Returns the first LocalDate of the LocalDateProgression, or null if the progression is empty.

fun YearMonthProgression.firstOrNull(): YearMonth?

Returns the first YearMonth of the YearMonthProgression, or null if the progression is empty.

format

fun LocalDate.format(format: DateTimeFormat<LocalDate>): String

fun LocalDateTime.format(format: DateTimeFormat<LocalDateTime>): String

fun LocalTime.format(format: DateTimeFormat<LocalTime>): String

fun UtcOffset.format(format: DateTimeFormat<UtcOffset>): String

fun YearMonth.format(format: DateTimeFormat<YearMonth>): String

Formats this value using the given format. Equivalent to calling DateTimeFormat.format on format with this.

fun Instant.format(format: DateTimeFormat<DateTimeComponents>, offset: UtcOffset = UtcOffset.ZERO): String

Formats this value using the given format using the given offset.

last

fun LocalDateProgression.last(): LocalDate

Returns the last LocalDate of the LocalDateProgression.

fun YearMonthProgression.last(): YearMonth

Returns the last YearMonth of the YearMonthProgression.

lastOrNull

fun LocalDateProgression.lastOrNull(): LocalDate?

Returns the last LocalDate of the LocalDateProgression, or null if the progression is empty.

fun YearMonthProgression.lastOrNull(): YearMonth?

Returns the last YearMonth of the YearMonthProgression, or null if the progression is empty.

minus

operator fun LocalDate.minus(period: DatePeriod): LocalDate

Returns a date that results from subtracting components of DatePeriod from this date. The components are subtracted in the order from the largest units to the smallest: first years and months, then days.

operator fun LocalDate.minus(other: LocalDate): DatePeriod

Returns a DatePeriod representing the difference between other and this dates.

fun Instant.minus(value: Int, unit: DateTimeUnit.TimeBased): Instant

fun Instant.minus(value: Long, unit: DateTimeUnit.TimeBased): Instant

Returns an instant that is the result of subtracting the value number of the specified unit from this instant.

fun Instant.minus(other: Instant, unit: DateTimeUnit.TimeBased): Long

Returns the whole number of the specified time units between other and this instants.

fun Instant.minus(other: Instant, timeZone: TimeZone): DateTimePeriod

Returns a DateTimePeriod representing the difference between other and this instants.

fun Instant.minus(period: DateTimePeriod, timeZone: TimeZone): Instant

Returns an instant that is the result of subtracting components of DateTimePeriod from this instant. The components are subtracted in the order from the largest units to the smallest, i.e., from years to nanoseconds.

fun LocalDate.minus(value: Int, unit: DateTimeUnit.DateBased): LocalDate

fun LocalDate.minus(value: Long, unit: DateTimeUnit.DateBased): LocalDate

Returns a LocalDate that results from subtracting the value number of the specified unit from this date.

fun YearMonth.minus(value: Int, unit: DateTimeUnit.MonthBased): YearMonth

fun YearMonth.minus(value: Long, unit: DateTimeUnit.MonthBased): YearMonth

Returns a YearMonth that results from subtracting the value number of the specified unit from this year-month.

fun Instant.minus(value: Int, unit: DateTimeUnit, timeZone: TimeZone): Instant

fun Instant.minus(value: Long, unit: DateTimeUnit, timeZone: TimeZone): Instant

Returns an instant that is the result of subtracting the value number of the specified unit from this instant in the specified timeZone.

fun Instant.minus(other: Instant, unit: DateTimeUnit, timeZone: TimeZone): Long

Returns the whole number of the specified date or time units between other and this instants in the specified timeZone.

minusMonth

fun YearMonth.minusMonth(): YearMonth

The YearMonth one month earlier.

minusYear

fun YearMonth.minusYear(): YearMonth

The YearMonth 12 months earlier.

Month

fun Month(number: Int): Month

Returns the Month instance for the given month number. January is 1, December is 12.

monthsUntil

actual fun LocalDate.monthsUntil(other: LocalDate): Int

Returns the number of whole months between two dates.

expect fun LocalDate.monthsUntil(other: LocalDate): Int

Returns the number of whole months between two dates.

fun YearMonth.monthsUntil(other: YearMonth): Int

Returns the number of whole months between two year-months.

fun Instant.monthsUntil(other: Instant, timeZone: TimeZone): Int

Returns the number of whole months between two instants in the specified timeZone.

actual fun LocalDate.monthsUntil(other: LocalDate): Int

Returns the number of whole months between two dates.

fun LocalDate.next(dayOfWeek: DayOfWeek): LocalDate

Returns a LocalDate that has the given dayOfWeek later than this date.

nextOrSame

fun LocalDate.nextOrSame(dayOfWeek: DayOfWeek): LocalDate

Returns a LocalDate that has the given dayOfWeek not earlier than this date.

offsetAt

actual fun TimeZone.offsetAt(instant: Instant): UtcOffset

Finds the offset from UTC this time zone has at the specified instant of physical time.

expect fun TimeZone.offsetAt(instant: Instant): UtcOffset

Finds the offset from UTC this time zone has at the specified instant of physical time.

actual fun TimeZone.offsetAt(instant: Instant): UtcOffset

Finds the offset from UTC this time zone has at the specified instant of physical time.

offsetIn

fun Instant.offsetIn(timeZone: TimeZone): UtcOffset

Finds the offset from UTC the specified timeZone has at this instant of physical time.

onDay

fun YearMonth.onDay(day: Int): LocalDate

Combines this year-month with the specified day-of-month into a LocalDate value.

parse

fun Instant.Companion.parse(input: CharSequence, format: DateTimeFormat<DateTimeComponents>): Instant

A shortcut for calling DateTimeFormat.parse, followed by DateTimeComponents.toInstantUsingOffset.

parseOrNull

actual fun LocalDate.Companion.parseOrNull(input: CharSequence, format: DateTimeFormat<LocalDate>): LocalDate?

actual fun LocalDateTime.Companion.parseOrNull(input: CharSequence, format: DateTimeFormat<LocalDateTime>): LocalDateTime?

actual fun LocalTime.Companion.parseOrNull(input: CharSequence, format: DateTimeFormat<LocalTime>): LocalTime?

actual fun UtcOffset.Companion.parseOrNull(input: CharSequence, format: DateTimeFormat<UtcOffset>): UtcOffset?

actual fun YearMonth.Companion.parseOrNull(input: CharSequence, format: DateTimeFormat<YearMonth>): YearMonth?

A shortcut for calling DateTimeFormat.parseOrNull.

fun Instant.Companion.parseOrNull(input: CharSequence, format: DateTimeFormat<DateTimeComponents> = DateTimeComponents.Formats.ISO_DATE_TIME_OFFSET): Instant?

A shortcut for calling DateTimeFormat.parseOrNull, followed by DateTimeComponents.toInstantUsingOffset, returning null if any of the two operations fail.

expect fun LocalDate.Companion.parseOrNull(input: CharSequence, format: DateTimeFormat<LocalDate> = getIsoDateFormat()): LocalDate?

expect fun LocalDateTime.Companion.parseOrNull(input: CharSequence, format: DateTimeFormat<LocalDateTime> = getIsoDateTimeFormat()): LocalDateTime?

expect fun LocalTime.Companion.parseOrNull(input: CharSequence, format: DateTimeFormat<LocalTime> = getIsoTimeFormat()): LocalTime?

expect fun UtcOffset.Companion.parseOrNull(input: CharSequence, format: DateTimeFormat<UtcOffset> = getIsoUtcOffsetFormat()): UtcOffset?

expect fun YearMonth.Companion.parseOrNull(input: CharSequence, format: DateTimeFormat<YearMonth> = YearMonth.Formats.ISO): YearMonth?

A shortcut for calling DateTimeFormat.parseOrNull.

actual fun LocalDate.Companion.parseOrNull(input: CharSequence, format: DateTimeFormat<LocalDate>): LocalDate?

actual fun LocalDateTime.Companion.parseOrNull(input: CharSequence, format: DateTimeFormat<LocalDateTime>): LocalDateTime?

actual fun LocalTime.Companion.parseOrNull(input: CharSequence, format: DateTimeFormat<LocalTime>): LocalTime?

actual fun UtcOffset.Companion.parseOrNull(input: CharSequence, format: DateTimeFormat<UtcOffset>): UtcOffset?

actual fun YearMonth.Companion.parseOrNull(input: CharSequence, format: DateTimeFormat<YearMonth>): YearMonth?

A shortcut for calling DateTimeFormat.parseOrNull.

periodUntil

actual fun LocalDate.periodUntil(other: LocalDate): DatePeriod

Returns a DatePeriod representing the difference between this and other dates.

expect fun LocalDate.periodUntil(other: LocalDate): DatePeriod

Returns a DatePeriod representing the difference between this and other dates.

fun Instant.periodUntil(other: Instant, timeZone: TimeZone): DateTimePeriod

Returns a DateTimePeriod representing the difference between this and other instants.

actual fun LocalDate.periodUntil(other: LocalDate): DatePeriod

Returns a DatePeriod representing the difference between this and other dates.

plus

actual operator fun LocalDate.plus(period: DatePeriod): LocalDate

Returns a date that results from adding components of DatePeriod to this date. The components are added in the order from the largest units to the smallest: first years and months, then days.

actual fun LocalDate.plus(value: Long, unit: DateTimeUnit.DateBased): LocalDate

Returns a LocalDate that results from adding the value number of the specified unit to this date.

expect operator fun LocalDate.plus(period: DatePeriod): LocalDate

Returns a date that results from adding components of DatePeriod to this date. The components are added in the order from the largest units to the smallest: first years and months, then days.

fun Instant.plus(value: Int, unit: DateTimeUnit.TimeBased): Instant

fun Instant.plus(value: Long, unit: DateTimeUnit.TimeBased): Instant

Returns an instant that is the result of adding the value number of the specified unit to this instant.

fun Instant.plus(period: DateTimePeriod, timeZone: TimeZone): Instant

Returns an instant that is the result of adding components of DateTimePeriod to this instant. The components are added in the order from the largest units to the smallest, i.e., from years to nanoseconds.

fun LocalDate.plus(value: Int, unit: DateTimeUnit.DateBased): LocalDate

expect fun LocalDate.plus(value: Long, unit: DateTimeUnit.DateBased): LocalDate

Returns a LocalDate that results from adding the value number of the specified unit to this date.

fun YearMonth.plus(value: Int, unit: DateTimeUnit.MonthBased): YearMonth

fun YearMonth.plus(value: Long, unit: DateTimeUnit.MonthBased): YearMonth

Returns a YearMonth that results from adding the value number of the specified unit to this year-month.

fun Instant.plus(value: Int, unit: DateTimeUnit, timeZone: TimeZone): Instant

fun Instant.plus(value: Long, unit: DateTimeUnit, timeZone: TimeZone): Instant

Returns an instant that is the result of adding the value number of the specified unit to this instant in the specified timeZone.

actual operator fun LocalDate.plus(period: DatePeriod): LocalDate

Returns a date that results from adding components of DatePeriod to this date. The components are added in the order from the largest units to the smallest: first years and months, then days.

actual fun LocalDate.plus(value: Long, unit: DateTimeUnit.DateBased): LocalDate

Returns a LocalDate that results from adding the value number of the specified unit to this date.

plusMonth

fun YearMonth.plusMonth(): YearMonth

The YearMonth one month later.

plusYear

fun YearMonth.plusYear(): YearMonth

The YearMonth 12 months later.

fun LocalDate.previous(dayOfWeek: DayOfWeek): LocalDate

Returns a LocalDate that has the given dayOfWeek earlier than this date.

previousOrSame

fun LocalDate.previousOrSame(dayOfWeek: DayOfWeek): LocalDate

Returns a LocalDate that has the given dayOfWeek not later than this date.

random

fun LocalDateProgression.random(random: Random = Random): LocalDate

Returns a random LocalDate within the bounds of the LocalDateProgression.

fun YearMonthProgression.random(random: Random = Random): YearMonth

Returns a random YearMonth within the bounds of the YearMonthProgression.

randomOrNull

fun LocalDateProgression.randomOrNull(random: Random = Random): LocalDate?

Returns a random LocalDate within the bounds of the LocalDateProgression or null if the progression is empty.

fun YearMonthProgression.randomOrNull(random: Random = Random): YearMonth?

Returns a random YearMonth within the bounds of the YearMonthProgression or null if the progression is empty.

reversed

fun LocalDateProgression.reversed(): LocalDateProgression

Returns a reversed LocalDateProgression, i.e. one that goes from last to first. The sign of the step is switched, in order to reverse the direction of the progression.

fun YearMonthProgression.reversed(): YearMonthProgression

Returns a reversed YearMonthProgression, i.e. one that goes from last to first. The sign of the step is switched, in order to reverse the direction of the progression.

step

fun LocalDateProgression.step(value: Int, unit: DateTimeUnit.DayBased): LocalDateProgression

fun LocalDateProgression.step(value: Long, unit: DateTimeUnit.DayBased): LocalDateProgression

Returns a LocalDateProgression with the same start and end, but a changed step value.

fun YearMonthProgression.step(value: Int, unit: DateTimeUnit.MonthBased): YearMonthProgression

fun YearMonthProgression.step(value: Long, unit: DateTimeUnit.MonthBased): YearMonthProgression

Returns a YearMonthProgression with the same start and end, but a changed step value.

toDateTimePeriod

fun Duration.toDateTimePeriod(): DateTimePeriod

Constructs a DateTimePeriod from a Duration.

todayIn

fun Clock.todayIn(timeZone: TimeZone): LocalDate

Returns the current date at the given time zone, according to this Clock.

toDeprecatedClock

fun Clock.toDeprecatedClock(): Clock

Creates a kotlinx.datetime.Clock delegating to the version of Clock from the standard library.

toDeprecatedInstant

fun Instant.toDeprecatedInstant(): Instant

Creates a kotlinx.datetime.Instant identical to the version of Instant from the standard library.

toInstant

actual fun LocalDateTime.toInstant(timeZone: TimeZone, youShallNotPass: OverloadMarker): Instant

Returns an instant that corresponds to this civil datetime value in the specified timeZone.

actual fun LocalDateTime.toInstant(offset: UtcOffset, youShallNotPass: OverloadMarker): Instant

Returns an instant that corresponds to this civil datetime value that happens at the specified UTC offset.

expect fun LocalDateTime.toInstant(timeZone: TimeZone, youShallNotPass: OverloadMarker = OverloadMarker.INSTANCE): Instant

Returns an instant that corresponds to this civil datetime value in the specified timeZone.

expect fun LocalDateTime.toInstant(offset: UtcOffset, youShallNotPass: OverloadMarker = OverloadMarker.INSTANCE): Instant

Returns an instant that corresponds to this civil datetime value that happens at the specified UTC offset.

actual fun LocalDateTime.toInstant(timeZone: TimeZone, youShallNotPass: OverloadMarker): Instant

Returns an instant that corresponds to this civil datetime value in the specified timeZone.

actual fun LocalDateTime.toInstant(offset: UtcOffset, youShallNotPass: OverloadMarker): Instant

Returns an instant that corresponds to this civil datetime value that happens at the specified UTC offset.

toJavaDayOfWeek

fun DayOfWeek.toJavaDayOfWeek(): DayOfWeek

Converts this kotlinx.datetime.DayOfWeek value to a java.time.DayOfWeek value.

toJavaLocalDate

fun LocalDate.toJavaLocalDate(): LocalDate

Converts this kotlinx.datetime.LocalDate value to a java.time.LocalDate value.

fun LocalIsoWeekDate.toJavaLocalDate(): LocalDate

toJavaLocalDateTime

fun LocalDateTime.toJavaLocalDateTime(): LocalDateTime

Converts this kotlinx.datetime.LocalDateTime value to a java.time.LocalDateTime value.

toJavaLocalTime

fun LocalTime.toJavaLocalTime(): LocalTime

Converts this kotlinx.datetime.LocalDateTime value to a java.time.LocalTime value.

toJavaMonth

fun Month.toJavaMonth(): Month

Converts this kotlinx.datetime.Month value to a java.time.Month value.

toJavaPeriod

fun DatePeriod.toJavaPeriod(): Period

Converts this kotlinx.datetime.DatePeriod value to a java.time.Period value.

toJavaYearMonth

fun YearMonth.toJavaYearMonth(): YearMonth

toJavaZoneId

fun TimeZone.toJavaZoneId(): ZoneId

Converts this kotlinx.datetime.TimeZone value to a java.time.ZoneId value.

toJavaZoneOffset

fun FixedOffsetTimeZone.toJavaZoneOffset(): ZoneOffset

Converts this kotlinx.datetime.FixedOffsetTimeZone value to a java.time.ZoneOffset value.

fun UtcOffset.toJavaZoneOffset(): ZoneOffset

Converts this kotlinx.datetime.UtcOffset value to a java.time.ZoneOffset value.

toJSDate

fun Instant.toJSDate(): Date

Converts the Instant to an instance of JS Date.

toKotlinDatePeriod

fun Period.toKotlinDatePeriod(): DatePeriod

Converts this java.time.Period value to a kotlinx.datetime.DatePeriod value.

toKotlinDayOfWeek

fun DayOfWeek.toKotlinDayOfWeek(): DayOfWeek

Converts this java.time.DayOfWeek value to a kotlinx.datetime.DayOfWeek value.

toKotlinFixedOffsetTimeZone

fun ZoneOffset.toKotlinFixedOffsetTimeZone(): FixedOffsetTimeZone

Converts this java.time.ZoneOffset value to a kotlinx.datetime.FixedOffsetTimeZone value.

toKotlinInstant

fun NSDate.toKotlinInstant(youShallNotPass: OverloadMarker = OverloadMarker.INSTANCE): Instant

Converts the NSDate to the corresponding Instant.

fun Date.toKotlinInstant(): Instant

Converts the JS Date to the corresponding Instant.

toKotlinLocalDate

fun LocalDate.toKotlinLocalDate(): LocalDate

Converts this java.time.LocalDate value to a kotlinx.datetime.LocalDate value.

toKotlinLocalDateTime

fun LocalDateTime.toKotlinLocalDateTime(): LocalDateTime

Converts this java.time.LocalDateTime value to a kotlinx.datetime.LocalDateTime value.

toKotlinLocalIsoWeekDate

fun LocalDate.toKotlinLocalIsoWeekDate(): LocalIsoWeekDate

toKotlinLocalTime

fun LocalTime.toKotlinLocalTime(): LocalTime

Converts this java.time.LocalTime value to a kotlinx.datetime.LocalTime value.

toKotlinMonth

fun Month.toKotlinMonth(): Month

Converts this java.time.Month value to a kotlinx.datetime.Month value.

toKotlinTimeZone

fun NSTimeZone.toKotlinTimeZone(): TimeZone

Converts the NSTimeZone to the corresponding TimeZone.

fun ZoneId.toKotlinTimeZone(): TimeZone

Converts this java.time.ZoneId value to a kotlinx.datetime.TimeZone value.

toKotlinUtcOffset

fun ZoneOffset.toKotlinUtcOffset(): UtcOffset

Converts this java.time.ZoneOffset value to a kotlinx.datetime.UtcOffset value.

toKotlinYearMonth

fun YearMonth.toKotlinYearMonth(): YearMonth

Converts this java.time.YearMonth value to a kotlinx.datetime.YearMonth value.

toLocalDateTime

actual fun Instant.toLocalDateTime(timeZone: TimeZone): LocalDateTime

Returns a civil datetime value that this instant has in the specified timeZone.

expect fun Instant.toLocalDateTime(timeZone: TimeZone): LocalDateTime

Returns a civil datetime value that this instant has in the specified timeZone.

actual fun Instant.toLocalDateTime(timeZone: TimeZone): LocalDateTime

Returns a civil datetime value that this instant has in the specified timeZone.

toLocalIsoWeekDate

fun LocalDate.toLocalIsoWeekDate(): LocalIsoWeekDate

Converts this LocalDate to a LocalIsoWeekDate.

toNSDate

fun Instant.toNSDate(): NSDate

Converts the Instant to an instance of NSDate.

toNSDateComponents

fun LocalDate.toNSDateComponents(): NSDateComponents

Converts the given LocalDate to NSDateComponents.

fun LocalDateTime.toNSDateComponents(): NSDateComponents

Converts the given LocalDateTime to NSDateComponents.

fun YearMonth.toNSDateComponents(): NSDateComponents

Converts the given YearMonth to NSDateComponents.

toNSTimeZone

fun TimeZone.toNSTimeZone(): NSTimeZone

Converts the TimeZone to NSTimeZone.

toStdlibClock

fun Clock.toStdlibClock(): Clock

Creates a kotlin.time.Clock (the standard library version of Clock) delegating to this.

toStdlibInstant

fun Instant.toStdlibInstant(): Instant

Creates a kotlin.time.Instant (the standard library version of Instant) identical to this.

until

actual fun LocalDate.until(other: LocalDate, unit: DateTimeUnit.DateBased): Long

Returns the whole number of the specified date units between this and other dates.

fun Instant.until(other: Instant, unit: DateTimeUnit.TimeBased): Long

Returns the whole number of the specified time units between this and other instants.

expect fun LocalDate.until(other: LocalDate, unit: DateTimeUnit.DateBased): Long

Returns the whole number of the specified date units between this and other dates.

fun YearMonth.until(other: YearMonth, unit: DateTimeUnit.MonthBased): Long

Returns the whole number of the specified month-based units between this and other year-months.

fun Instant.until(other: Instant, unit: DateTimeUnit, timeZone: TimeZone): Long

Returns the whole number of the specified date or time units between this and other instants in the specified timeZone.

actual fun LocalDate.until(other: LocalDate, unit: DateTimeUnit.DateBased): Long

Returns the whole number of the specified date units between this and other dates.

UtcOffset

actual fun UtcOffset(hours: Int? = null, minutes: Int? = null, seconds: Int? = null): UtcOffset

Constructs a UtcOffset from hours, minutes, and seconds components.

expect fun UtcOffset(hours: Int? = null, minutes: Int? = null, seconds: Int? = null): UtcOffset

Constructs a UtcOffset from hours, minutes, and seconds components.

actual fun UtcOffset(hours: Int? = null, minutes: Int? = null, seconds: Int? = null): UtcOffset

Constructs a UtcOffset from hours, minutes, and seconds components.

yearsUntil

actual fun LocalDate.yearsUntil(other: LocalDate): Int

Returns the number of whole years between two dates.

expect fun LocalDate.yearsUntil(other: LocalDate): Int

Returns the number of whole years between two dates.

fun YearMonth.yearsUntil(other: YearMonth): Int

Returns the number of whole years between two year-months.

fun Instant.yearsUntil(other: Instant, timeZone: TimeZone): Int

Returns the number of whole years between two instants in the specified timeZone.

actual fun LocalDate.yearsUntil(other: LocalDate): Int

Returns the number of whole years between two dates.

Thanks for your feedback!

Was this page helpful?