Package-level declarations

Types

class ComputedTime(val weeks: Int = 0, val days: Int = 0, val hours: Int = 0, val minutes: Int = 0, val seconds: Int = 0, val nanoseconds: Int = 0)

Date

@JvmInline

value class Date(val encoded: Int) : Comparable<Date> , Serializable

Represents a triple of year, month and day.

DateComponents

data class DateComponents(val mode: DateComponents.Mode = Mode.DATE, val years: Int = 0, val months: Int = 0, val days: Int = 0, val hours: Int = 0, val minutes: Int = 0, val seconds: Int = 0, val nanoseconds: Int = 0, val offset: Duration? = null, val sign: Int = +1, val isTime: Boolean = false)

DateComponentsFormat

interface DateComponentsFormat : Serializable

DateException

class DateException(msg: String) : RuntimeException

An exception for Date operations.

DateFormat

interface DateFormat : Serializable

Allows to format and parse instances of Date, DateTime and DateTimeTz

DateTime

@JvmInline

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

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

DateTimeRange

data class DateTimeRange(val from: DateTime, val to: DateTime) : Comparable<DateTime> , Serializable

Represents a right-opened range between two dates.

DateTimeRangeSet

data class DateTimeRangeSet : Serializable

DateTimeSpan

data class DateTimeSpan(val monthSpan: MonthSpan, val duration: Duration) : Comparable<DateTimeSpan> , Serializable

Immutable structure representing a set of a monthSpan and a duration. This structure loses information about which months are included, that makes it impossible to generate a real Duration including months. You can use DateTimeRange.duration to get this information from two real DateTime.

DateTimeSpanFormat

interface DateTimeSpanFormat : Serializable

DateTimeTz

class DateTimeTz : Comparable<DateTimeTz> , Serializable

DateTime with an associated TimezoneOffset

DayOfWeek

enum DayOfWeek : Serializable, Enum<DayOfWeek>

Represents the day of the week. Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.

DayOfWeekWithLocale

data class DayOfWeekWithLocale(val dayOfWeek: DayOfWeek, val locale: KlockLocale) : Comparable<DayOfWeekWithLocale>

FastDuration

@JvmInline

value 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.

FastTimedValue

data class FastTimedValue<T>(val value: T, val duration: FastDuration)

Frequency

@JvmInline

value class Frequency(val hertz: Double) : Comparable<Frequency> , Serializable

IntTimedCache

class IntTimedCache(val ttl: Duration, val timeProvider: TimeProvider = TimeProvider, val gen: () -> Int)

ISO8601

object ISO8601 : DateComponentsFormat

ISODateComponentsFormat

class ISODateComponentsFormat(val format: String, val twoDigitBaseYear: Int = 1900) : DateComponentsFormat

ISODateComponentsFormatEx

open class ISODateComponentsFormatEx(val basicFormat: String?, val extendedFormat: String?) : DateComponentsFormat

ISODateFormat

data class ISODateFormat(val format: ISODateComponentsFormatEx) : DateFormat

ISODateTimeSpanFormat

data class ISODateTimeSpanFormat(val format: ISODateComponentsFormatEx) : DateTimeSpanFormat

ISOTimeFormat

data class ISOTimeFormat(val format: ISODateComponentsFormatEx) : TimeFormat

KlockLocale

abstract class KlockLocale

KlockLocaleContext

data class KlockLocaleContext(val gender: KlockLocaleGender = KlockLocaleGender.Neuter)

KlockLocaleGender

enum KlockLocaleGender : Enum<KlockLocaleGender>

Month

enum Month : Serializable, Enum<Month>

Represents one of the twelve months of the year.

MonthSpan

@JvmInline

value class MonthSpan(val totalMonths: Int) : Comparable<MonthSpan> , Serializable

Represents a number of years and months temporal distance.

NumberOfTimes

@JvmInline

value class NumberOfTimes(val count: Int)

PatternDateComponentsFormat

data class PatternDateComponentsFormat(val format: String, val locale: KlockLocale? = null, val tzNames: TimezoneNames = TimezoneNames.DEFAULT) : DateComponentsFormat

PatternDateFormat

data class PatternDateFormat(val format: PatternDateComponentsFormat) : DateFormat

PatternDateTimeSpanFormat

data class PatternDateTimeSpanFormat(val format: PatternDateComponentsFormat) : DateTimeSpanFormat

