GT ClassMethodsLocales

getLocaleName

GT の getLocaleName メソッドのAPIリファレンス

概要

getLocaleName メソッドは、Intl.DisplayNames API を用いてロケールコードの表示名を取得します。 有効な BCP-47 ロケールコードに対して、人が読める名称を返し、インスタンスのソースロケールに合わせてローカライズされます。

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

const name = gt.getLocaleName('fr-CA');
console.log(name); // "フランス語(カナダ)"

リファレンス

パラメータ

Prop

Type

パラメーターの説明

パラメーター説明
locale表示名を取得するための BCP-47 のロケールコード。未指定の場合は、インスタンスの targetLocale を使用します

戻り値

string - locale のローカライズされた表示名称。

例外

  • Error - locale が指定されておらず、かつインスタンスに targetLocale が設定されていない場合

挙動

表示言語

表示名は次の優先順でローカライズされます:

  1. インスタンスの sourceLocale(設定されている場合)
  2. ライブラリの既定の locale('en')

カスタムマッピングの統合

  • カスタムのlocaleマッピングが最初に確認されます
  • カスタムの名称が定義されている場合は、それが優先されます
  • 標準の BCP-47 コードは Intl.DisplayNames にフォールバックします

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

// ターゲットロケールの名称を取得
console.log(gt.getLocaleName()); // "French (France)"

// 他のロケールの名称を取得
console.log(gt.getLocaleName('es')); // "Spanish (Spain)"
console.log(gt.getLocaleName('de')); // "German (Germany)"
console.log(gt.getLocaleName('ja')); // "Japanese (Japan)"

注意事項

  • このメソッドはインスタンスの sourceLocale を使用して表示言語を決定します
  • カスタムのマッピング名は、標準の Intl.DisplayNames よりも優先されます

次のステップ

このガイドはどうでしたか?

getLocaleName