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

title: TranslationResult
description: Результат успешного выполнения или ошибки, возвращаемый методами перевода General Translation. Справочник API для типа TranslationResult.

---

Результат метода перевода, такого как [`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]

**Type** `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 доступны
}
```