# General Translation React SDKs (gt-react, gt-next, gt-react-native): getGT
URL: https://generaltranslation.com/zh/docs/react/tanstack-start/reference/functions/get-gt.mdx
Docs index: https://generaltranslation.com/llms.txt
Description: 使用 General Translation 在 TanStack Start Runtime 中翻译独立字符串。getGT 的 API 参考。

`getGT` 函数会异步为当前服务器请求或浏览器返回一个同步的字符串翻译函数。从 `gt-tanstack-start` 导入它。

## 概览 [#overview]

```ts
import { getGT } from 'gt-tanstack-start';

const gt = await getGT();
const label = gt('Submit');
```

```ts
getGT(messages?: Message[]): Promise<GTFunctionType>
```

## 参数 [#parameters]

| 参数         | 描述                                  | 类型          | 可选 | 默认 |
| ---------- | ----------------------------------- | ----------- | -- | -- |
| `messages` | 编译器提供的消息，用于在开发时为热重载预取。大多数调用方可省略此参数。 | `Message[]` | 是  | —  |

## 工作原理 [#how-it-works]

在服务器端，`getGT` 会读取由 [`gtMiddleware`](/docs/react/tanstack-start/reference/functions/gt-middleware) 创建的区域设置和国际化配置。在浏览器中，它会读取由 [`initializeGT`](/docs/react/reference/config#initialize) 初始化的条件存储。它会异步准备翻译，然后返回一个可同步翻译源字符串的函数。

在活动的 middleware 请求作用域之外进行服务器端调用会抛出错误。

## 返回 [#returns]

**类型** `Promise<(content: string, options?: GTTranslationOptions) => string>`

返回的函数接受插值变量和 [`GTTranslationOptions`](/docs/react/reference/types/inline-translation-options)，例如 `$context`、`$id` 和 `$maxChars`。

## 示例 [#example]

```ts
import { createServerFn } from '@tanstack/react-start';
import { getGT } from 'gt-tanstack-start';

export const loadTitle = createServerFn({ method: 'GET' }).handler(async () => {
  const gt = await getGT();
  return gt('账户设置');
});
```

## Sitemap

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