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

title: formatCurrency
description: Formate une valeur monétaire selon le paramètre régional sur une instance GT. Référence API pour formatCurrency.

---

Formate une valeur numérique sous la forme d’une chaîne de devise localisée sur une instance [GT](/docs/platform/core/reference/gt-class/constructor). General Translation utilise l’API intégrée `Intl.NumberFormat` avec le style monétaire, afin que les montants s’affichent avec le symbole, les séparateurs de milliers et les conventions décimales appropriés pour chaque paramètre régional.

## Vue d’ensemble [#overview]

Appelez `formatCurrency` sur une instance de [`GT`](/docs/platform/core/reference/gt-class/constructor) avec une valeur numérique, un code de devise et un objet d’options facultatif. La méthode renvoie la chaîne formatée de la devise.

```typescript
const gt = new GT({ targetLocale: 'en-US' });

const price = gt.formatCurrency(1234.56, 'USD');
// "$1,234.56"
```

Signature :

```typescript
formatCurrency(
  value: number,
  currency: string,
  options?: { locales?: string | string[] } & Intl.NumberFormatOptions
): string
```

*Remarque : `formatCurrency` s’exécute localement avec `Intl.NumberFormat` et ne nécessite pas de clé API. Par défaut, il applique le format du paramètre régional cible de l’instance, avec repli sur le paramètre régional source puis sur la valeur par défaut de la bibliothèque (`en`) ; passez `locales` pour remplacer ce comportement. Pour effectuer un formatage sans instance `GT`, consultez la version autonome de [`formatCurrency`](/docs/platform/core/reference/utility-functions/formatting/format-currency).*

## Fonctionnement [#how-it-works]

* **Style de devise.** Le formatage est délégué à [`Intl.NumberFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat) avec `style: 'currency'` et le code `currency` fourni.
* **Résolution du paramètre régional.** Par défaut, la méthode formate selon le paramètre régional cible de l'instance, avec repli sur le paramètre régional source puis sur la valeur par défaut de la library (`en`) — et non sur le tableau de configuration `locales`. Passez `locales` dans les options pour surcharger ce comportement.
* **Placement du symbole.** Le symbole monétaire, les séparateurs de groupement et le format décimal suivent le paramètre régional résolu, et non le pays de la devise.

## Paramètres [#parameters]

| Paramètre               | Description                                                                                             | Type     | Facultatif | Par défaut |
| ----------------------- | ------------------------------------------------------------------------------------------------------- | -------- | ---------- | ---------- |
| [`value`](#value)       | La valeur numérique à formater.                                                                         | `number` | Non        | —          |
| [`currency`](#currency) | Le code de devise ISO 4217, comme `USD` ou `EUR`.                                                       | `string` | Non        | —          |
| [`options`](#options)   | La configuration de formatage, qui étend `Intl.NumberFormatOptions` avec une redéfinition de `locales`. | `object` | Oui        | —          |

### `value` [#value]

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

La valeur numérique à formater.

### `currency` [#currency]

**Type** `string` · **Obligatoire**

Le code de devise ISO 4217, comme `USD`, `EUR` ou `JPY`.

### `options` [#options]

**Type** `{ locales?: string | string[] } & Intl.NumberFormatOptions` · **Facultatif**

Configuration du formatage. Étend `Intl.NumberFormatOptions` avec un champ `locales` supplémentaire :

| Nom       | Description                                                                      | Type                 | Facultatif | Défaut                                 |
| --------- | -------------------------------------------------------------------------------- | -------------------- | ---------- | -------------------------------------- |
| `locales` | Remplace les paramètres régionaux utilisés pour le formatage.                    | `string \| string[]` | Oui        | paramètre régional cible de l’instance |
| `style`   | Style de formatage des nombres ; par défaut, le formatage monétaire est utilisé. | `string`             | Oui        | `'currency'`                           |

## Returns [#returns]

**Type** `string`

La valeur formatée sous forme de chaîne de devise localisée.

## Exemples [#examples]

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

const gt = new GT({ targetLocale: 'en-US' });

// Paramètre régional cible de l'instance par défaut
console.log(gt.formatCurrency(1234.56, 'USD'));
// Résultat : "$1,234.56"

// Remplacer le paramètre régional pour cet appel
console.log(gt.formatCurrency(1234.56, 'EUR', { locales: ['de-DE'] }));
// Résultat : "1.234,56 €"

// Sans décimales
console.log(gt.formatCurrency(1234, 'JPY', { locales: ['ja-JP'] }));
// Résultat : "￥1,234"
```

## Remarques [#notes]

* La méthode utilise en interne `Intl.NumberFormat`, natif au navigateur, de sorte que les montants respectent les conventions du paramètre régional choisi.
* Passez n’importe quelle option `Intl.NumberFormatOptions` (par exemple `minimumFractionDigits`) avec `locales` pour affiner le rendu.