Utility FunctionsLocales

getRegionProperties

getRegionProperties 函数的 API 参考

概览

getRegionProperties 函数无需 GT class 实例即可获取区域代码的详细信息。


参考资料

参数说明

Prop

Type

返回

{ code: string; name: string; emoji: string } - 地区信息对象


示例

import { getRegionProperties } from 'generaltranslation';

// 获取英文名称的地区属性
console.log(getRegionProperties('US', 'en-US'));
// { code: 'US', name: 'United States', emoji: '🇺🇸' }

console.log(getRegionProperties('JP', 'en-US'));
// { code: 'JP', name: 'Japan', emoji: '🇯🇵' }

// 获取本地化名称的地区属性
console.log(getRegionProperties('US', 'de-DE'));
// { code: 'US', name: 'Vereinigte Staaten', emoji: '🇺🇸' }

备注

  • 使用 Intl.DisplayNames API 获取本地化地区名称
  • 支持 ISO 3166-1 alpha-2 与 UN M.49 地区代码
  • 可通过自定义映射覆盖默认名称和 emoji
  • 若显示名称解析失败,将回退为地区代码
  • 除浏览器 API 外无其他外部依赖

下一步

这份指南怎么样?

getRegionProperties