Overview

The getLocaleProperties method retrieves comprehensive properties for a locale code, providing detailed information including display names, region codes, script details, and emoji flags. It returns a complete LocaleProperties object with all the data needed to build rich, internationalised user interfaces.

const gt = new GT({
  sourceLocale: 'en',
  targetLocale: 'es'
});

const props = gt.getLocaleProperties('fr-CA');
console.log(props.name); // "French (Canada)"
console.log(props.nativeName); // "français (Canada)"
console.log(props.emoji); // "🇨🇦"

Reference

Parameters

Parameter Description

Returns

LocaleProperties - A comprehensive object containing all locale information:

• code: Standardised locale code
• name: Display name in the source locale
• nativeName: Display name in the locale itself
• languageCode, languageName, nativeLanguageName: Language information
• regionCode, regionName, nativeRegionName: Region information
• scriptCode, scriptName, nativeScriptName: Script information
• maximizedCode, minimizedCode: Canonical forms
• nameWithRegionCode, nativeNameWithRegionCode: Combined display formats
• emoji: Flag or representative emoji

Throws

• Error – if no locale is provided and the instance has no targetLocale configured

Examples

Basic usage

const gt = new GT({
  sourceLocale: 'en',
  targetLocale: 'fr'
});

// Get properties for target locale
const props = gt.getLocaleProperties();
console.log(props.name); // "French (France)"
console.log(props.nativeName); // "français (France)"
console.log(props.languageCode); // "fr"
console.log(props.regionCode); // "FR"
console.log(props.emoji); // "🇫🇷"

// Get properties for other locales
const germanProps = gt.getLocaleProperties('de-AT');
console.log(germanProps.name); // "Austrian German"
console.log(germanProps.nativeName); // "Österreichisches Deutsch"
console.log(germanProps.regionName); // "Austria"
console.log(germanProps.nativeRegionName); // "Österreich"

Notes

• All display names follow the instance’s sourceLocale setting
• Custom mapping properties take precedence over standard Intl APIs

Next steps

• Explore the LocaleProperties interface
• Get simple locale names with getLocaleName
• Get locale emoji with getLocaleEmoji
• Learn about the CustomMapping type