korlibs-time-core/korlibs.time

Package-level declarations

Types

DateException

class DateException(msg: String) : RuntimeException

An exception for Date operations.

DateTime

@JvmInline

value class DateTime(val unixMillis: Double) : Comparable<DateTime> , Serializable

Represents a Date in UTC (GMT+00) with millisecond precision.

FastDuration

inline class FastDuration(ms: Double) : Comparable<FastDuration>

Analogous to Duration but doesn't allocate on the JS target. Important when used intensively in JS code. For example in KorGE.

TimeProvider

interface TimeProvider

Class to provide time that can be overridden to mock or change its behaviour.

TimeSpan

typealias ~~TimeSpan~~ = Duration

Represents a span of time, with milliseconds precision.

Properties

days

val Double.days: Duration

val Float.days: Duration

val Int.days: Duration

val Long.days: Duration

Duration representing this number as days or 86_400 seconds.

val Duration.days: Double

Returns the total number of days for this Duration (86_400 seconds)

fast

val Duration.fast: FastDuration

fastMicroseconds

val Double.fastMicroseconds: FastDuration

val Float.fastMicroseconds: FastDuration

val Int.fastMicroseconds: FastDuration

val Number.fastMicroseconds: FastDuration

fastMilliseconds

val Double.fastMilliseconds: FastDuration

val Float.fastMilliseconds: FastDuration

val Int.fastMilliseconds: FastDuration

val Number.fastMilliseconds: FastDuration

fastNanoseconds

val Double.fastNanoseconds: FastDuration

val Float.fastNanoseconds: FastDuration

val Int.fastNanoseconds: FastDuration

val Number.fastNanoseconds: FastDuration

fastSeconds

val Double.fastSeconds: FastDuration

val Float.fastSeconds: FastDuration

val Int.fastSeconds: FastDuration

val Number.fastSeconds: FastDuration

hours

val Double.hours: Duration

val Float.hours: Duration

val Int.hours: Duration

val Long.hours: Duration

Duration representing this number as hours or 3_600 seconds.

val Duration.hours: Double

Returns the total number of hours for this Duration (3_600 seconds)

isNil

val FastDuration.isNil: Boolean

val Duration.isNil: Boolean

Return true if Duration.NIL

microseconds

val Double.microseconds: Duration

val Float.microseconds: Duration

val Int.microseconds: Duration

val Long.microseconds: Duration

Duration representing this number as microseconds or 1 / 1_000_000 seconds.

val Duration.microseconds: Double

Returns the total number of microseconds for this Duration (1 / 1_000_000 seconds)

microsecondsInt

val Duration.microsecondsInt: Int

Returns the total number of microseconds for this Duration (1 / 1_000_000 seconds) as Integer

milliseconds

val Double.milliseconds: Duration

val Float.milliseconds: Duration

val Int.milliseconds: Duration

val Long.milliseconds: Duration

Duration representing this number as milliseconds or 1 / 1_000 seconds.

val Duration.milliseconds: Double

millisecondsInt

val Duration.millisecondsInt: Int

Returns the total number of milliseconds as an Int

millisecondsLong

val Duration.millisecondsLong: Long

Returns the total number of milliseconds as a Long

minutes

val Double.minutes: Duration

val Float.minutes: Duration

val Int.minutes: Duration

val Long.minutes: Duration

Duration representing this number as minutes or 60 seconds.

val Duration.minutes: Double

Returns the total number of minutes for this Duration (60 seconds)

nanoseconds

val Double.nanoseconds: Duration

val Float.nanoseconds: Duration

val Int.nanoseconds: Duration

val Long.nanoseconds: Duration

Duration representing this number as nanoseconds or 1 / 1_000_000_000 seconds.

val Duration.nanoseconds: Double

Returns the total number of nanoseconds for this Duration (1 / 1_000_000_000 seconds)

nanosecondsInt

val Duration.nanosecondsInt: Int

Returns the total number of nanoseconds for this Duration (1 / 1_000_000_000 seconds) as Integer

nanosecondsLong

val Duration.nanosecondsLong: Long

Returns the total number of nanoseconds for this Duration (1 / 1_000_000_000 seconds)

