Utility FunctionsLocales

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ámetroDescripción
localecódigo de configuración regional BCP-47 para el que obtener propiedades
defaultLocaleConfiguración regional para usar al localizar nombres para mostrar (predeterminado: "en")
customMappingAsignació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 estandarizado
  • name: nombre visible en el locale predeterminado
  • nativeName: nombre visible en el propio locale
  • languageCode, languageName, nativeLanguageName: información del idioma
  • regionCode, regionName, nativeRegionName: información de la región
  • scriptCode, scriptName, nativeScriptName: información del sistema de escritura
  • maximizedCode, minimizedCode: formas canónicas
  • nameWithRegionCode, nativeNameWithRegionCode: formatos combinados de visualización
  • emoji: 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

¿Qué te parece esta guía?