/fluid-time

Additions for Kotlin's date & time library kotlinx-datetime

Primary LanguageKotlinApache License 2.0Apache-2.0

fluid-time

Maven Central Tests Kotlin kotlinx-datetime #fluid-libraries Slack Channel

Additions for Kotlin's date & time library kotlinx-datetime.

kotlinx-datetime is very early stage and not as actively developed as other official libraries. This library keeps adding missing pieces until the official library catches up.

Installation

build.gradle.kts:

dependencies {
	implementation("io.fluidsonic.time:fluid-time:0.18.0")
}

Additions

  • Clock.toJavaClock(TimeZone) – wraps a Clock into a java.time.Clock (JVM only)
  • Duration(days, hours, minutes, seconds, nanoseconds) – Duration factory function using components
  • DurationSerializer - kotlinx-serialization serializer for Duration
  • LocalDateOrNull(year, month, day) - like LocalDate() but returns null instead of throwing
  • LocalTime.max - 23:59:59.999999999
  • LocalTime.midnight - 00:00
  • LocalTime.min - 00:00
  • Timestamp - alias of Instant for those who prefer that name (Discussion)
  • (LocalDate|LocalDateTime|LocalTime|Timestamp).parseOrNull(String) - like parse() but returns null instead of throwing
  • TimeZone.ofOrNull(String) - like of() but returns null instead of throwing
  • Timestamp.durationSince(Timestamp)/.durationUntil(Timestamp) - get Duration between two timestamps
  • Timestamp.toLocalDate(TimeZone) - shortcut for .toLocalDateTime(timeZone).date
  • Timestamp.toLocalTime(TimeZone) - shortcut for .toLocalDateTime(timeZone).time
  • Timestamp.toJavaDate(): Date - converts a Timestamp to java.util.Date (JVM only)
  • Month.daysIn(year) - number of days in a given month and year
  • Year.isLeap(year) - whether a year is a leap year
  • ManualClock - a Clock implementation suitable for unit testing
  • JVM, JS and Darwin are supported. linuxX64 and mingwX64 are not supported.

Previous library

Before kotlinx-datetime was released this library has provided its own date & time implementations for JVM and Darwin. That work has been discontinued in favor of using the new official library, even if experimental, with additions provided by this reworked library. Bugfix releases will still be provided if needed.

You can still use the last previous library version 0.10.5.

License

Apache 2.0