NIL

val Duration.Companion.NIL: Duration

seconds

val Double.seconds: Duration

val Float.seconds: Duration

val Int.seconds: Duration

val Long.seconds: Duration

Duration representing this number as seconds.

val Duration.seconds: Double

Returns the total number of seconds for this Duration

slow

val FastDuration.slow: Duration

weeks

val Double.weeks: Duration

val Float.weeks: Duration

val Int.weeks: Duration

val Long.weeks: Duration

Duration representing this number as weeks or 604_800 seconds.

val Duration.weeks: Double

Returns the total number of weeks for this Duration (604_800 seconds)

Functions

blockingSleep

@ExperimentalStdlibApi

fun blockingSleep(time: Duration)

Sleeps the thread during the specified time. Spinlocks on JS

clamp

fun DateTime.clamp(min: DateTime, max: DateTime): DateTime

fun FastDuration.clamp(min: FastDuration, max: FastDuration): FastDuration

fun Duration.clamp(min: Duration, max: Duration): Duration

coalesce

inline fun FastDuration.coalesce(block: () -> FastDuration): FastDuration

inline fun Duration.coalesce(block: () -> Duration): Duration

compareTo

operator fun Duration.compareTo(other: FastDuration): Int

div

operator fun Duration.div(other: FastDuration): Double

inline operator fun Duration.div(scale: Float): Duration

divFloat

infix inline fun Duration.divFloat(other: Duration): Float

fromDays

inline fun Duration.Companion.fromDays(value: Double): Duration

inline fun Duration.Companion.fromDays(value: Number): Duration

fromHours

inline fun Duration.Companion.fromHours(value: Double): Duration

inline fun Duration.Companion.fromHours(value: Number): Duration

fromMicroseconds

inline fun Duration.Companion.fromMicroseconds(value: Double): Duration

inline fun Duration.Companion.fromMicroseconds(value: Number): Duration

fromMilliseconds

inline fun Duration.Companion.fromMilliseconds(value: Double): Duration

inline fun Duration.Companion.fromMilliseconds(value: Number): Duration

fromMinutes

inline fun Duration.Companion.fromMinutes(value: Double): Duration

inline fun Duration.Companion.fromMinutes(value: Number): Duration

fromNanoseconds

inline fun Duration.Companion.fromNanoseconds(value: Double): Duration

inline fun Duration.Companion.fromNanoseconds(value: Number): Duration

fromSeconds

inline fun Duration.Companion.fromSeconds(value: Double): Duration

inline fun Duration.Companion.fromSeconds(value: Number): Duration

fromWeeks

inline fun Duration.Companion.fromWeeks(value: Double): Duration

inline fun Duration.Companion.fromWeeks(value: Number): Duration

max

fun max(a: DateTime, b: DateTime): DateTime

fun max(a: FastDuration, b: FastDuration): FastDuration

fun max(a: Duration, b: Duration): Duration

measure

inline fun TimeProvider.measure(block: () -> Unit): Duration

measureFast

inline fun TimeProvider.measureFast(block: () -> Unit): FastDuration

min

fun min(a: DateTime, b: DateTime): DateTime

fun min(a: FastDuration, b: FastDuration): FastDuration

fun min(a: Duration, b: Duration): Duration

minus

operator fun Duration.minus(other: FastDuration): FastDuration

now

fun Duration.Companion.now(): Duration

plus

operator fun Duration.plus(other: FastDuration): FastDuration

rem

inline operator fun Duration.rem(other: Duration): Duration

roundMilliseconds

fun FastDuration.roundMilliseconds(): FastDuration

fun Duration.roundMilliseconds(): Duration

times

operator fun Duration.times(other: FastDuration): FastDuration

inline operator fun Duration.times(scale: Float): Duration

TimeSpan

inline fun ~~TimeSpan~~(milliseconds: Double): Duration

toDuration

fun FastDuration.toDuration(): Duration

toFastDuration

fun Duration.toFastDuration(): FastDuration

umod

infix inline fun Duration.umod(other: Duration): Duration

unaryPlus

inline operator fun Duration.unaryPlus(): Duration