# generaltranslation: General Translation Core SDK: getLocaleProperties
URL: https://generaltranslation.com/ru/docs/core/functions/locales/get-locale-properties.mdx
---
title: getLocaleProperties
description: Справочник API для независимой функции getLocaleProperties
---

## Обзор

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

```typescript
import { getLocaleProperties } from 'generaltranslation';

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

***


## Справочник

### Параметры

<TypeTable
  type={{
  "locale": {
    type: 'string',
    optional: false,
  },
  "defaultLocale?": {
    type: 'string',
    optional: true,
  },
  "customMapping?": {
    type: 'CustomMapping',
    optional: true,
  }
}}
/>

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

| Параметр        | Описание                                                                             |
| --------------- | ------------------------------------------------------------------------------------ |
| `locale`        | Код локали BCP-47, для которой нужно получить свойства                               |
| `defaultLocale` | Локаль, используемая для локализации отображаемых имен (по умолчанию — &#39;en&#39;) |
| `customMapping` | Необязательное пользовательское сопоставление кодов локалей и свойств                |

### Возвращает

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

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

***

## Поведение

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

* Для всех свойств сначала проверяются пользовательские сопоставления
* Поддерживается разрешение псевдонимов и переопределение свойств
* Для несопоставленных кодов используются стандартные API Intl
* Определение стандартной локали для локалей-псевдонимов

***

## Примеры

```typescript
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`](/docs/core/types/locale-properties) — полное описание интерфейса
* Используйте метод класса GT [`getLocaleProperties`](/docs/core/class/methods/locales/get-locale-properties)
* Получите краткие названия локалей с помощью [`getLocaleName`](/docs/core/functions/locales/get-locale-name)
* Получите эмодзи локали с помощью [`getLocaleEmoji`](/docs/core/functions/locales/get-locale-emoji)