Utility FunctionsLocales

getLocaleProperties

Referencia de API de la función autónoma 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 la clase GT. Proporciona información detallada, incluidos nombres para mostrar, códigos de región, datos de escritura (script) y banderas de emoji, dentro de un objeto completo LocaleProperties.

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"

Referencia

Parámetros

Prop

Type

Descripción de parámetros

ParámetroDescripción
localeCódigo de configuración regional BCP-47 para obtener propiedades
defaultLocaleConfiguración regional para localizar los nombres para mostrar (valor predeterminado: 'en')
customMappingAsignación personalizada opcional para códigos de configuración regional y sus propiedades

Devuelve

LocaleProperties - Un objeto exhaustivo que contiene toda la información de la configuración regional:

  • code: Código de configuración regional estandarizado
  • name: Nombre visible en la configuración regional predeterminada
  • nativeName: Nombre visible en la propia configuración regional
  • 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 de visualización combinados
  • emoji: Bandera o emoji representativo

Comportamiento

Integración de mapeos personalizados

  • Los mapeos personalizados se evalúan primero para todas las propiedades
  • Admite la resolución de alias y la sobrescritura de propiedades
  • Recurre a las Intl APIs estándar para los códigos sin mapeo
  • Resolución de locale canónico para locales con alias

Ejemplos

import { getLocaleProperties } from 'generaltranslation';

// Nombres en inglés para mostrar
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 en francés para mostrar
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 LocaleProperties completa
  • Los nombres nativos siempre se calculan en el propio locale de destino

Próximos pasos

¿Qué te ha parecido esta guía?

getLocaleProperties