date-time/com.splendo.kaluga.datetime

Package-level declarations

Types

BaseDateFormatter

interface BaseDateFormatter

Interface for parsing and formatting a KalugaDate from/to a String.

abstract class BaseTimeZone

A TimeZone represents a time zone. Accounts for Daylight Savings

DateFormatStyle

enum DateFormatStyle : Enum<DateFormatStyle>

Style used for formatting a KalugaDate to and from a String

DefaultKalugaDate

actual class DefaultKalugaDate : KalugaDate

Default implementation of KalugaDate

actual class DefaultKalugaDate : KalugaDate

Default implementation of KalugaDate

expect class DefaultKalugaDate : KalugaDate

Default implementation of KalugaDate

actual class DefaultKalugaDate : KalugaDate

Default implementation of KalugaDate

actual class DefaultKalugaDate : KalugaDate

Default implementation of KalugaDate

actual class DefaultKalugaDate : KalugaDate

Default implementation of KalugaDate backed by the luxon JS library. Mirrors java.util.Calendar semantics:

abstract class KalugaDate : Comparable<KalugaDate>

Class describing a point in time Dates are localized according to a KalugaLocale and relative to a given KalugaTimeZone

KalugaDateFormatter

actual class KalugaDateFormatter : BaseDateFormatter

Default implementation of BaseDateFormatter

actual class KalugaDateFormatter : BaseDateFormatter

Default implementation of BaseDateFormatter

expect class KalugaDateFormatter : BaseDateFormatter

Default implementation of BaseDateFormatter

actual class KalugaDateFormatter : BaseDateFormatter

Default implementation of BaseDateFormatter

actual class KalugaDateFormatter : BaseDateFormatter

Default implementation of BaseDateFormatter

actual class KalugaDateFormatter : BaseDateFormatter

Default implementation of BaseDateFormatter backed by the ECMAScript Intl.DateTimeFormat API for style-based formatting and the luxon library for custom pattern formatting and parsing. Shared by the JS family (js + wasmJs).

KalugaDateHolder

actual typealias KalugaDateHolder = Date

typealias KalugaDateHolder = Date

Class holding the platform value of the desired Date.

actual typealias KalugaDateHolder = NSDate

typealias KalugaDateHolder = NSDate

Class holding the platform value of the desired Date.

expect class KalugaDateHolder

Class holding the platform value of the desired Date.

actual typealias KalugaDateHolder = Date

typealias KalugaDateHolder = Date

Class holding the platform value of the desired Date.

actual typealias KalugaDateHolder = Date

typealias KalugaDateHolder = Date

Class holding the platform value of the desired Date.

actual class KalugaDateHolder

Class holding the platform value of the desired Date.

actual typealias KalugaDateHolder = NSDate

typealias KalugaDateHolder = NSDate

Class holding the platform value of the desired Date.

actual class KalugaTimeZone : BaseTimeZone

A default implementation of BaseTimeZone.

actual class KalugaTimeZone : BaseTimeZone

A default implementation of BaseTimeZone.

expect class KalugaTimeZone : BaseTimeZone

A default implementation of BaseTimeZone.

actual class KalugaTimeZone : BaseTimeZone

A default implementation of BaseTimeZone.

actual class KalugaTimeZone : BaseTimeZone

A default implementation of BaseTimeZone.

actual class KalugaTimeZone : BaseTimeZone

A default implementation of BaseTimeZone backed by the luxon JS library, shared by the JS family (js + wasmJs).

TimeZoneNameStyle

enum TimeZoneNameStyle : Enum<TimeZoneNameStyle>

Style for writing the name of a KalugaTimeZone Can be either TimeZoneNameStyle.Short or TimeZoneNameStyle.Long

Properties

val KalugaDate.isLastMonth: Boolean

True if this KalugaDate is last month

val KalugaDate.isLastYear: Boolean

True if this KalugaDate is last year

val KalugaDate.isNextMonth: Boolean

True if this KalugaDate is next month

val KalugaDate.isNextYear: Boolean

True if this KalugaDate is next year

val KalugaDate.isThisMonth: Boolean

True if this KalugaDate is this month

val KalugaDate.isThisYear: Boolean

True if this KalugaDate is this year

val KalugaDate.isToday: Boolean

True if this KalugaDate is today

val KalugaDate.isTomorrow: Boolean

