commonMain.krono.Duration.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of krono-api-jvm Show documentation
An multiplatform interoperable datetime library
The newest version!
@file:JsExport
@file:Suppress("NON_EXPORTABLE_TYPE")

package krono

import krono.utils.convert
import krono.utils.equals
import kotlinx.JsExport
import kotlin.math.roundToInt

data class Duration(val value: Double, val unit: DurationUnit) : Comparable {
    val inNanoSeconds by lazy { convert(value, unit, DurationUnit.NanoSeconds) }
    val inMicroSeconds by lazy { convert(value, unit, DurationUnit.MicroSeconds) }
    val inMilliSeconds by lazy { convert(value, unit, DurationUnit.MilliSeconds) }
    val inSeconds by lazy { convert(value, unit, DurationUnit.Seconds) }
    val inMinutes by lazy { convert(value, unit, DurationUnit.Minutes) }
    val inHours by lazy { convert(value, unit, DurationUnit.Hours) }
    val inWeeks by lazy { convert(value, unit, DurationUnit.Weeks) }
    val inDays by lazy { convert(value, unit, DurationUnit.Days) }
    val inMonths by lazy { convert(value, unit, DurationUnit.Months) }
    val inYears by lazy { convert(value, unit, DurationUnit.Years) }

    operator fun plus(other: Duration): Duration {
        val converted = convert(other.value, from = other.unit, into = unit)
        return Duration(value + converted, unit)
    }

    operator fun minus(other: Duration): Duration {
        val converted = convert(other.value, from = other.unit, into = unit)
        return Duration(value - converted, unit)
    }

    override fun compareTo(other: Duration): Int {
        if (unit == other.unit) return value.compareTo(other.value)
        val converted = convert(other.value, from = other.unit, into = unit)
        return value.compareTo(converted)
    }

    override fun equals(other: Any?): Boolean {
        if (other !is Duration) return false
        val converted = convert(other.value, from = other.unit, into = unit)
        return equals(value, converted, 0.001)
    }

    fun toRelativeString(): String {
        var dur: Duration = this
        for (entry in DurationUnit.values().reversed()) {
            val converted = convert(value, unit, entry)
            dur = Duration(converted, entry)
            if (converted >= 1) break
        }
        return buildString {
            val rounded = dur.value.roundToInt()
            if (rounded == 1) {
                append("a")
            } else {
                append(rounded)
            }
            append(" ")
            var siUnit = dur.unit.name.lowercase()
            if (rounded == 1) {
                siUnit = siUnit.removeSuffix("s")
            }
            append(siUnit)
        }
    }
}