- Documentation
- Packages
- intlayer
- getTranslationContent
Documentación: getTranslationContent Función en intlayer
Descripción:
La función getTranslationContent recupera el contenido correspondiente a una localidad específica de un conjunto de contenido de idioma personalizable. Si la localidad especificada no se encuentra, se devuelve de forma predeterminada el contenido para la localidad predeterminada configurada en el proyecto.
Parámetros:
languageContent: CustomizableLanguageContent<Content>
- Descripción: Un objeto que contiene traducciones para varias localidades. Cada clave representa una localidad, y su valor es el contenido correspondiente.
- Tipo: CustomizableLanguageContent<Content>
- Content puede ser cualquier tipo, y por defecto es string.
locale: Locales
- Descripción: La localidad para la cual se debe recuperar el contenido.
- Tipo: Locales
Retorna:
- Tipo: Content
- Descripción: El contenido correspondiente a la localidad especificada. Si la localidad no se encuentra, se devuelve el contenido de la localidad predeterminada.
Ejemplo de Uso:
Uso Básico:
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); // Salida: "Bonjour"
Localidad Faltante:
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); // Salida: "Hello" (contenido de la localidad predeterminada)
Usando Tipos de Contenido Personalizados:
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); // Salida: "Bonjour"
Casos Límite:
- Localidad No Encontrada:
- Cuando la locale no se encuentra en el languageContent, la función devuelve el contenido para la localidad predeterminada.
Contenido de Idioma Incompleto:
- Si una localidad está parcialmente definida, la función no fusiona contenidos. Recupera estrictamente el valor de la localidad especificada o retrocede a la predeterminada.
Aplicación de TypeScript:
- Si las localidades en languageContent no coinciden con la configuración del proyecto, TypeScript hará cumplir que todas las localidades requeridas estén definidas, asegurando que el contenido sea completo y seguro en tipos.
Enlaces:
Si tienes una idea para mejorar esta documentación, no dudes en contribuir enviando una pull request en GitHub.
Enlace de GitHub a la documentación