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

NumberFormatStyle

sealed class NumberFormatStyle

Style used for formatting a Number to and from a String

NumberFormatter

actual class NumberFormatter(val locale: KalugaLocale, style: NumberFormatStyle) : BaseNumberFormatter

Default implementation of BaseNumberFormatter

actual class NumberFormatter(val locale: KalugaLocale, style: NumberFormatStyle) : BaseNumberFormatter

Default implementation of BaseNumberFormatter

expect class NumberFormatter(locale: KalugaLocale = defaultLocale, style: NumberFormatStyle = NumberFormatStyle.Decimal()) : BaseNumberFormatter

Default implementation of BaseNumberFormatter

actual class NumberFormatter(val locale: KalugaLocale, style: NumberFormatStyle) : BaseNumberFormatter

Default implementation of BaseNumberFormatter

actual class NumberFormatter(val locale: KalugaLocale, style: NumberFormatStyle) : BaseNumberFormatter

Default implementation of BaseNumberFormatter

actual class NumberFormatter(val locale: KalugaLocale, style: NumberFormatStyle) : BaseNumberFormatter

Default implementation of BaseNumberFormatter backed by the ECMAScript Intl.NumberFormat API, shared by the JS family (js + wasmJs) via typed Intl externals.

RoundingMode

enum RoundingMode : Enum<RoundingMode>

Rounding mode applied when rounding aa given Number while formatting

StringFormatter

class StringFormatter(out: StringBuilder = StringBuilder(), locale: KalugaLocale = defaultLocale)

Formats a given String using a printf-style format strings. Supports formats for Number, String, Char, Boolean, and com.splendo.kaluga.base.utils.KalugaDate. Custom formatting is supported by implementing Formattable. Flags, precision and width are supported by this formatter as well. Formatting will adjust for a provided KalugaLocale. May throw a StringFormatterException if the incorrect format is applied.

StringFormatterException

sealed class StringFormatterException : Exception

List of exceptions that may be thrown by a StringFormatter.

Properties

lineSeparator

actual val lineSeparator: String

The String that serves as a line separator.

actual val lineSeparator: String

The String that serves as a line separator.

expect val lineSeparator: String

The String that serves as a line separator.

actual val lineSeparator: String

The String that serves as a line separator.

actual val lineSeparator: String

The String that serves as a line separator. Shared by the JS family (js + wasmJs).

Functions

dateFormat

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

dateTimeFormat

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

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.

format

fun String.format(vararg args: Any?, locale: KalugaLocale = defaultLocale): String

Formats this String as a printf-style format String using a variable number of arguments.

iso8601Pattern

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

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

lowerCased

actual fun String.lowerCased(locale: KalugaLocale): String

Converts a String to its lower cased variant based on a given KalugaLocale

actual fun String.lowerCased(locale: KalugaLocale): String

Converts a String to its lower cased variant based on a given KalugaLocale

expect fun String.lowerCased(locale: KalugaLocale): String

Converts a String to its lower cased variant based on a given KalugaLocale

actual fun String.lowerCased(locale: KalugaLocale): String

Converts a String to its lower cased variant based on a given KalugaLocale

actual fun String.lowerCased(locale: KalugaLocale): String

Converts a String to its lower cased variant based on a given KalugaLocale, backed by JavaScript's String.prototype.toLocaleLowerCase (applies locale-specific casing, e.g. Turkish dotted/dotless "I").

toString

fun Set<Flag>.toString(): String

upperCased

actual fun String.upperCased(locale: KalugaLocale): String

Converts a String to its upper cased variant based on a given KalugaLocale

actual fun String.upperCased(locale: KalugaLocale): String

Converts a String to its upper cased variant based on a given KalugaLocale

expect fun String.upperCased(locale: KalugaLocale): String

Converts a String to its upper cased variant based on a given KalugaLocale

actual fun String.upperCased(locale: KalugaLocale): String

Converts a String to its upper cased variant based on a given KalugaLocale

actual fun String.upperCased(locale: KalugaLocale): String

Converts a String to its upper cased variant based on a given KalugaLocale, backed by JavaScript's String.prototype.toLocaleUpperCase.