Interface Locale

interface Locale {
    baseName: string;
    calendar?: string;
    caseFirst?: LocaleCollationCaseFirst;
    collation?: string;
    hourCycle?: LocaleHourCycleKey;
    language: string;
    numberingSystem?: string;
    numeric?: boolean;
    region?: string;
    script?: string;
    maximize(): Locale;
    minimize(): Locale;
    toString(): string;
}

Hierarchy (view full)

Properties

baseName calendar? caseFirst? collation? hourCycle? language numberingSystem? numeric? region? script?

Methods

maximize minimize toString

Properties

baseName

baseName: string

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

Optionalcalendar

calendar?: string

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

OptionalcaseFirst

caseFirst?: LocaleCollationCaseFirst

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

Optionalcollation

collation?: string

The collation type used for sorting

OptionalhourCycle

hourCycle?: LocaleHourCycleKey

The time keeping format convention used by the locale.

language

language: string

The primary language subtag associated with the locale.

OptionalnumberingSystem

numberingSystem?: string

The numeral system used by the locale.

Optionalnumeric

numeric?: boolean

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

Optionalregion

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.

Optionalscript

script?: string

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

Methods

maximize

  • maximize(): Locale

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

    Returns Locale

minimize

  • minimize(): Locale

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

    Returns Locale

toString

  • toString(): string

  • Returns the locale's full locale identifier string.

    Returns string

Settings

Member Visibility

On This Page

Properties
Methods