GT ClassMethodsLocales

isValidLocale

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

概要

isValidLocale メソッドは、ロケールコードが正しい形式で記述され、有効な BCP-47 のロケールとして認識されるかを検証します。 Intl API を用いてロケールの構造、言語の判別、地域・スクリプトの妥当性を確認し、カスタムのロケールマッピングにも対応します。


参考

パラメータ

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 ロケールの包括的な検証を行います
  • カスタムマッピングの対応ロケールは常に true と判定されます(標準の検証をスキップ)
  • 私用(private-use)の言語コード(qaa-qtz)をサポートします
  • 形式不正または認識できないロケールコードの場合は false を返します

次のステップ

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

isValidLocale