# General Translation Platform: TranslationResult
URL: https://generaltranslation.com/zh/docs/platform/core/reference/types/translation-result.mdx
---

title: TranslationResult
description: General Translation 翻译方法返回的成功或错误结果。TranslationResult 类型的 API 参考。

---

诸如 [`translate`](/docs/platform/core/reference/gt-class-methods/translation/translate) 或 [`translateMany`](/docs/platform/core/reference/gt-class-methods/translation/translate-many) 之类的翻译方法所返回的结果。它是一种可辨别联合类型，包含成功结果和错误结果两种情况。

## 概述 [#overview]

`TranslationResult` 是一个由 `success` 布尔值区分的联合类型。可根据 `success` 进行类型收窄，从而访问翻译结果或错误信息。

```typescript
type TranslationResult = RequestSuccess | TranslationError;
```

## 成员 [#members]

| 成员                                       | 描述                  | 类型       |
| ---------------------------------------- | ------------------- | -------- |
| [`RequestSuccess`](#request-success)     | 翻译成功，包含翻译后的内容和区域设置。 | `object` |
| [`TranslationError`](#translation-error) | 翻译失败，包含错误消息和状态码。    | `object` |

### `RequestSuccess` [#request-success]

**类型** `object`

当 `success` 为 `true` 时返回。包含已翻译的内容以及解析后的目标 `区域设置`。

```typescript
type RequestSuccess = TypedResult & {
  success: true;
  locale: string; // 解析后的目标区域设置
};
```

### `TranslationError` [#translation-error]

**类型** `object`

当 `success` 为 `false` 时返回。包含便于理解的 `error` 错误消息和数字类型的 `code`。

```typescript
type TranslationError = {
  success: false;
  error: string; // 错误信息
  code: number; // 状态码
};
```

## 示例 [#example]

```typescript
import { GT } from 'generaltranslation';
import { TranslationResult } from 'generaltranslation/types';

const gt = new GT({ apiKey: 'your-api-key', projectId: 'your-project-id' });

const result: TranslationResult = await gt.translate('Hello', 'es');

if (result.success) {
  console.log(`Translation: ${result.translation}`); // result.translation 和 result.locale 可用
} else {
  console.error(`Translation failed: ${result.error} (${result.code})`); // result.error 和 result.code 可用
}
```