Utility FunctionsLocales
isValidLocale
isValidLocale 関数のAPIリファレンス
概要
isValidLocale 関数は、指定した文字列が有効な BCP-47 のロケールコードかどうかを検証します。GT クラスのインスタンスを必要とせず、包括的な形式検証を行います。
リファレンス
パラメータ
Prop
Type
戻り値
boolean - ロケールコードが有効なら true、それ以外は false
例
import { isValidLocale } from 'generaltranslation';
// 有効なロケールコード
console.log(isValidLocale('en-US')); // true
console.log(isValidLocale('zh-CN')); // true
console.log(isValidLocale('es')); // true
// 無効なロケールコード
console.log(isValidLocale('invalid')); // false
console.log(isValidLocale('en_US')); // false（ハイフンではなくアンダースコア）
console.log(isValidLocale('')); // false注意事項
- BCP-47 のロケールコード形式を検証します
- カスタムのロケールマッピングに対応します
- ユーザー入力のバリデーションに不可欠です
- ネットワークリクエスト不要 — 形式のみを検証する純粋なバリデーション
- ユーティリティライブラリに適したステートレス関数です
次のステップ
- GT クラスのメソッド
isValidLocaleを使う standardizeLocaleでフォーマットを標準化する
このガイドはどうでしたか？