# General Translation Platform: getLocaleProperties
URL: https://generaltranslation.com/ru/docs/platform/core/reference/gt-class-methods/locales/get-locale-properties.mdx
---

title: getLocaleProperties
description: Возвращает подробные сведения о языке, системе письма, регионе и направлении текста для локали. Справочник API для getLocaleProperties.

---

Получает полные сведения о коде локали в экземпляре [GT](/docs/platform/core/reference/gt-class/constructor), включая отображаемые имена, информацию о языке, системе письма и регионе, а также эмодзи-флаг. General Translation возвращает полный объект [`LocaleProperties`](/docs/platform/core/reference/types/locale-properties) с данными, необходимыми для создания полнофункциональных интернационализированных пользовательских интерфейсов.

## Обзор [#overview]

Вызовите `getLocaleProperties` у экземпляра [`GT`](/docs/platform/core/reference/gt-class/constructor), при необходимости передав код локали. Если его не указать, используется `targetLocale` этого экземпляра.

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

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

Сигнатура:

```typescript
getLocaleProperties(locale?: string): LocaleProperties
```

*Примечание: `getLocaleProperties` выполняется локально и не требует API-ключа. Если `locale` не указан, используется `targetLocale` экземпляра, а для отображаемых имён учитывается `sourceLocale` экземпляра. О поиске без экземпляра `GT` см. в автономной функции [`getLocaleProperties`](/docs/platform/core/reference/utility-functions/locales/get-locale-properties).*

## Как это работает [#how-it-works]

* **Максимизированная и минимизированная формы.** Метод определяет как максимизированную форму (с добавлением вероятных значений системы письма и региона), так и минимизированную форму кода локали.
* **Язык отображения.** Все отображаемые имена используют настройку `sourceLocale` этого экземпляра.
* **Приоритет `CustomMapping`.** Свойства, определённые в [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping), имеют приоритет над стандартными API `Intl`.
* **Резервная локаль.** Если `locale` не указана, используется `targetLocale` экземпляра.
* **Отсутствующая локаль.** Вызывает `Error`, если локаль не указана и для экземпляра не настроена `targetLocale`.

## Параметры [#parameters]

| Параметр            | Описание                                                | Тип      | Необязательный | По умолчанию        |
| ------------------- | ------------------------------------------------------- | -------- | -------------- | ------------------- |
| [`locale`](#locale) | Код локали BCP-47, для которой нужно получить свойства. | `string` | Да             | `this.targetLocale` |

### `locale` [#locale]

**Type** `string` · **Необязательно** · **По умолчанию** `this.targetLocale`

Код локали BCP-47, для которой нужно получить свойства (например, `"de-AT"`). Если не указано, используется `targetLocale` этого экземпляра.

## Возвращает [#returns]

**Тип** [`LocaleProperties`](/docs/platform/core/reference/types/locale-properties)

Объект с полным описанием локали:

* `code`: полный код локали (например, `"de-AT"`).
* `name`: название языка на языке интерфейса (например, `"Austrian German"`).
* `nativeName`: название языка на родном языке локали (например, `"Österreichisches Deutsch"`).
* `languageCode`, `languageName`, `nativeLanguageName`: информация об основном языке.
* `nameWithRegionCode`, `nativeNameWithRegionCode`: название языка с кодом региона (например, `"German (AT)"`).
* `regionCode`, `regionName`, `nativeRegionName`: информация о регионе.
* `scriptCode`, `scriptName`, `nativeScriptName`: информация о письменности.
* `maximizedCode`, `maximizedName`, `nativeMaximizedName`: полные формы с предполагаемыми письменностью и регионом.
* `minimizedCode`, `minimizedName`, `nativeMinimizedName`: сокращённые формы.
* `emoji`: флаг или соответствующий эмодзи для региона локали.

Вызывает `Error`, если локаль не указана и для экземпляра не задан `targetLocale`.

## Примеры [#examples]

```typescript
// Базовое использование
const gt = new GT({ sourceLocale: 'en', targetLocale: 'fr' });

// Получить свойства для целевой локали
const props = gt.getLocaleProperties();
console.log(props.name); // "French"
console.log(props.nativeName); // "français"
console.log(props.languageCode); // "fr"
console.log(props.regionCode); // "FR"
console.log(props.emoji); // "🇫🇷"

// Получить свойства для других локалей
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]

* Все отображаемые имена определяются с учётом настройки `sourceLocale` для этого экземпляра.
* Свойства Custom mapping имеют приоритет перед стандартными API `Intl`.