PatternTimeFormat

data class PatternTimeFormat(val format: PatternDateComponentsFormat) : TimeFormat

PerformanceCounter

object PerformanceCounter

Class for measuring relative times with as much precision as possible.

Stopwatch

class Stopwatch(val nanosecondProvider: () -> Double = { PerformanceCounter.nanoseconds })

Time

@JvmInline

value class Time(val encoded: Duration) : Comparable<Time> , Serializable

Represents a union of millisecond, second, minute and hour.

TimedCache

class TimedCache<T : Any>(var ttl: Duration, val timeProvider: TimeProvider = TimeProvider, val gen: () -> T)

TimedResult

typealias TimedResult<T> = TimedValue<T>

TimeFormat

interface TimeFormat : Serializable

TimeProvider

interface TimeProvider

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

TimeSampler

class TimeSampler(var timeWindow: Duration = 1.seconds)

Class to count the number of times a sample was added in a timeWindow

TimeSpan

typealias ~~TimeSpan~~ = Duration

Represents a span of time, with milliseconds precision.

Timezone

enum Timezone : Enum<Timezone>

TimezoneNames

data class TimezoneNames(val timeZones: List<Timezone>) : Serializable

TimezoneOffset

@JvmInline

value class TimezoneOffset(val totalMilliseconds: Double) : Comparable<TimezoneOffset> , Serializable

Represents a time zone offset with millisecond precision. Usually minute is enough. Can be used along DateTimeTz to construct non universal, local times.

Year

@JvmInline

value class Year(val year: Int) : Comparable<Year> , Serializable

Represents a Year in a typed way.

YearMonth

@JvmInline

value class YearMonth(internalPackedInfo: Int) : Serializable

Represents a couple of year and month.

Properties

date

val DateTime.date: Date

dateDayEnd

val DateTime.dateDayEnd: DateTime

Returns a DateTime of this day with the hour at 23:59:59.999

dateDayStart

val DateTime.dateDayStart: DateTime

Returns a DateTime of this day with the hour at 00:00:00

dayOfWeek

val DateTime.dayOfWeek: DayOfWeek

The dayOfWeek part

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)

endOfDay

val DateTime.endOfDay: DateTime

endOfHour

val DateTime.endOfHour: DateTime

endOfIsoWeek

val DateTime.endOfIsoWeek: DateTime

endOfMinute

val DateTime.endOfMinute: DateTime

endOfMonth

val DateTime.endOfMonth: DateTime

endOfQuarter

val DateTime.endOfQuarter: DateTime

endOfSecond

val DateTime.endOfSecond: DateTime

endOfWeek

val DateTime.endOfWeek: DateTime

endOfYear

val DateTime.endOfYear: DateTime

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)

val FastDuration.hz: Frequency

val Double.hz: Frequency

val Int.hz: Frequency

val Duration.hz: Frequency

infiniteTimes

val infiniteTimes: NumberOfTimes

isNil

val FastDuration.isNil: Boolean

val Duration.isNil: Boolean

Return true if Duration.NIL

local

val DateTime.local: DateTimeTz

Returns this date with the local offset of this device. Components might change because of the offset.

localOffset

val DateTime.localOffset: TimezoneOffset

The local offset for this date for the timezone of the device

localUnadjusted

val DateTime.localUnadjusted: DateTimeTz

Returns a new local date that will match these components.

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)

month

val DateTime.month: Month

The Month part

months

val MonthSpan.months: Int

Months part of this MonthSpan as integer

val Int.months: MonthSpan

Creates a MonthSpan representing these months.

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

offset

val Duration.offset: TimezoneOffset

A Duration as a TimezoneOffset.

result

val <T> TimedValue<T>.~~result~~: T

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

startOfDay

val DateTime.startOfDay: DateTime

startOfHour

val DateTime.startOfHour: DateTime

startOfIsoWeek

val DateTime.startOfIsoWeek: DateTime

startOfMinute

val DateTime.startOfMinute: DateTime

startOfMonth

val DateTime.startOfMonth: DateTime

startOfQuarter

val DateTime.startOfQuarter: DateTime

startOfSecond

val DateTime.startOfSecond: DateTime

startOfWeek

val DateTime.startOfWeek: DateTime

startOfYear

val DateTime.startOfYear: DateTime

time

val DateTime.time: Time

val <T> TimedValue<T>.~~time~~: Duration

