# General Translation Platform: formatRelativeTime
URL: https://generaltranslation.com/fr/docs/platform/core/reference/gt-class-methods/formatting/format-relative-time.mdx
---

title: formatRelativeTime
description: Formate des valeurs de temps relatif, comme il y a quelques minutes ou dans quelques jours. Référence de l'API pour formatRelativeTime.

---

Formate une valeur de temps relatif avec une unité explicite selon les conventions propres au paramètre régional, sur une instance de [GT](/docs/platform/core/reference/gt-class/constructor). General Translation utilise l'API intégrée `Intl.RelativeTimeFormat` pour produire des expressions comme "il y a 2 heures" ou "dans 3 jours".

## Vue d’ensemble [#overview]

Appelez `formatRelativeTime` sur une instance de [`GT`](/docs/platform/core/reference/gt-class/constructor) en lui passant une valeur numérique, une unité de temps et, éventuellement, un objet d’options. Une valeur négative correspond au passé, une valeur positive au futur. La méthode renvoie la chaîne formatée.

```typescript
const gt = new GT();

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

Signature :

```typescript
formatRelativeTime(
  value: number,
  unit: Intl.RelativeTimeFormatUnit,
  options?: { locales?: string | string[] } & Omit<Intl.RelativeTimeFormatOptions, 'locales'>
): string
```

*Remarque : `formatRelativeTime` s’exécute localement avec `Intl.RelativeTimeFormat` et ne nécessite pas de clé API. Il utilise par défaut le paramètre régional cible de l’instance, puis se replie sur le paramètre régional source et `en`. Pour le formatage sans instance `GT`, consultez [`formatRelativeTime`](/docs/platform/core/reference/utility-functions/formatting/format-relative-time) en mode autonome.*

## Fonctionnement [#how-it-works]

* **Résolution des paramètres régionaux.** Lorsque `locales` est omis, la méthode utilise le paramètre régional cible de l&#39;instance, puis le paramètre régional source et `en`.
* **Basé sur Intl.** Le formatage est délégué à [`Intl.RelativeTimeFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/RelativeTimeFormat), intégré au navigateur.
* **Valeurs par défaut.** `numeric` vaut par défaut `'auto'` (ainsi, `-1 day` devient « hier » plutôt que « il y a 1 jour ») et `style` vaut par défaut `'long'`.

## Paramètres [#parameters]

| Paramètre             | Description                                                                  | Type                          | Facultatif | Par défaut |
| --------------------- | ---------------------------------------------------------------------------- | ----------------------------- | ---------- | ---------- |
| [`value`](#value)     | La valeur de temps relatif (négative pour le passé, positive pour le futur). | `number`                      | Non        | —          |
| [`unit`](#unit)       | L’unité de temps.                                                            | `Intl.RelativeTimeFormatUnit` | Non        | —          |
| [`options`](#options) | Configuration du formatage.                                                  | `object`                      | Oui        | —          |

### `value` [#value]

**Type** `number` · **Obligatoire**

La valeur du temps relatif. Les valeurs négatives correspondent au passé ; les valeurs positives, au futur.

### `unit` [#unit]

**Type** `Intl.RelativeTimeFormatUnit` · **Obligatoire**

L’unité de temps. Les formes au singulier et au pluriel sont acceptées : `'second'`/`'seconds'`, `'minute'`/`'minutes'`, `'hour'`/`'hours'`, `'day'`/`'days'`, `'week'`/`'weeks'`, `'month'`/`'months'`, `'quarter'`/`'quarters'` et `'year'`/`'years'`.

### `options` [#options]

**Type** `{ locales?: string | string[] } & Omit<Intl.RelativeTimeFormatOptions, 'locales'>` · **Facultatif**

Configuration de formatage. Le tableau répertorie les options courantes exposées par les types Core publiés et leurs valeurs par défaut effectives dans Core. Consultez les [options du constructeur `Intl.RelativeTimeFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/RelativeTimeFormat/RelativeTimeFormat#options) pour obtenir des détails supplémentaires sur la norme et spécifiques au runtime.

| Nom             | Description                                                       | Type                            | Facultatif | Par défaut                             |
| --------------- | ----------------------------------------------------------------- | ------------------------------- | ---------- | -------------------------------------- |
| `locales`       | Paramètres régionaux pour le formatage.                           | `string \| string[]`            | Oui        | `targetLocale` → `sourceLocale` → `en` |
| `numeric`       | Indique s&#39;il faut toujours utiliser une valeur numérique.     | `'always' \| 'auto'`            | Oui        | `'auto'`                               |
| `style`         | Longueur de la sortie.                                            | `'long' \| 'short' \| 'narrow'` | Oui        | `'long'`                               |
| `localeMatcher` | Algorithme de correspondance des paramètres régionaux à utiliser. | `'best fit' \| 'lookup'`        | Oui        | `'best fit'`                           |

Core modifie la valeur par défaut `numeric` amont de `'always'` à `'auto'` ; les autres valeurs par défaut standard proviennent de `Intl.RelativeTimeFormat`.

## Renvoie [#returns]

**Type** `string`

La chaîne de temps relatif mise en forme.

## Exemples [#examples]

```typescript
import { GT } from 'generaltranslation';

const gt = new GT();

// Temps passé
gt.formatRelativeTime(-2, 'hour', { locales: 'en-US' });
// Retourne : "2 hours ago"

// Temps futur
gt.formatRelativeTime(3, 'day', { locales: 'fr-FR' });
// Retourne : "dans 3 jours"

// Avec numeric : 'auto' (par défaut)
gt.formatRelativeTime(-1, 'day', { locales: 'en-US' });
// Retourne : "yesterday"
```

## Notes [#notes]

* La valeur par défaut est `numeric: 'auto'` et `style: 'long'`.
* Utilise `Intl.RelativeTimeFormat` en interne.
* Pour sélectionner automatiquement l’unité à partir d’un objet `Date`, utilisez [`formatRelativeTimeFromDate`](/docs/platform/core/reference/gt-class-methods/formatting/format-relative-time-from-date).