Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fluidsonic/fluid-time
Additions for Kotlin's date & time library kotlinx-datetime
https://github.com/fluidsonic/fluid-time
date datetime kotlin kotlin-multiplatform kotlinx-datetime kotlinx-serialization time
Last synced: 1 day ago
JSON representation
Additions for Kotlin's date & time library kotlinx-datetime
- Host: GitHub
- URL: https://github.com/fluidsonic/fluid-time
- Owner: fluidsonic
- License: apache-2.0
- Created: 2019-05-21T14:29:22.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-06-24T03:27:30.000Z (over 1 year ago)
- Last Synced: 2024-10-01T17:05:38.794Z (about 1 month ago)
- Topics: date, datetime, kotlin, kotlin-multiplatform, kotlinx-datetime, kotlinx-serialization, time
- Language: Kotlin
- Homepage:
- Size: 470 KB
- Stars: 44
- Watchers: 3
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-kotlin-multiplatform - fluid-time - Kotlin multiplatform date & time library (Libraries / Utility)
README
fluid-time
==========
[](https://search.maven.org/artifact/io.fluidsonic.time/fluid-time)
[](https://github.com/fluidsonic/fluid-time/actions?workflow=Tests)
[-blue.svg)](https://github.com/JetBrains/kotlin/releases/v1.8.22)
[](https://github.com/Kotlin/kotlinx-datetime/releases/tag/v0.4.0)
[](https://kotlinlang.slack.com/messages/C7UDFSVT2/)
Additions for Kotlin's date & time library [`kotlinx-datetime`](https://github.com/Kotlin/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`:
```kotlin
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](https://kotlinlang.slack.com/archives/C01923PC6A0/p1597788327006500))
- `(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](https://github.com/fluidsonic/fluid-time/releases/tag/0.10.5).
License
-------
Apache 2.0