Documentation: getLocaleName Function in intlayer
Description
La fonction getLocaleName retourne le nom localisé d'une locale donnée (targetLocale) dans la locale d'affichage (displayLocale). Si aucune targetLocale n'est fournie, elle retourne le nom de la displayLocale dans sa propre langue.
Parameters
displayLocale: Locales
- Description: La locale dans laquelle le nom de la locale cible sera affiché.
- Type: Enum ou chaîne représentant des locales valides.
targetLocale?: Locales
- Description: La locale dont le nom doit être localisé.
- Type: Optionnel. Enum ou chaîne représentant des locales valides.
Returns
- Type: string
- Description: Le nom localisé de la targetLocale dans la displayLocale, ou le propre nom de la displayLocale si targetLocale n'est pas fourni. Si aucune traduction n'est trouvée, elle retourne "Unknown locale".
Example Usage
typescript
import { Locales, getLocaleName } from "intlayer";getLocaleName(Locales.ENGLISH); // Sortie : "English"getLocaleName(Locales.ENGLISH, Locales.FRENCH); // Sortie : "Anglais"getLocaleName(Locales.ENGLISH, Locales.ESPANOL); // Sortie : "Inglés"getLocaleName(Locales.ENGLISH, Locales.ENGLISH); // Sortie : "English"getLocaleName(Locales.FRENCH); // Sortie : "Français"getLocaleName(Locales.FRENCH, Locales.FRENCH); // Sortie : "Français"getLocaleName(Locales.FRENCH, Locales.ESPANOL); // Sortie : "Francés"getLocaleName(Locales.FRENCH, Locales.ENGLISH); // Sortie : "French"getLocaleName(Locales.CHINESE); // Sortie : "中文"getLocaleName(Locales.CHINESE, Locales.FRENCH); // Sortie : "Chinois"getLocaleName(Locales.CHINESE, Locales.ESPANOL); // Sortie : "Chino"getLocaleName(Locales.CHINESE, Locales.ENGLISH); // Sortie : "Chinese"getLocaleName("unknown-locale"); // Sortie : "Unknown locale"
Edge Cases
- Pas de targetLocale fournie :
- La fonction retourne par défaut le propre nom de la displayLocale.
- Traductions manquantes :
- Si localeNameTranslations ne contient pas d'entrée pour la targetLocale ou la displayLocale spécifique, la fonction revient à l’ownLocalesName ou retourne "Unknown locale".
Si vous avez une idée d’amélioration pour améliorer cette documentation, n’hésitez pas à contribuer en submitant une pull request sur GitHub.
Lien GitHub de la documentation