Class Locale

An ICU4X Locale, capable of representing strings like "en-US".

See the Rust documentation for Locale for more information.

Accessors

basename

get basename(): string
Returns a string representation of the LanguageIdentifier part of Locale.

See the Rust documentation for id for more information.

Returns string
- Defined in Locale.d.ts:50

language

get language(): string
Returns a string representation of Locale language.

See the Rust documentation for id for more information.

Returns string
- Defined in Locale.d.ts:71
set language(s: string): void
Set the language part of the Locale.

See the Rust documentation for try_from_str for more information.
Parameters
- s: string
Returns void
- Defined in Locale.d.ts:78

region

get region(): string | null
Returns a string representation of Locale region.

See the Rust documentation for id for more information.

Returns string | null
- Defined in Locale.d.ts:85
set region(s: string): void
Set the region part of the Locale.

See the Rust documentation for try_from_str for more information.
Parameters
- s: string
Returns void
- Defined in Locale.d.ts:92

script

get script(): string | null
Returns a string representation of Locale script.

See the Rust documentation for id for more information.

Returns string | null
- Defined in Locale.d.ts:99
set script(s: string): void
Set the script part of the Locale. Pass an empty string to remove the script.

See the Rust documentation for try_from_str for more information.
Parameters
- s: string
Returns void
- Defined in Locale.d.ts:106

variantCount

get variantCount(): number
Returns the number of variants in this Locale.

See the Rust documentation for Variants for more information.

Returns number
- Defined in Locale.d.ts:120

Methods

`Static`fromString

fromString(name: string): Locale
Construct an Locale from an locale identifier.

This will run the complete locale parsing algorithm. If code size and performance are critical and the locale is of a known shape (such as aa-BB) use create_und, set_language, set_script, and set_region.

See the Rust documentation for try_from_str for more information.
Parameters
- name: string
Returns Locale
- Defined in Locale.d.ts:28

`Static`normalize

normalize(s: string): string
Normalizes a locale string.

See the Rust documentation for normalize for more information.
Parameters
- s: string
Returns string
- Defined in Locale.d.ts:168

`Static`unknown

unknown(): Locale
Construct a unknown Locale "und".

See the Rust documentation for UNKNOWN for more information.

Returns Locale
- Defined in Locale.d.ts:35

addVariant

addVariant(s: string): boolean
Adds a variant to the Locale.

Returns an error if the variant string is invalid. Returns true if the variant was added, false if already present.

See the Rust documentation for push for more information.
Parameters
- s: string
Returns boolean
- Defined in Locale.d.ts:144

clearVariants

clearVariants(): void
Clears all variants from the Locale.

See the Rust documentation for clear for more information.

Returns void
- Defined in Locale.d.ts:161

clone

clone(): Locale
Clones the Locale.

See the Rust documentation for Locale for more information.

Returns Locale
- Defined in Locale.d.ts:42

compareTo

compareTo(other: Locale): number
See the Rust documentation for total_cmp for more information.
Parameters
- other: Locale
Returns number
- Defined in Locale.d.ts:190

compareToString

compareToString(other: string): number
See the Rust documentation for strict_cmp for more information.
Parameters
- other: string
Returns number
- Defined in Locale.d.ts:185

getUnicodeExtension

getUnicodeExtension(s: string): string | null
Returns a string representation of the unicode extension.

See the Rust documentation for extensions for more information.
Parameters
- s: string
Returns string | null
- Defined in Locale.d.ts:57

hasVariant

hasVariant(s: string): boolean
Returns whether the Locale has a specific variant.

See the Rust documentation for Variants for more information.
Parameters
- s: string
Returns boolean
- Defined in Locale.d.ts:134

normalizingEq

normalizingEq(other: string): boolean
See the Rust documentation for normalizing_eq for more information.
Parameters
- other: string
Returns boolean
- Defined in Locale.d.ts:180

removeVariant

removeVariant(s: string): boolean
Removes a variant from the Locale.

Returns true if the variant was removed, false if not present. Returns false for invalid variant strings (they cannot exist in the locale).

See the Rust documentation for remove for more information.
Parameters
- s: string
Returns boolean
- Defined in Locale.d.ts:154

setUnicodeExtension

setUnicodeExtension(k: string, v: string): boolean
Set a Unicode extension.

See the Rust documentation for extensions for more information.
Parameters
- k: string
- v: string
Returns boolean
- Defined in Locale.d.ts:64

toString

toString(): string
Returns a string representation of Locale.

See the Rust documentation for write_to for more information.

Returns string
- Defined in Locale.d.ts:175

variantAt

variantAt(index: number): string | null
Returns the variant at the given index, or nothing if the index is out of bounds.

See the Rust documentation for Variants for more information.
Parameters
- index: number
Returns string | null
- Defined in Locale.d.ts:127

variants

variants(): string
Returns a string representation of the Locale variants.

See the Rust documentation for Variants for more information.

Returns string
- Defined in Locale.d.ts:113