# generaltranslation: General Translation Core SDK: getLocaleName
URL: https://generaltranslation.com/en-GB/docs/core/functions/locales/get-locale-name.mdx
---
title: getLocaleName
description: API reference for the standalone getLocaleName function
---

## Overview

The standalone `getLocaleName` function retrieves the display name of a locale code without requiring a GT class instance.
It uses the `Intl.DisplayNames` API to provide localised names for any valid BCP-47 locale code.

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

const name = getLocaleName('fr-CA', 'en');
console.log(name); // "French (Canada)"
```

***


## Reference

### Parameters

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

### Parameter descriptions

| Parameter       | Description                                                              |
| --------------- | ------------------------------------------------------------------------ |
| `locale`        | BCP-47 locale code to get the display name for                           |
| `defaultLocale` | Locale to use for localising the display name (defaults to &#39;en&#39;) |
| `customMapping` | Optional custom mapping for locale codes and names                       |

### Returns

`string` - The localised display name of the locale.

***

## Behaviour

### Display language resolution

The function localises names in this order of priority:

1. `defaultLocale` parameter (if provided)
2. Library default locale (&#39;en&#39;)

### Custom mapping integration

* Custom mappings are checked first for both locale codes and names
* Supports alias resolution and custom display names
* Falls back to the standard Intl.DisplayNames for unmapped codes

### Name resolution strategy

1. **Custom mapping name** (highest priority)
2. **Intl.DisplayNames** in default locale
3. **Intl.DisplayNames** in library default (&#39;en&#39;)
4. **Locale code itself** (fallback)

***

## Examples

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

// English display names
console.log(getLocaleName('es', 'en')); // "Spanish (Spain)"
console.log(getLocaleName('ja', 'en')); // "Japanese (Japan)"
console.log(getLocaleName('zh', 'en')); // "Chinese (China)"
```


### Building locale options

```typescript
import { getLocaleName, getLocaleEmoji } from 'generaltranslation';

function buildLocaleOptions(
  supportedLocales: string[],
  displayLocale: string = 'en'
) {
  return supportedLocales.map(locale => ({
    value: locale,
    label: getLocaleName(locale, displayLocale),
    emoji: getLocaleEmoji(locale)
  }));
}

const options = buildLocaleOptions([
  'en',
  'es',
  'fr',
  'de',
  'ja'
], 'en');

console.log(options);
// [
//   { value: 'en', label: 'English (United States)', emoji: '🇺🇸' },
//   { value: 'es', label: 'Spanish (Spain)', emoji: '🇪🇸' },
//   ...
// ]
```

***


## Notes

* Custom mappings take precedence over standard Intl.DisplayNames
* Returns the locale code itself if no display name can be determined
* The display locale parameter determines the language of the returned name

## Next steps

* Get a locale emoji with [`getLocaleEmoji`](/docs/core/functions/locales/get-locale-emoji)
* Use the GT class method for stateful operations [`getLocaleName`](/docs/core/class/methods/locales/get-locale-name)
* Learn about the [`CustomMapping` type](/docs/core/types/custom-mapping)