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

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

---

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

## Обзор [#overview]

Импортируйте `getLocaleProperties` напрямую из `generaltranslation` и вызовите её, передав код локали и необязательную локаль отображения. Для этого не нужен ни API-ключ, ни экземпляр [GT](/docs/platform/core/reference/gt-class/constructor). Для эквивалентного варианта, основанного на экземпляре, используйте метод [`getLocaleProperties`](/docs/platform/core/reference/gt-class-methods/locales/get-locale-properties) экземпляра [`GT`](/docs/platform/core/reference/gt-class/constructor).

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

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

Сигнатура:

```typescript
getLocaleProperties(
  locale: string,
  defaultLocale?: string,
  customMapping?: CustomMapping
): LocaleProperties
```

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

* **Полные метаданные.** Возвращает полный объект [`LocaleProperties`](/docs/platform/core/reference/types/locale-properties), включая стандартные и максимализированные формы.
* **Названия на родном языке.** Названия на родном языке всегда вычисляются в самой целевой локали, независимо от `defaultLocale`.
* **Интеграция с пользовательскими сопоставлениями.** Для всех свойств сначала проверяются пользовательские сопоставления, поддерживаются разрешение алиасов и переопределение свойств, а для кодов без сопоставлений используются стандартные API `Intl`. Локали с алиасами приводятся к их канонической локали.

*Примечание: отображаемые названия используют диалектную форму CLDR. Например, `getLocaleProperties('es-MX', 'en').name` — это "мексиканский испанский", а не "испанский (Мексика)", а `nativeName` — "español de México".*

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

| Параметр                           | Описание                                                    | Тип                                                                   | Необязательный | По умолчанию |
| ---------------------------------- | ----------------------------------------------------------- | --------------------------------------------------------------------- | -------------- | ------------ |
| [`locale`](#locale)                | Код локали BCP-47, для которого нужно получить свойства.    | `string`                                                              | Нет            | —            |
| [`defaultLocale`](#default-locale) | Локаль, используемая для локализации отображаемых названий. | `string`                                                              | Да             | `en`         |
| [`customMapping`](#custom-mapping) | Пользовательское сопоставление кодов локалей и свойств.     | [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping) | Да             | —            |

### `locale` [#locale]

**Тип** `string` · **Обязательно**

Код локали BCP-47, свойства которой нужно получить.

### `defaultLocale` [#default-locale]

**Тип** `string` · **Необязательно** · **По умолчанию** `en`

Локаль, используемая для локализации отображаемых названий в возвращаемом значении.

### `customMapping` [#custom-mapping]

**Тип** [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping) · **Необязательно**

Необязательное пользовательское сопоставление кодов локалей и их свойств.

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

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

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

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

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

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

// Отображаемые названия на английском
const enProps = getLocaleProperties('es-MX', 'en');
console.log(enProps.name); // "Mexican Spanish"
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 du Mexique"
console.log(frProps.languageName); // "espagnol"
console.log(frProps.regionName); // "Mexique"

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

## Примечания [#notes]

* Предоставляет данные о локали без создания экземпляра класса GT.
* Свойства сопоставления имеют приоритет над стандартными API `Intl`.
* Всегда возвращается полный объект `LocaleProperties`.
* Названия на родном языке всегда вычисляются в самой целевой локали.