# General Translation React SDKs (gt-react, gt-next, gt-react-native): getLocale
URL: https://generaltranslation.com/zh/docs/react/tanstack-start/reference/functions/get-locale.mdx
---

title: getLocale
description: 使用 General Translation 读取当前 TanStack Start 服务器请求的区域设置。getLocale 的 API 参考。

---

`getLocale` 函数会返回与当前服务器请求关联的区域设置代码，采用 BCP 47 格式。请从 `gt-tanstack-start/server` 导入。

## 概览 [#overview]

```ts
import { getLocale } from 'gt-tanstack-start/server';

const locale = getLocale(); // 'en-US'
```

```ts
getLocale(): string
```

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

`getLocale` 会读取由 [`gtMiddleware`](/docs/react/tanstack-start/reference/functions/gt-middleware) 创建的请求级局部值。该中间件会从已配置的 cookie 和请求头中解析区域设置，然后回退到默认区域设置。

该函数是同步的；如果在当前中间件请求作用域之外调用，则会抛出错误。

## 返回值 [#returns]

**类型** `string`

当前请求的区域设置。

## 示例 [#example]

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

export const loadLocale = createServerFn({ method: 'GET' }).handler(() => {
  return getLocale();
});
```