Ask your question and get a summary of the document by referencing this page and the AI provider of your choice
By integrating the Intlayer MCP Server to your favourite AI assistant can retrieve all the doc directly from ChatGPT, DeepSeek, Cursor, VSCode, etc.
See MCP Server docThe content of this page was translated using an AI.
See the last version of the original content in EnglishIf you have an idea for improving this documentation, please feel free to contribute by submitting a pull request on GitHub.
GitHub link to the documentationCopy doc Markdown to clipboard
Documentation: getLocaleName Function in intlayer
Description
The getLocaleName function returns the localised name of a given locale (targetLocale) in the display locale (displayLocale). If no targetLocale is provided, it returns the name of the displayLocale in its own language.
Parameters
displayLocale: Locales
- Description: The locale in which the name of the target locale will be displayed.
- Type: Enum or string representing valid locales.
targetLocale?: Locales
- Description: The locale whose name is to be localised.
- Type: Optional. Enum or string representing valid locales.
Returns
- Type: string
- Description: The localised name of the targetLocale in the displayLocale, or the displayLocale's own name if targetLocale is not provided. If no translation is found, it returns "Unknown locale".
Example Usage
Copy the code to the clipboard
import { Locales, getLocaleName } from "intlayer";getLocaleName(Locales.ENGLISH); // Output: "English"getLocaleName(Locales.ENGLISH, Locales.FRENCH); // Output: "Anglais"getLocaleName(Locales.ENGLISH, Locales.ESPANOL); // Output: "Inglés"getLocaleName(Locales.ENGLISH, Locales.ENGLISH); // Output: "English"getLocaleName(Locales.FRENCH); // Output: "Français"getLocaleName(Locales.FRENCH, Locales.FRENCH); // Output: "Français"getLocaleName(Locales.FRENCH, Locales.ESPANOL); // Output: "Francés"getLocaleName(Locales.FRENCH, Locales.ENGLISH); // Output: "French"getLocaleName(Locales.CHINESE); // Output: "中文"getLocaleName(Locales.CHINESE, Locales.FRENCH); // Output: "Chinois"getLocaleName(Locales.CHINESE, Locales.ESPANOL); // Output: "Chino"getLocaleName(Locales.CHINESE, Locales.ENGLISH); // Output: "Chinese"getLocaleName("unknown-locale"); // Output: "Unknown locale"
Edge Cases
- No targetLocale provided:
- The function defaults to returning the displayLocale's own name.
- Missing translations:
- If localeNameTranslations does not contain an entry for the targetLocale or the specific displayLocale, the function falls back to the ownLocalesName or returns "Unknown locale".
Doc History
- 5.5.10 - 2025-06-29: Initial history