Utility FunctionsLocales
getLocaleProperties
スタンドアロン関数 getLocaleProperties のAPIリファレンス
概要
単体の getLocaleProperties 関数は、GT クラスのインスタンスなしでロケールコードのプロパティを取得します。
表示名、地域コード、スクリプト情報、emoji フラグなどの詳細を、包括的な LocaleProperties オブジェクトとして提供します。
import { getLocaleProperties } from 'generaltranslation';
const props = getLocaleProperties('fr-CA', 'en');
console.log(props.name); // 「フランス語（カナダ）」
console.log(props.nativeName); // 「français（Canada）」
console.log(props.emoji); // 「🇨🇦」
console.log(props.regionCode); // 「CA」リファレンス
パラメータ
Prop
Type
パラメータの説明
| Parameter | Description |
|---|---|
locale | プロパティ取得対象の BCP-47 ロケールコード |
defaultLocale | 表示名のローカライズに使用するロケール（既定は 'en'） |
customMapping | ロケールコードおよびプロパティ向けの任意のカスタムマッピング |
返り値
LocaleProperties - すべてのロケール情報を含む包括的なオブジェクト:
code: 標準化されたロケールコードname: 既定ロケールでの表示名称nativeName: 当該ロケールでの表示名称languageCode,languageName,nativeLanguageName: 言語情報regionCode,regionName,nativeRegionName: 地域情報scriptCode,scriptName,nativeScriptName: スクリプト情報maximizedCode,minimizedCode: 正規化された表記nameWithRegionCode,nativeNameWithRegionCode: 地域コード付きの表示形式emoji: 国旗または代表的なemoji
挙動
カスタムマッピングの統合
- すべてのプロパティに対して、まずカスタムマッピングを参照
- エイリアスの解決とプロパティの上書きをサポート
- マッピングされていないコードは標準の Intl APIs（国際化 API）にフォールバック
- エイリアスされたロケールの正規ロケール解決
例
import { getLocaleProperties } from 'generaltranslation';
// 英語での表示名
const enProps = getLocaleProperties('es-MX', 'en');
console.log(enProps.name); // "スペイン語（メキシコ）"
console.log(enProps.languageName); // "スペイン語"
console.log(enProps.regionName); // "メキシコ"
console.log(enProps.emoji); // "🇲🇽"
// フランス語での表示名
const frProps = getLocaleProperties('es-MX', 'fr');
console.log(frProps.name); // "espagnol (Mexique)"
console.log(frProps.languageName); // "espagnol"
console.log(frProps.regionName); // "Mexique"
// ネイティブ名は常に対象のlocaleで表示されます
console.log(enProps.nativeName); // "español (México)"
console.log(frProps.nativeName); // "español (México)"メモ
- GT クラスをインスタンス化せずに、関数で locale データを提供します
- カスタムのマッピングプロパティが、標準の Intl APIs より優先されます
- 常に完全な
LocalePropertiesインターフェースが返されます - ネイティブ名は、常にその locale 自体で計算されます
次のステップ
LocalePropertiesインターフェイス を参照 — インターフェイスの完全なドキュメント- GT クラスのメソッド
getLocalePropertiesを使用 getLocaleNameでロケールの簡易名称を取得getLocaleEmojiでロケールの emoji を取得
このガイドはどうでしたか？