# node: getGT
URL: https://generaltranslation.com/ja/docs/node/api/get-gt.mdx
---
title: getGT
description: 文字列を翻訳する getGT 関数のAPIリファレンス
---

## 概要

`getGT` 関数は、文字列を翻訳するための翻訳関数を返す非同期関数です。
GT コンパイラによってビルド時に登録された翻訳を解決します。

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

const gt = await getGT();
const greeting = gt('Hello, world!');
```

<Callout>
  **リクエストコンテキストが必要です:**
  `getGT` は、どのロケールを使用するかを判断できるよう、[`withGT`](/docs/node/api/with-gt) のコールバック内で呼び出す必要があります。
</Callout>


## リファレンス

### パラメーター

ありません。

### 戻り値

翻訳関数 `gt` を返す Promise:

```ts
Promise<(content: string, options?: InlineTranslationOptions) => string>
```

| Name       | Type                       | Description                  |
| ---------- | -------------------------- | ---------------------------- |
| `content`  | `string`                   | 翻訳する文字列。                     |
| `options?` | `InlineTranslationOptions` | 省略可能な翻訳オプション (変数、コンテキストなど) 。 |

`gt` 関数は、翻訳された文字列を返します。翻訳が見つからない場合は、元の文字列を返します。


#### `InlineTranslationOptions`

| Prop         | Type     | Description                |
| ------------ | -------- | -------------------------- |
| `$context?`  | `string` | 訳の曖昧さを避けるための追加コンテキスト。      |
| `$id?`       | `string` | 翻訳エントリのカスタム ID。            |
| `$maxChars?` | `number` | 翻訳の最大文字数。                  |
| Other keys   | `any`    | `{key}` 構文を使って文字列に埋め込む変数値。 |

***

## 例

### 基本的な翻訳

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

function handleRequest(locale: string) {
  return withGT(locale, async () => {
    const gt = await getGT();
    return gt('Hello, world!');
  });
}
```


### 変数を使う場合

文字列内で `{variableName}` 構文を使い、options オブジェクトに値を渡します。

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

function handleGreeting(locale: string, name: string) {
  return withGT(locale, async () => {
    const gt = await getGT();
    return gt('Hello, {name}!', { name });
  });
}
```


### ICU メッセージフォーマットを使用する場合

`gt-node` は、高度なフォーマットに対応するため、ICU メッセージフォーマットをサポートしています。

```js title="handler.js"
const gt = await getGT();
const balance = gt(
  'Your balance: {amount, number, ::currency/USD}',
  { amount: 1234.56 }
);
```

***


## 注意事項

* `getGT` は**ビルド時**の翻訳関数を返します。文字列はデプロイ前の CD プロセス中に翻訳されます。
* 開発環境では、翻訳は必要に応じて行われます (Dev API キーが必要です) 。
* 翻訳が見つからない場合は、フォールバックとして元の文字列が返されます。

## 次のステップ

* 事前登録済みメッセージの解決については、[`getMessages`](/docs/node/api/get-messages)を参照してください。
* ロケールコンテキストの設定については、[`withGT`](/docs/node/api/with-gt)を参照してください。