GT ClassMethodsLocales

isValidLocale

GT isValidLocale 方法的 API 参考

概览

isValidLocale 方法用于验证语言代码的格式是否正确,并确认其是否为有效的 BCP-47 locale。 它借助 Intl API 检查 locale 结构、语言识别,以及区域/脚本的有效性,并支持自定义 locale 映射。


参考资料

参数

Prop

Type

参数说明

参数说明
locale要验证的 BCP-47 语言代码。若未提供,则使用该实例的 targetLocale
customMapping可选的自定义映射,用于检查额外的有效语言环境。若未提供,则使用该实例的 customMapping

返回值

boolean - 如果该 locale 有效,则返回 true,否则返回 false

抛出

  • Error - 如果未提供 locale,且该实例未配置 targetLocale

示例

const gt = new GT({
  sourceLocale: 'en',
  targetLocale: 'es'
});

const isValid = gt.isValidLocale('en-US');
console.log(isValid); // true

const isInvalid = gt.isValidLocale('invalid-locale');
console.log(isInvalid); // false

注意事项

  • 使用浏览器 Intl APIs 进行全面的 BCP-47 locale 验证
  • 自定义映射的 locales 始终视为通过(跳过标准验证)
  • 支持私有用途语言代码(qaa–qtz)
  • 对格式错误或无法识别的语言代码返回 false

下一步

本指南如何?