times

val Int.times: NumberOfTimes

timesPerSecond

val FastDuration.timesPerSecond: Frequency

val Double.timesPerSecond: Frequency

val Int.timesPerSecond: Frequency

val Duration.timesPerSecond: Frequency

totalYears

val MonthSpan.totalYears: Double

Total years of this MonthSpan as double (might contain decimals)

utc

val DateTime.utc: DateTimeTz

Returns this date with a 0 offset. Components are equal.

weekOfYear0

val Date.weekOfYear0: Int

val DateTime.weekOfYear0: Int

val DateTimeTz.weekOfYear0: Int

weekOfYear1

val Date.weekOfYear1: Int

val DateTime.weekOfYear1: Int

val DateTimeTz.weekOfYear1: Int

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)

year

val DateTime.year: Year

The Year part

yearMonth

val DateTime.yearMonth: YearMonth

Represents a couple of Year and Month that has leap information and thus allows to get the number of days of that month

years

val MonthSpan.years: Int

Years part of this MonthSpan as integer

val Int.years: MonthSpan

Creates a MonthSpan representing these years.

Functions

add

fun DateTime.add(dateSpan: MonthSpan, duration: Duration): DateTime

Constructs a new DateTime after adding dateSpan and duration

fun DateTime.add(deltaMonths: Int, deltaMilliseconds: Double): DateTime

Constructs a new DateTime after adding deltaMonths and deltaMilliseconds

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

convertRange

fun DateTime.convertRange(srcMin: DateTime, srcMax: DateTime, dstMin: DateTime, dstMax: DateTime): DateTime

fun Duration.convertRange(srcMin: Duration, srcMax: Duration, dstMin: Duration, dstMax: Duration): Duration

copyDayOfMonth

fun DateTime.copyDayOfMonth(year: Year = this.year, month: Month = this.month, dayOfMonth: Int = this.dayOfMonth, hours: Int = this.hours, minutes: Int = this.minutes, seconds: Int = this.seconds, milliseconds: Int = this.milliseconds): DateTime

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

endOfDayOfWeek

fun DateTime.endOfDayOfWeek(day: DayOfWeek): DateTime

fastMeasureTime

inline fun fastMeasureTime(block: () -> Unit): FastDuration

Executes a callback and measure the time it takes to complete.

inline fun <T> fastMeasureTime(callback: () -> T, handleTime: (FastDuration) -> Unit): T

fastMeasureTimedValue

inline fun <T> fastMeasureTimedValue(callback: () -> T): FastTimedValue<T>

first

fun Year.first(dayOfWeek: DayOfWeek): DateTime

firstDate

fun Year.firstDate(dayOfWeek: DayOfWeek): Date

format

fun DateFormat.format(dd: Date): String

fun DateFormat.format(dd: DateTime): String

fun DateFormat.format(date: Double): String

fun DateFormat.format(date: Long): String

fun DateTimeSpanFormat.format(dd: MonthSpan): String

fun DateTimeSpanFormat.format(dd: Duration): String

fun TimeFormat.format(time: Time): String

fun TimeFormat.format(time: Double): String

fun TimeFormat.format(time: Long): String

fun DateTime.format(format: String, locale: KlockLocale): String

fun DateTimeTz.format(format: String, locale: KlockLocale): String

fun DateTime.format(format: DateFormat): String

fun DateTime.format(format: String): String

Converts this date to String using format for representing it

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

fromString

fun DateTime.Companion.fromString(str: String): DateTimeTz

Constructs a new DateTime by parsing the str using standard date formats.

fromWeeks

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

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

inThisWeek

fun Date.inThisWeek(dayOfWeek: DayOfWeekWithLocale): Date

fun Date.inThisWeek(dayOfWeek: DayOfWeek, locale: KlockLocale = KlockLocale.default): Date

invoke

operator fun DateTime.Companion.invoke(date: Date, time: Time = Time(0.milliseconds)): DateTime

operator fun DateTime.Companion.invoke(year: Year, month: Month, day: Int, hour: Int = 0, minute: Int = 0, second: Int = 0, milliseconds: Int = 0): DateTime

operator fun DateTime.Companion.invoke(year: Int, month: Month, day: Int, hour: Int = 0, minute: Int = 0, second: Int = 0, milliseconds: Int = 0): DateTime

Constructs a new DateTime from date and time information.

max