# node: getLocaleProperties
URL: https://generaltranslation.com/ja/docs/node/api/get-locale-properties.mdx
---
title: getLocaleProperties
description: getLocaleProperties 関数のAPIリファレンス
---

## 概要

`getLocaleProperties` 関数は、指定したロケールに関するメタデータを返します。これには、名前、ネイティブ名、言語、地域、スクリプトの情報が含まれます。

```js
import { getLocaleProperties } from 'gt-node';

const props = getLocaleProperties('en-US');
console.log(props.name); // 'アメリカ英語'
```


## リファレンス

### パラメータ

| パラメータ    | 型        | 説明                                                                 |
| -------- | -------- | ------------------------------------------------------------------ |
| `locale` | `string` | BCP 47 形式のロケールコード (例: `'en-US'`, `'ja'`) 。指定しない場合は、現在のロケールが使用されます。 |

### 戻り値

以下のフィールドを含む `LocaleProperties` オブジェクトを返します。

| フィールド                      | 型        | 説明                                        |
| -------------------------- | -------- | ----------------------------------------- |
| `code`                     | `string` | ロケールコード (例: `'en-US'`) 。                  |
| `name`                     | `string` | ロケールの英語名 (例: `'American English'`) 。      |
| `nativeName`               | `string` | ロケール自身の言語での名称 (例: `'American English'`) 。 |
| `languageCode`             | `string` | 言語サブタグ (例: `'en'`) 。                      |
| `languageName`             | `string` | 言語の英語名 (例: `'English'`) 。                 |
| `nativeLanguageName`       | `string` | その言語での言語名 (例: `'English'`) 。              |
| `nameWithRegionCode`       | `string` | 地域を含むロケール名 (例: `'English (US)'`) 。        |
| `nativeNameWithRegionCode` | `string` | 地域を含む、そのロケール自身の言語でのロケール名。                 |
| `regionCode`               | `string` | 地域サブタグ (例: `'US'`) 。                      |
| `regionName`               | `string` | 地域の英語名 (例: `'United States'`) 。           |
| `nativeRegionName`         | `string` | ロケール自身の言語での地域名。                           |
| `scriptCode`               | `string` | スクリプトサブタグ (例: `'Latn'`) 。                  |
| `scriptName`               | `string` | スクリプトの英語名 (例: `'Latin'`) 。                 |
| `nativeScriptName`         | `string` | ロケール自身の言語でのスクリプト名。                         |
| `maximizedCode`            | `string` | 完全に展開されたロケールコード (例: `'en-Latn-US'`) 。     |

***

## 例

### 基本的な使い方

```js title="handler.js"
import { getLocaleProperties } from 'gt-node';

app.get('/api/locale-info', (req, res) => {
  const props = getLocaleProperties('ja');
  res.json({
    name: props.name,           // 'Japanese'
    nativeName: props.nativeName, // '日本語'
    script: props.scriptName,   // 'Japanese'
  });
});
```

***


## 注記

* この関数は同期関数なので、`await` は不要です。
* ロケールセレクターを作成したり、ユーザーにロケールのメタデータを表示したりする際に便利です。

## 次のステップ

* 現在のリクエストのロケールについては、[`getLocale`](/docs/node/api/get-locale)を参照してください。
* [ロケールコード](/docs/core/locales)の詳細については、こちらを参照してください。