# gt-next: General Translation Next.js SDK: isLocaleSupported
URL: https://generaltranslation.com/ja/docs/next/api/helpers/is-locale-supported.mdx
---
title: isLocaleSupported
description: isLocaleSupported サーバーサイドのメソッドのAPIリファレンス
---

## 概要

`isLocaleSupported` 関数は、ロケールが有効で、現在のアプリの gt-next 設定でサポートされているかどうかを確認します。

ルートパラメータなどのリクエスト入力に対して、デフォルトロケールへ暗黙的にフォールバックするのではなく、明示的に拒否したい場合に使用します。一般的には、動的ルートの `[locale]` セグメントを検証し、その値がサポートされていない場合は `notFound()` を呼び出します。

<Callout>
  `isLocaleSupported` はサーバーサイドのメソッドであり、
  サーバーサイドコンポーネントでのみ使用できます。
</Callout>

## リファレンス

### パラメーター

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

| 名前       | 説明                                                                    |
| -------- | --------------------------------------------------------------------- |
| `locale` | 検証対象のロケール候補です。任意の値を受け付けますが、文字列以外の値、または無効な BCP 47 値の場合は `false` を返します。 |

### 戻り値

ロケールが設定済みのロケールのいずれかに解決される場合は `true`、それ以外の場合は `false` となる `boolean` です。

また、TypeScript の型ガード (`locale is string`) としても機能し、`true` を返した場合は値が `string` に絞り込まれます。

***

## 例

### 無効なルートパラメータを拒否する

`[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)を使って、サポートされているロケールを設定する方法を確認してください。