# generaltranslation: General Translation Core SDK: formatRelativeTime
URL: https://generaltranslation.com/ru/docs/core/class/methods/formatting/format-relative-time.mdx
---
title: formatRelativeTime
description: Справка по API для метода formatRelativeTime, предназначенного для форматирования значений относительного времени
---

## Обзор

Метод `formatRelativeTime` форматирует значение относительного времени с явно указанной единицей времени в соответствии с правилами, принятыми в данной локали.

```typescript
const gt = new GT();
const formatted = gt.formatRelativeTime(-1, 'day', {
  locales: 'en-US',
  numeric: 'auto'
});
// Возвращает: "yesterday"
```

## Справка

### Параметры

| Имя        | Тип                           | Описание                                                                                     |
| ---------- | ----------------------------- | -------------------------------------------------------------------------------------------- |
| `value`    | `number`                      | Значение относительного времени (отрицательное — для прошлого, положительное — для будущего) |
| `unit`     | `Intl.RelativeTimeFormatUnit` | Единица времени (`'second'`, `'minute'`, `'hour'`, `'day'`, `'week'`, `'month'`, `'year'`)   |
| `options?` | `object`                      | Конфигурация форматирования                                                                  |

### Параметры

| Имя              | Тип                             | Описание                                                                           |
| ---------------- | ------------------------------- | ---------------------------------------------------------------------------------- |
| `locales?`       | `string \| string[]`            | Локали для форматирования. По умолчанию используются локали рендеринга экземпляра  |
| `numeric?`       | `'always' \| 'auto'`            | Определяет, всегда ли использовать числовой формат вывода. По умолчанию — `'auto'` |
| `style?`         | `'long' \| 'short' \| 'narrow'` | Длина вывода. По умолчанию — `'long'`                                              |
| `localeMatcher?` | `'best fit' \| 'lookup'`        | Алгоритм сопоставления локалей                                                     |

### Возвращает

`string` - Отформатированная строка относительного времени.

***

## Пример

```typescript copy
import { GT } from 'generaltranslation';
const gt = new GT();

// Прошедшее время
gt.formatRelativeTime(-2, 'hour', { locales: 'en-US' });
// Returns: "2 hours ago"

// Будущее время
gt.formatRelativeTime(3, 'day', { locales: 'fr-FR' });
// Returns: "dans 3 jours"

// С numeric: 'auto' (по умолчанию)
gt.formatRelativeTime(-1, 'day', { locales: 'en-US' });
// Returns: "yesterday"
```

***

## Примечания

* По умолчанию используются `numeric: 'auto'` и `style: 'long'`
* Внутри используется [`Intl.RelativeTimeFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/RelativeTimeFormat)

## Следующие шаги

* См. [`formatRelativeTimeFromDate`](/docs/core/class/methods/formatting/format-relative-time-from-date), чтобы единица времени автоматически выбиралась на основе `Date`
* См. автономную функцию [`formatRelativeTime`](/docs/core/functions/formatting/format-relative-time), чтобы использовать её без экземпляра GT