# generaltranslation: General Translation Core SDK: formatRelativeTime
URL: https://generaltranslation.com/es/docs/core/class/methods/formatting/format-relative-time.mdx
---
title: formatRelativeTime
description: Referencia de la API del método formatRelativeTime para formatear valores de tiempo relativo
---

## Descripción general

El método `formatRelativeTime` formatea un valor de tiempo relativo con una unidad explícita según las convenciones de la configuración regional.

```typescript
const gt = new GT();
const formatted = gt.formatRelativeTime(-1, 'day', {
  locales: 'en-US',
  numeric: 'auto'
});
// Devuelve: "yesterday"
```


## Referencia

### Parámetros

| Nombre     | Tipo                          | Descripción                                                                                    |
| ---------- | ----------------------------- | ---------------------------------------------------------------------------------------------- |
| `value`    | `number`                      | El valor relativo de tiempo (negativo para el pasado, positivo para el futuro)                 |
| `unit`     | `Intl.RelativeTimeFormatUnit` | La unidad de tiempo (`'second'`, `'minute'`, `'hour'`, `'day'`, `'week'`, `'month'`, `'year'`) |
| `options?` | `object`                      | Configuración de formato                                                                       |

### Opciones

| Nombre           | Tipo                            | Descripción                                                                                                                                          |
| ---------------- | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `locales?`       | `string \| string[]`            | Configuraciones regionales para el formato. Si no se especifica, se usan como respaldo las configuraciones regionales de renderizado de la instancia |
| `numeric?`       | `'always' \| 'auto'`            | Indica si siempre se debe usar una salida numérica. El valor predeterminado es `'auto'`                                                              |
| `style?`         | `'long' \| 'short' \| 'narrow'` | La longitud de la salida. El valor predeterminado es `'long'`                                                                                        |
| `localeMatcher?` | `'best fit' \| 'lookup'`        | El algoritmo de coincidencia de configuración regional que se debe usar                                                                              |

### Devuelve

`string` - La cadena de tiempo relativo formateada.

***

## Ejemplo

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

// Tiempo pasado
gt.formatRelativeTime(-2, 'hour', { locales: 'en-US' });
// Devuelve: "2 hours ago"

// Tiempo futuro
gt.formatRelativeTime(3, 'day', { locales: 'fr-FR' });
// Devuelve: "dans 3 jours"

// Con numeric: 'auto' (predeterminado)
gt.formatRelativeTime(-1, 'day', { locales: 'en-US' });
// Devuelve: "yesterday"
```

***

## Notas

* El valor predeterminado es `numeric: 'auto'` y `style: 'long'`
* Utiliza [`Intl.RelativeTimeFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/RelativeTimeFormat) internamente

## Siguientes pasos

* Consulta [`formatRelativeTimeFromDate`](/docs/core/class/methods/formatting/format-relative-time-from-date) para seleccionar automáticamente la unidad a partir de un objeto `Date`
* Consulta la función autónoma [`formatRelativeTime`](/docs/core/functions/formatting/format-relative-time) para usarla sin una instancia de GT