True if this KalugaDate is tomorrow

val KalugaDate.isYesterday: Boolean

True if this KalugaDate is yesterday

uses24HourClock

val KalugaLocale.uses24HourClock: Boolean

Indicates whether this locale use a 24 hour clock cycle.

val KalugaTimeZone.Companion.utc: KalugaTimeZone

Gets the UTC KalugaTimeZone

Functions

fun KalugaDateFormatter.Companion.dateFormat(style: DateFormatStyle = DateFormatStyle.Medium, excludeYear: Boolean, timeZone: KalugaTimeZone = KalugaTimeZone.current(), locale: KalugaLocale = defaultLocale): KalugaDateFormatter

Creates a KalugaDateFormatter that only formats the date components of a KalugaDate

fun KalugaDateFormatter.Companion.dateTimeFormat(dateStyle: DateFormatStyle = DateFormatStyle.Medium, excludeYear: Boolean, timeStyle: DateFormatStyle = DateFormatStyle.Medium, timeZone: KalugaTimeZone = KalugaTimeZone.current(), locale: KalugaLocale = defaultLocale): KalugaDateFormatter

Creates a KalugaDateFormatter that formats both date and time components of a KalugaDate

fun DefaultKalugaDate.Companion.epoch(offsetInMilliseconds: Long, timeZone: KalugaTimeZone = KalugaTimeZone.current(), locale: KalugaLocale = defaultLocale): KalugaDate

Creates a KalugaDate relative to January 1st 1970 00:00:00 GMT

fixedPatternFormat

fun KalugaDateFormatter.Companion.fixedPatternFormat(pattern: String, timeZone: KalugaTimeZone = KalugaTimeZone.current()): KalugaDateFormatter

Creates a fixed KalugaDateFormatter using a custom Date format pattern, localized by the KalugaLocale.enUsPosix. Use this to ensure that displaying time in 12 or 24 hour format is not overridden by the user.

fun KalugaDate.isInSameYear(date: KalugaDate): Boolean

Checks whether a KalugaDate is in the same year as a given Date.

fun KalugaDateFormatter.Companion.iso8601Pattern(timeZone: KalugaTimeZone = KalugaTimeZone.current()): KalugaDateFormatter

Creates a KalugaDateFormatter that formats time according to the ISo 8601 format.

fun KalugaDate.isOnSameDay(date: KalugaDate): Boolean

Checks whether a KalugaDate is on the same day as a given Date.

fun KalugaDate.isOnSameMonth(date: KalugaDate): Boolean

Checks whether a KalugaDate is on the same month as a given Date.

infix operator fun KalugaDate.minus(other: KalugaDate): Duration

Gets the Duration between two KalugaDate

infix operator fun KalugaDate.minus(duration: Duration): KalugaDate

Gets a KalugaDate that is duration before this date.

fun DefaultKalugaDate.Companion.now(offsetInMilliseconds: Long, timeZone: KalugaTimeZone = KalugaTimeZone.current(), locale: KalugaLocale = defaultLocale): KalugaDate

Creates a KalugaDate relative to the current time

fun DefaultKalugaDate.Companion.nowUtc(offsetInMilliseconds: Long, locale: KalugaLocale = defaultLocale): KalugaDate

fun DefaultKalugaDate.Companion.nowUtc(offset: Duration = 0.milliseconds, locale: KalugaLocale = defaultLocale): KalugaDate

Creates a KalugaDate relative to the current time, in the UTC timezone

infix operator fun KalugaDate.plus(duration: Duration): KalugaDate

Gets a KalugaDate that is duration after this date.

fun DefaultKalugaDate.Companion.today(timeZone: KalugaTimeZone = KalugaTimeZone.current(), locale: KalugaLocale = defaultLocale): KalugaDate

Gets a KalugaDate that is set at midnight on the same day as the current time.

fun KalugaDate.toEndOfDay(): KalugaDate

Gets a KalugaDate equal to 23:59:59:999 on the same day as this Date

fun DefaultKalugaDate.Companion.tomorrow(timeZone: KalugaTimeZone = KalugaTimeZone.current(), locale: KalugaLocale = defaultLocale): KalugaDate

Gets a KalugaDate that is set at midnight on the day after the current time.

fun KalugaDate.toStartOfDay(): KalugaDate

Gets a KalugaDate equal to midnight on the same day as this Date