RelativeYearLocalizer

class RelativeYearLocalizer(options: RelativeYearOptions = RelativeYearOptions(), locale: PlatformLocale = getDefaultLocale()) : PolyglotReferenceDateTimeLocalizer<Int>

Localizes a year relative to a Zoned<Instant> reference point.

As this class implements PolyglotReferenceDateTimeLocalizer, it allows to use localizeAsFlow.

Localization could, based on options, prioritize a word style localization (e.g. last year) over a numeric style (e.g. 1 year ago).

Because kotlinx-datetime doesn't provide a standard type for a year, there is no extension function equivalent for one-off localizations.

Examples:

  • last yr.

  • this year

  • next year

  • 1 year ago

  • in 5y

See also

Constructors

Link copied to clipboard
constructor(options: RelativeYearOptions = RelativeYearOptions(), locale: PlatformLocale = getDefaultLocale())

Functions

Link copied to clipboard
open override fun localize(value: Int, reference: Zoned<Instant>): TickingValue<String>
Link copied to clipboard
fun localizeDiff(diff: Int): String

Convenience function to format an already calculated diff of years (e.g. -1 for last year).