https://github.com/chrynan/time
A Kotlin multi-platform time library.
https://github.com/chrynan/time
duration kotlin kotlin-library kotlin-multi-platform kotlin-multiplatform library time timestamp timezone
Last synced: 5 months ago
JSON representation
A Kotlin multi-platform time library.
- Host: GitHub
- URL: https://github.com/chrynan/time
- Owner: chRyNaN
- License: apache-2.0
- Created: 2020-02-09T19:12:35.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-11-19T05:42:05.000Z (about 3 years ago)
- Last Synced: 2023-02-27T06:41:52.762Z (almost 3 years ago)
- Topics: duration, kotlin, kotlin-library, kotlin-multi-platform, kotlin-multiplatform, library, time, timestamp, timezone
- Language: Kotlin
- Homepage:
- Size: 596 KB
- Stars: 13
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# time
A Kotlin multi-platform time library.
This library expands on the Kotlin [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/)
and [kotlinx.datetime](https://github.com/Kotlin/kotlinx-datetime) library.
An early look into the development of this library is discussed in [this article](https://chrynan.codes/its-about-time/)
which was featured in Android Weekly issue [#401](https://androidweekly.net/issues/issue-401).
Note that this library has changed focus since [this article](https://chrynan.codes/its-about-time/) was written,
because the [kotlinx.datetime](https://github.com/Kotlin/kotlinx-datetime) library has been introduced since then.
## Using the Library
This library expands on the kotlinx datetime library by providing additional components and utilities, including:
* [UtcMillisSinceEpoch](docs/time-core/time-core/com.chrynan.time/-utc-millis-since-epoch/index.md)
* [DateTimeStamp](docs/time-core/time-core/com.chrynan.time/-date-time-stamp/index.md)
* [DateStamp](docs/time-core/time-core/com.chrynan.time/-date-stamp/index.md)
* [TimeProvider](docs/time-core/time-core/com.chrynan.time/-time-provider/index.md)
* [DateTimeFormatter](docs/time-core/time-core/com.chrynan.time/-date-time-formatter/index.md)
### TimeProvider
A `TimeProvider` extends from `kotlin.time.TimeSource` and `kotlinx.datetime.Clock`. This may provide additional
functionality in the future. A `TimeProvider` can be obtained via the `TimeProvider` function:
```kotlin
val timeProvider = TimeProvider()
val duration = timeProvider.elapsedSystemTime
```
### TimeFormatter
The `TimeFormatter` interface provides a way to format time values:
```kotlin
val formatter = TimeFormatter("EEEE, MMM d, yyyy")
formatter.invoke(instant, timeZone)
```
### Coroutines
The library provides common coroutines and Flow time based utilities, such as the following:
```kotlin
intervalFlow(period = 30.seconds)
timerFlow(duration = 2.minutes)
scheduleFlow(dateTimeString)
myFlow.timeout(30.seconds)
myFlow.timedValue()
poll(period = 10.seconds) { myFlow }
```
Refer to the `FlowUtils` Kotlin file in the `time-core` package for more information on the functions.
## Building
The library is provided through [repsy](https://repsy.io). Refer to
the [releases page](https://github.com/chRyNaN/time/releases) for the latest version.
### Repository
```groovy
repositories {
maven { url = uri("https://repo.repsy.io/mvn/chrynan/public") }
}
```
### Dependencies
```groovy
implementation("com.chrynan.time:time-core:$VERSION")
```
## Documentation
Refer to the [docs](docs) folder for documentation and more information about the library.
## License
```
Copyright 2021 chRyNaN
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```