- Documentation
- Packages
- intlayer
- getTranslationContent
Documentation: getTranslationContent Fonction dans intlayer
Description:
La fonction getTranslationContent récupère le contenu correspondant à un locale spécifique à partir d'un ensemble de contenu linguistique personnalisable. Si le locale spécifié n'est pas trouvé, il renvoie par défaut le contenu du locale par défaut configuré dans le projet.
Paramètres:
languageContent: CustomizableLanguageContent<Content>
- Description: Un objet contenant des traductions pour divers locales. Chaque clé représente un locale et sa valeur est le contenu correspondant.
- Type: CustomizableLanguageContent<Content>
- Content peut être de n'importe quel type, par défaut string.
locale: Locales
- Description: Le locale pour lequel le contenu doit être récupéré.
- Type: Locales
Retourne:
- Type: Content
- Description: Le contenu correspondant au locale spécifié. Si le locale n'est pas trouvé, le contenu du locale par défaut est renvoyé.
Exemple d'Utilisation:
Utilisation de Base:
typescript
1import { getTranslationContent, Locales } from "intlayer";
2
3const content = getTranslationContent(
4 {
5 en: "Hello",
6 fr: "Bonjour",
7 },
8 Locales.ENGLISH
9);
10
11console.log(content); // Sortie: "Bonjour"Locale Manquant:
typescript
1import { getTranslationContent, Locales } from "intlayer";
2
3const content = getTranslationContent(
4 {
5 en: "Hello",
6 fr: "Bonjour",
7 },
8 Locales.SPANISH
9);
10
11console.log(content); // Sortie: "Hello" (contenu du locale par défaut)Utilisation de Types de Contenu Personnalisés:
typescript
1import { getTranslationContent, Locales } from "intlayer";
2
3const customContent = getTranslationContent<Record<string, string>>(
4 {
5 en: { greeting: "Hello" },
6 fr: { greeting: "Bonjour" },
7 },
8 Locales.FRENCH
9);
10
11console.log(customContent.greeting); // Sortie: "Bonjour"Cas Limites:
- Locale Non Trouvé:
- Lorsque le locale n'est pas trouvé dans le languageContent, la fonction renvoie le contenu pour le locale par défaut.
Contenu Linguistique Incomplet:
- Si un locale est partiellement défini, la fonction ne fusionne pas les contenus. Elle récupère strictement la valeur du locale spécifié ou revient au défaut.
Contrôle TypeScript:
- Si les locales dans languageContent ne correspondent pas à la configuration du projet, TypeScript imposera que tous les locales requis soient définis, garantissant que le contenu est complet et sécurisé par type.
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