kotlin-js/js.intl/Locale

Locale

open class Locale(tag: UnicodeBCP47LocaleIdentifier, options: LocaleOptions = definedExternally) : LocaleOptions(source)

Constructors

Locale

constructor(tag: UnicodeBCP47LocaleIdentifier, options: LocaleOptions = definedExternally)

constructor(tag: Locale, options: LocaleOptions = definedExternally)

Properties

baseName

external var baseName: String

A string containing the language, and the script and region if available.

calendar

open external var calendar: String?

The part of the Locale that indicates the locale's calendar era.

caseFirst

open external var caseFirst: CaseFirst?

Flag that defines whether case is taken into account for the locale's collation rules.

collation

open external var collation: String?

The collation type used for sorting

hourCycle

open external var hourCycle: HourCycle?

The time keeping format convention used by the locale.

language

external var language: String

The primary language subtag associated with the locale.

numberingSystem

open external var numberingSystem: String?

The numeral system used by the locale.

numeric

open external var numeric: Boolean?

Flag that defines whether the locale has special collation handling for numeric characters.

region

open external var region: String?

The region of the world (usually a country) associated with the locale. Possible values are region codes as defined by ISO 3166-1.

script

open external var script: String?

The script used for writing the particular language used in the locale. Possible values are script codes as defined by ISO 15924.

Functions

getCalendars

external fun getCalendars(): ReadonlyArray<JsString>

Returns a list of one or more unique calendar identifiers for this locale.

getCollations

external fun getCollations(): ReadonlyArray<JsString>

Returns a list of one or more collation types for this locale.

getHourCycles

external fun getHourCycles(): ReadonlyArray<JsString>

Returns a list of one or more unique hour cycle identifiers for this locale.

getNumberingSystems

external fun getNumberingSystems(): ReadonlyArray<JsString>

Returns a list of one or more unique numbering system identifiers for this locale.

getTextInfo

external fun getTextInfo(): TextInfo

Returns the ordering of characters indicated by either ltr (left-to-right) or by rtl (right-to-left) for this locale.

getTimeZones

external fun getTimeZones(): ReadonlyArray<JsString>?

Returns a list of supported time zones for this locale.

getWeekInfo

external fun getWeekInfo(): WeekInfo

Returns a WeekInfo object with the properties firstDay, weekend and minimalDays for this locale.

maximize

external fun maximize(): Locale

Gets the most likely values for the language, script, and region of the locale based on existing values.

minimize

external fun minimize(): Locale

Attempts to remove information about the locale that would be added by calling Locale.maximize().