GT ClassMethodsLocales

resolveCanonicalLocale

Referencia de API del método resolveCanonicalLocale de GT

Descripción general

En el contexto de alias para locales (p. ej., cn -> zh), el método resolveCanonicalLocale convierte los códigos de configuración regional alias en sus códigos BCP-47 canónicos cuando se configura un mapeo personalizado.


Referencias

Parámetros

Prop

Type

Descripción de parámetros

ParámetroDescripción
localeEl código de configuración regional alias que se resolverá a su forma canónica. Si no se proporciona, usa el targetLocale de la instancia
customMappingMapeo personalizado opcional para usar en lugar del mapeo de la instancia

Devuelve

string - El código de configuración regional BCP-47 canónico si existe un mapeo; de lo contrario, el código de configuración regional original

Excepciones

  • Error - Si no se proporciona ninguna locale y la instancia no tiene targetLocale configurado

Ejemplos

const gt = new GT({
  sourceLocale: 'en',
  customMapping: {
    'cn': { code: 'zh', name: 'Mandarin' },
  }
});

// Convertir alias a locale canónico
const canonical = gt.resolveCanonicalLocale('cn');
console.log(canonical); // "zh"

// Los códigos BCP-47 regulares se mantienen sin cambios
const unchanged = gt.resolveCanonicalLocale('fr-FR');
console.log(unchanged); // "fr-FR"

Notas

  • Convierte códigos de configuración regional alias en códigos de configuración regional canónicos BCP-47
  • Devuelve el código de configuración regional original si no existe un mapeo personalizado
  • Funciona con la configuración customMapping del constructor de GT
  • No se realiza ninguna validación de los códigos de configuración regional de entrada o salida

Próximos pasos

¿Qué te ha parecido esta guía?

resolveCanonicalLocale