Utility FunctionsLocales

getLocaleProperties

Справочник по API для автономной функции getLocaleProperties

Обзор

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

import { getLocaleProperties } from 'generaltranslation';

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

Справка

Параметры

Prop

Type

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

ПараметрОписание
localeКод локали BCP‑47, для которого нужно получить свойства
defaultLocaleЛокаль для локализации отображаемых названий (по умолчанию «en»)
customMappingНеобязательное пользовательское отображение кодов локалей и их свойств

Возвращает

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

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

Поведение

Интеграция пользовательских сопоставлений

  • Пользовательские сопоставления проверяются в первую очередь для всех свойств
  • Поддерживается разрешение псевдонимов (alias) и переопределение свойств
  • Для нераспознанных кодов выполняется откат к стандартным API Intl
  • Каноническое определение локали для локалей с псевдонимами

Примеры

import { getLocaleProperties } from 'generaltranslation';

// Названия на английском языке
const enProps = getLocaleProperties('es-MX', 'en');
console.log(enProps.name); // "Spanish (Mexico)"
console.log(enProps.languageName); // "Spanish"
console.log(enProps.regionName); // "Mexico"
console.log(enProps.emoji); // "🇲🇽"

// Названия на французском языке
const frProps = getLocaleProperties('es-MX', 'fr');
console.log(frProps.name); // "espagnol (Mexique)"
console.log(frProps.languageName); // "espagnol"
console.log(frProps.regionName); // "Mexique"

// Нативные названия всегда указываются на целевом языке
console.log(enProps.nativeName); // "español (México)"
console.log(frProps.nativeName); // "español (México)"

Примечания

  • Функция предоставляет данные локали без создания экземпляра класса GT
  • Пользовательские свойства сопоставления имеют приоритет над стандартными API Intl
  • Всегда возвращается полный интерфейс LocaleProperties
  • Родные названия всегда вычисляются в целевой локали

Дальнейшие шаги

  • Изучите интерфейс LocaleProperties — полная документация по интерфейсу
  • Используйте метод класса GT getLocaleProperties
  • Получайте короткие названия локалей с помощью getLocaleName
  • Получайте эмодзи локали с помощью getLocaleEmoji

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

getLocaleProperties