# gt-next: General Translation Next.js SDK: isLocaleSupported
URL: https://generaltranslation.com/ru/docs/next/api/helpers/is-locale-supported.mdx
---
title: isLocaleSupported
description: Справочник по API серверного метода isLocaleSupported
---

## Обзор

Функция `isLocaleSupported` проверяет, является ли локаль допустимой и поддерживается ли она текущей конфигурацией `gt-next` в вашем приложении.

Используйте её, если параметр маршрута или другое входное значение запроса нужно явно отклонить, а не неявно переключаться на локаль по умолчанию. Распространённый паттерн — проверять сегмент `[locale]` в динамическом маршруте и вызывать `notFound()`, если значение не поддерживается.

<Callout>
  `isLocaleSupported` — серверный метод, и его можно использовать только в
  серверных компонентах.
</Callout>

## Справочник

### Параметры

<TypeTable
  type={{
  "locale": {
      type: 'unknown',
      optional: false,
  },
}}
/>

| Имя      | Описание                                                                                                                                          |
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `locale` | Кандидат локали для проверки. Допустимо любое значение; если значение не является строкой или содержит недопустимый BCP 47, возвращается `false`. |

### Возвращает

Значение типа `boolean`: `true`, если локаль соответствует одной из настроенных локалей, и `false` — в противном случае.

Также служит предикатом типа в TypeScript (`locale is string`), сужая тип значения до `string`, если возвращает `true`.

***

## Примеры

### Отклонение недопустимых параметров маршрута

Проверяйте параметр маршрута `[locale]` и вызывайте `notFound()` для неподдерживаемых локалей, а не полагайтесь на резервный вариант для локали по умолчанию.

```tsx title="app/[locale]/page.tsx" copy
import { notFound } from 'next/navigation';
import { isLocaleSupported } from 'gt-next/server';

export default async function Page({
  params,
}: {
  params: Promise<{ locale: string }>;
}) {
  const { locale } = await params;

  if (!isLocaleSupported(locale)) {
    notFound(); // [!code highlight]
  }

  return <p>Locale: {locale}</p>;
}
```

***

## Примечания

* `isLocaleSupported` работает только на серверной стороне.
* Без этой проверки недопустимая или неподдерживаемая локаль запроса приведёт к использованию локали по умолчанию, а не к выбросу ошибки. О резервном поведении см. [`getLocale`](/docs/next/api/helpers/get-locale).
* Набор поддерживаемых локалей настраивается в [`withGTConfig`](/docs/next/api/config/with-gt-config). См. также [`gt.config.json`](/docs/next/api/config/gt-config-json).

## Следующие шаги

* См. [`getLocale`](/docs/next/api/helpers/get-locale), чтобы узнать текущую локаль пользователя.
* Узнайте, как настроить поддерживаемые локали с помощью [`withGTConfig()`](/docs/next/api/config/with-gt-config).