# General Translation Platform: isValidLocale
URL: https://generaltranslation.com/es/docs/platform/core/reference/utility-functions/locales/is-valid-locale.mdx
Docs index: https://generaltranslation.com/llms.txt
Description: Comprueba si un valor es un código de configuración regional válido sin una instancia de GT. Referencia de la API para isValidLocale.

[`isValidLocale`](/docs/platform/core/reference/gt-class-methods/locales/is-valid-locale) es una función utilitaria independiente de la biblioteca principal de General Translation que valida si una cadena es un código de configuración regional BCP-47 válido. Valida el formato sin requerir una instancia de GT.

## Descripción general [#overview]

Importa `isValidLocale` directamente desde `generaltranslation` y llámalo con un código de configuración regional. No requiere una API key ni una instancia de [GT](/docs/platform/core/reference/gt-class/constructor). Para el equivalente basado en instancias, usa el método [`isValidLocale`](/docs/platform/core/reference/gt-class-methods/locales/is-valid-locale) de una instancia de [`GT`](/docs/platform/core/reference/gt-class/constructor).

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

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

Firma:

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

## Cómo funciona [#how-it-works]

* **Validación de formato.** Valida el formato del código de configuración regional BCP-47. Es una validación puramente de formato: no se realiza ninguna solicitud de red.
* **Mapeo personalizado.** Funciona con mapeos personalizados de configuraciones regionales, por lo que los alias definidos en un [`customMapping`](/docs/platform/core/reference/types/custom-mapping) se consideran válidos.
* **Sin estado.** Adecuado para bibliotecas utilitarias y para validar entradas de usuario.

## Parámetros [#parameters]

| Parámetro                          | Descripción                                                         | Tipo                                                                  | Opcional | Predeterminado |
| ---------------------------------- | ------------------------------------------------------------------- | --------------------------------------------------------------------- | -------- | -------------- |
| [`locale`](#locale)                | El valor que se validará.                                           | `string`                                                              | No       | —              |
| [`customMapping`](#custom-mapping) | Mapeo personalizado que se tendrá en cuenta durante la validación. | [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping) | Sí       | —              |

### `locale` [#locale]

**Tipo** `string` · **Obligatorio**

El valor que se va a validar como un código de configuración regional BCP-47.

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

**Tipo** [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping) · **Opcional**

Un mapeo personalizado opcional cuyos alias se tratan como válidos.

## Returns [#returns]

**Type** `boolean`

`true` si el código de configuración regional es válido; `false` en caso contrario.

## Ejemplos [#examples]

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

// Códigos de configuración regional válidos
console.log(isValidLocale('en-US')); // true
console.log(isValidLocale('zh-CN')); // true
console.log(isValidLocale('es')); // true

// Códigos de configuración regional inválidos
console.log(isValidLocale('invalid')); // false
console.log(isValidLocale('en_US')); // false (guion bajo en lugar de guion medio)
console.log(isValidLocale('')); // false
```

## Notas [#notes]

* Valida el formato del código de configuración regional BCP-47.
* Funciona con mapeos personalizados de configuración regional.
* Esencial para validar entradas de usuario.
* No realiza solicitudes de red; solo valida el formato.
* Función sin estado adecuada para bibliotecas de utilidades.

## Sitemap

See the full [sitemap](https://generaltranslation.com/sitemap.md) for all pages.