# generaltranslation: General Translation Core SDK: isValidLocale
URL: https://generaltranslation.com/zh/docs/core/functions/locales/is-valid-locale.mdx
---
title: isValidLocale
description: isValidLocale 函数的 API 参考文档
---

## 概述

`isValidLocale` 函数用于验证给定字符串是否为有效的 BCP-47 区域设置代码。它会执行全面的格式校验，无需 GT 类实例。

***

## 参考文档

### 参数

<TypeTable
  type={{
  "locale": {
    type: 'string',
    optional: false,
  },
  "customMapping?": {
    type: 'CustomMapping',
    optional: true,
  }
}}
/>

### 返回值

`boolean` - 如果区域设置代码有效，则返回 `true`；否则返回 `false`

***

## 示例

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

***


## 注意事项

* 验证 BCP-47 区域设置代码的格式
* 支持自定义区域设置映射
* 对用户输入校验至关重要
* 不会发起网络请求，仅进行格式校验
* 无状态函数，适合用于工具库

## 后续步骤

* 使用 GT 类的 [`isValidLocale`](/docs/core/class/methods/locales/is-valid-locale) 方法
* 使用 [`standardizeLocale`](/docs/core/functions/locales/standardize-locale) 统一格式