Enhances date and time manipulation with extensions and helper functions, bridging gaps with Java's `java.time` API. Features include date arithmetic, parsing, formatting, and locale support.
A Kotlin Multiplatform library that provides kotlinx-datetime extensions and helper functions.
If you've recently switched from java.time APIs to kotlinx-datetime, you've probably noticed that it's missing a lot of functionality that has to be implemented manually. This library comes to close the gap by providing most of java.time's functionalities but in Kotlin!
Version 1.4.0 now supports the new kotlin.time and kotlinx.datetime 0.7.1 changes
implementation("com.raedghazal:kotlinx_datetime_ext:1.4.0")
If you're using it in commonMain and want to access it from androidApp, then use api(...) instead to expose it. More about the difference between implementation and api.
No Initialization is needed, except if you're targeting JS or WasmJS, call Locale.initPlatformLocales(...) in your JS module to setup all the locales you're supporting, default is English Locale only
@JsModule("date-fns/locale/pl")
external object DateFnsLocalePl
@JsModule("date-fns/locale/it")
external object DateFnsLocaleIt
Locale.initPlatformLocales(DateFnsLocalePl, DateFnsLocaleIt) // support "pl" and "it" locales
@JsModule("date-fns/locale")
external object DateFnsLocales
Locale.initPlatformLocales(DateFnsLocales) // support all locales
*This function is only available in the JS module, and it will not be accessible in commonMain .
Add or subtract date or time to a LocalDateTime
using operator functions + and - with duration values:
val localDateTime = LocalDateTime(2023, 1, 7, 21, 0)
val afterFiveDays = localDateTime + 5.days
val beforeThreeHours = localDateTime - 3.hours
Or using the DateTimeUnit overload:
val localDateTime = LocalDateTime(2023, 1, 7, 21, 0)
val afterFiveDays = localDateTime.plus(5, DateTimeUnit.DAY)
val beforeThreeHours = localDateTime.minus(3, DateTimeUnit.HOUR)
val localDateTime = LocalDateTime(2023, 1, 1, 1, 1)
val formatter = LocalDateTimeFormatter.ofPattern("dd/MM/yyyy - HH:mm", Locale.en())
print(formatter.format(localDateTime)) //"01/01/2023 - 01:01"
There are overloads for all date/time objects:
fun format(localDateTime: LocalDateTime): String
fun format(localTime: LocalTime): String
fun format(localDate: LocalDate): String
val formatter = LocalDateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss", Locale.en())
val localDateTime = formatter.parseToLocalDateTime("2023-01-01 01:01:00") // LocalDateTime(2023, 1, 1, 1, 1)
You can also parse to any date/time object
fun parseToLocalDateTime(str: String): LocalDateTime
fun parseToLocalDate(str: String): LocalDate
fun parseToLocalTime(str: String): LocalTime
Transform a LocalDate to a LocalDateTime, you can use atStartOfDay() or atEndOfDay(), similar to java.time:
val localDate = LocalDate(2023, 12, 17).atStartOfDay() //LocalDateTime(2023, 12, 17, 0, 0)
val localDate = LocalDate(2023, 12, 17).atEndOfDay() // LocalDateTime(2023, 12, 17, 23, 59, 59, 999999999)
Get the current date/time:
LocalDateTime.now()
LocalDate.now()
LocalTime.now()
Get minimum/maximum time:
LocalTime.MIN
LocalTime.MAX
Get the Duration between two LocalDateTime objects using the durationUntil infix function:
firstLocalDateTime durationUntil secondLocalDateTime
More examples can be found in the unit tests directory.
Thank you for using the library, contributions are welcomed!
Support me by a starring the repo and follow me on social media ❤️
Surfaced from shared tags and platforms — no rankings paid for.