# General Translation Platform: isValidLocale
URL: https://generaltranslation.com/ja/docs/platform/core/reference/utility-functions/locales/is-valid-locale.mdx
---

title: isValidLocale
description: GT インスタンスなしで、値が有効なロケールコードかどうかを確認します。isValidLocale の API リファレンス。

---

[`isValidLocale`](/docs/platform/core/reference/gt-class-methods/locales/is-valid-locale) は、文字列が有効な BCP-47 ロケールコードかどうかを検証する、General Translation の Core ライブラリに含まれるスタンドアロンのユーティリティ関数です。GT インスタンスを必要とせず、形式のみを検証します。

## 概要 [#overview]

`generaltranslation` から `isValidLocale` を直接インポートし、ロケールコードを引数として呼び出します。これに API キー や [GT](/docs/platform/core/reference/gt-class/constructor) インスタンスは必要ありません。インスタンスベースの同等の機能を使う場合は、代わりに [`GT`](/docs/platform/core/reference/gt-class/constructor) インスタンスの [`isValidLocale`](/docs/platform/core/reference/gt-class-methods/locales/is-valid-locale) メソッドを使用してください。

```typescript
import { isValidLocale } from 'generaltranslation';

console.log(isValidLocale('en-US')); // true
console.log(isValidLocale('invalid')); // false
```

シグネチャ:

```typescript
isValidLocale(locale: string, customMapping?: CustomMapping): boolean
```

## 仕組み [#how-it-works]

* **形式の検証。** BCP-47 のロケールコード形式を検証します。これは形式のみを対象とした検証で、ネットワークリクエストは発生しません。
* **カスタムマッピング。** カスタムのロケールマッピングに対応しているため、[`customMapping`](/docs/platform/core/reference/types/custom-mapping) で定義されたエイリアスも有効と見なされます。
* **ステートレス。** ユーティリティライブラリやユーザー入力の検証に適しています。

## パラメータ [#parameters]

| パラメータ                              | 説明                 | 型                                                                     | 任意  | デフォルト |
| ---------------------------------- | ------------------ | --------------------------------------------------------------------- | --- | ----- |
| [`locale`](#locale)                | 検証対象の値。            | `string`                                                              | いいえ | —     |
| [`customMapping`](#custom-mapping) | 検証時に考慮するカスタムマッピング。 | [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping) | はい  | —     |

### `locale` [#locale]

**型** `string` · **必須**

BCP-47 のロケールコードとして検証する値です。

### `customMapping` [#custom-mapping]

**型** [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping) · **任意**

エイリアスを有効なものとして扱うための、省略可能なカスタムマッピングです。

## 戻り値 [#returns]

**Type** `boolean`

ロケールコードが有効であれば`true`、そうでなければ`false`です。

## 例 [#examples]

```typescript
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
```

## メモ [#notes]

* BCP-47のロケールコード形式を検証します。
* カスタムのロケールマッピングでも動作します。
* ユーザー入力の検証に不可欠です。
* ネットワークリクエストは発生せず、形式のみを検証します。
* ユーティリティライブラリに適したステートレスな関数です。