GT ClassMethodsLocales

getLocaleProperties

Справочная информация по методу GT getLocaleProperties (API Reference)

Обзор

Метод getLocaleProperties возвращает полный набор свойств для кода локали, включая подробные сведения об отображаемых названиях, кодах регионов, системе письма и флагах‑эмодзи. Он возвращает полноценный объект LocaleProperties со всеми данными, необходимыми для создания богатых, интернационализированных пользовательских интерфейсов.

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

const props = gt.getLocaleProperties('fr-CA');
console.log(props.name); // "Французский (Канада)"
console.log(props.nativeName); // "français (Canada)"
console.log(props.emoji); // "🇨🇦"

Справка

Параметры

Prop

Type

Описание параметров

ПараметрОписание
localeКод локали по BCP‑47, для которой нужно получить свойства. Если не указан, будет использовано значение targetLocale экземпляра

Возвращает

LocaleProperties — полный объект со всей информацией о локали:

  • code: стандартизированный код локали
  • name: имя для отображения в исходной локали
  • nativeName: имя для отображения на языке локали
  • languageCode, languageName, nativeLanguageName: сведения о языке
  • regionCode, regionName, nativeRegionName: сведения о регионе
  • scriptCode, scriptName, nativeScriptName: сведения о письме
  • maximizedCode, minimizedCode: канонические формы
  • nameWithRegionCode, nativeNameWithRegionCode: комбинированные форматы отображения
  • emoji: флаг или соответствующий эмодзи

Исключения

  • Error — если локаль не передана и у экземпляра не настроен targetLocale

Примеры

Базовое использование

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

// Get properties for target locale
const props = gt.getLocaleProperties();
console.log(props.name); // "французский (Франция)"
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); // "австрийский немецкий"
console.log(germanProps.nativeName); // "Österreichisches Deutsch"
console.log(germanProps.regionName); // "Австрия"
console.log(germanProps.nativeRegionName); // "Österreich"

Примечания

  • Все отображаемые имена зависят от настройки sourceLocale экземпляра
  • Пользовательские свойства сопоставления имеют приоритет над стандартными API Intl

Следующие шаги

  • Ознакомьтесь с интерфейсом LocaleProperties
  • Получайте простые названия локалей с помощью getLocaleName
  • Получайте эмодзи локали с помощью getLocaleEmoji
  • Узнайте о типе CustomMapping

Насколько полезно это руководство?

getLocaleProperties