# generaltranslation: General Translation Core SDK: formatRelativeTime
URL: https://generaltranslation.com/fr/docs/core/class/methods/formatting/format-relative-time.mdx
---
title: formatRelativeTime
description: Référence de l’API pour la méthode formatRelativeTime, qui met en forme des valeurs de temps relatif
---

## Vue d’ensemble

La méthode `formatRelativeTime` formate une valeur de temps relatif avec une unité explicite, conformément aux conventions propres au paramètre régional.

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


## Référence

### Paramètres

| Nom        | Type                          | Description                                                                                 |
| ---------- | ----------------------------- | ------------------------------------------------------------------------------------------- |
| `value`    | `number`                      | La valeur temporelle relative (négative pour le passé, positive pour le futur)              |
| `unit`     | `Intl.RelativeTimeFormatUnit` | L’unité de temps (`'second'`, `'minute'`, `'hour'`, `'day'`, `'week'`, `'month'`, `'year'`) |
| `options?` | `object`                      | Configuration du formatage                                                                  |

### Options

| Nom              | Type                            | Description                                                                                                |
| ---------------- | ------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `locales?`       | `string \| string[]`            | Paramètres régionaux pour le formatage. Utilise par défaut les paramètres régionaux de rendu de l’instance |
| `numeric?`       | `'always' \| 'auto'`            | Indique s’il faut toujours utiliser un résultat numérique. La valeur par défaut est `'auto'`               |
| `style?`         | `'long' \| 'short' \| 'narrow'` | La longueur du résultat. La valeur par défaut est `'long'`                                                 |
| `localeMatcher?` | `'best fit' \| 'lookup'`        | L’algorithme de correspondance des paramètres régionaux à utiliser                                         |

### Renvoie

`string` - La chaîne de caractères contenant le temps relatif formaté.

***

## Exemple

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

// Past time
gt.formatRelativeTime(-2, 'hour', { locales: 'en-US' });
// Returns: "2 hours ago"

// Future time
gt.formatRelativeTime(3, 'day', { locales: 'fr-FR' });
// Returns: "dans 3 jours"

// With numeric: 'auto' (default)
gt.formatRelativeTime(-1, 'day', { locales: 'en-US' });
// Returns: "yesterday"
```

***

## Remarques

* Utilise par défaut `numeric: 'auto'` et `style: 'long'`
* Utilise [`Intl.RelativeTimeFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/RelativeTimeFormat) en arrière-plan

## Étapes suivantes

* Consultez [`formatRelativeTimeFromDate`](/docs/core/class/methods/formatting/format-relative-time-from-date) pour sélectionner automatiquement l’unité à partir d’un objet Date
* Consultez la fonction autonome [`formatRelativeTime`](/docs/core/functions/formatting/format-relative-time) pour l’utiliser sans instance GT