getLocaleProperties
Referencia de API de la función independiente getLocaleProperties
Descripción general
La función independiente getLocaleProperties obtiene las propiedades de un código de configuración regional sin requerir una instancia de GT.
Ofrece información detallada, incluidos nombres visibles, códigos de región, datos de escritura y banderas emoji, todo en un objeto LocaleProperties completo.
import { getLocaleProperties } from 'generaltranslation';
const props = getLocaleProperties('fr-CA', 'en');
console.log(props.name); // "francés (Canadá)"
console.log(props.nativeName); // "français (Canada)"
console.log(props.emoji); // "🇨🇦"
console.log(props.regionCode); // "CA"Referencias
Parámetros
Prop
Type
Descripción de parámetros
| Parámetro | Descripción |
|---|---|
locale | código de configuración regional BCP-47 para el que obtener propiedades |
defaultLocale | Configuración regional para usar al localizar nombres para mostrar (predeterminado: "en") |
customMapping | Asignación personalizada opcional para códigos de configuración regional y propiedades |
Devuelve
LocaleProperties - Un objeto completo que contiene toda la información del locale:
code: código de configuración regional estandarizadoname: nombre visible en el locale predeterminadonativeName: nombre visible en el propio localelanguageCode,languageName,nativeLanguageName: información del idiomaregionCode,regionName,nativeRegionName: información de la regiónscriptCode,scriptName,nativeScriptName: información del sistema de escrituramaximizedCode,minimizedCode: formas canónicasnameWithRegionCode,nativeNameWithRegionCode: formatos combinados de visualizaciónemoji: bandera o emoji representativo
Comportamiento
Integración de mapeo personalizado
- Primero se consultan los mapeos personalizados para todas las propiedades
- Admite la resolución de alias y la sobrescritura de propiedades
- Recurre a las APIs Intl estándar para códigos sin mapeo
- Resolución canónica de locale para locales con alias
Ejemplos
import { getLocaleProperties } from 'generaltranslation';
// Nombres mostrados en inglés
const enProps = getLocaleProperties('es-MX', 'en');
console.log(enProps.name); // "Spanish (Mexico)"
console.log(enProps.languageName); // "Spanish"
console.log(enProps.regionName); // "Mexico"
console.log(enProps.emoji); // "🇲🇽"
// Nombres mostrados en francés
const frProps = getLocaleProperties('es-MX', 'fr');
console.log(frProps.name); // "espagnol (Mexique)"
console.log(frProps.languageName); // "espagnol"
console.log(frProps.regionName); // "Mexique"
// Los nombres nativos siempre están en el locale de destino
console.log(enProps.nativeName); // "español (México)"
console.log(frProps.nativeName); // "español (México)"Notas
- La función proporciona datos de locale sin instanciar la GT class
- Las propiedades de asignación personalizadas tienen prioridad sobre las Intl APIs estándar
- Siempre se devuelve la interfaz completa
LocaleProperties - Los nombres nativos siempre se calculan en el propio locale de destino
Próximos pasos
- Explora la interfaz
LocaleProperties: documentación completa de la interfaz - Usa el método de la clase GT
getLocaleProperties - Obtén nombres de locale sencillos con
getLocaleName - Obtén el emoji del locale con
getLocaleEmoji
¿Qué te parece esta guía?