# 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. --- 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. Le tableau répertorie les options monétaires courantes exposées par les types Core publiés et leurs valeurs par défaut effectives dans Core. Consultez les [options du constructeur `Intl.NumberFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#options) pour plus de détails sur les options standard et celles spécifiques au runtime. | Nom | Description | Type | Facultatif | Par défaut | | -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | ---------- | ---------------------------------------------------------------------------------------------------- | | `locales` | Remplace les paramètres régionaux utilisés pour le formatage. | `string \| string[]` | Oui | `targetLocale` → `sourceLocale` → `en` | | `localeMatcher` | Algorithme de correspondance des paramètres régionaux. | `'lookup' \| 'best fit'` | Oui | `'best fit'` | | `numberingSystem` | Système de numération, tel que `latn` ou `arab`. | `string` | Oui | `'latn'` | | `style` | Style de formatage des nombres. `formatCurrency` fournit le style de devise, sauf remplacement explicite. | `'decimal' \| 'currency' \| 'percent' \| 'unit'` | Oui | `'currency'` | | `currency` | Code de devise utilisé par le formateur. L’argument positionnel `currency` fournit cette valeur, sauf remplacement explicite. | `string` | Oui | argument positionnel `currency` | | `currencyDisplay` | Mode d’affichage de la devise. | `'symbol' \| 'narrowSymbol' \| 'code' \| 'name'` | Oui | `'symbol'` | | `currencySign` | Signe monétaire à utiliser. | `'standard' \| 'accounting'` | Oui | `'standard'` | | `unit` | Identifiant de l’unité. Obligatoire lorsque `style` est défini sur `'unit'`. | `string` | Oui | — | | `unitDisplay` | Mode d’affichage de l’unité. | `'short' \| 'narrow' \| 'long'` | Oui | `'short'` | | `minimumFractionDigits` | Nombre minimal de chiffres après la virgule (0–100). | `number` | Oui | chiffres de l’unité mineure de la devise ; `0` avec les valeurs par défaut pour la notation compacte | | `maximumFractionDigits` | Nombre maximal de chiffres après la virgule (0–100), au moins égal à `minimumFractionDigits`. | `number` | Oui | chiffres de l’unité mineure de la devise ; `0` avec les valeurs par défaut pour la notation compacte | | `minimumSignificantDigits` | Nombre minimal de chiffres significatifs (1–21), lorsque l’arrondi aux chiffres significatifs est actif. | `number` | Oui | `1` | | `maximumSignificantDigits` | Nombre maximal de chiffres significatifs (1–21), lorsque l’arrondi aux chiffres significatifs est actif. | `number` | Oui | `21` ; `2` avec les valeurs par défaut pour la notation compacte | | `roundingPriority` | Mode d’interaction entre les paramètres de chiffres après la virgule et de chiffres significatifs. | `'auto' \| 'morePrecision' \| 'lessPrecision'` | Oui | `'auto'` ; `'morePrecision'` avec les valeurs par défaut pour la notation compacte | | `roundingMode` | Mode d’arrondi. | `'ceil' \| 'floor' \| 'expand' \| 'trunc' \| 'halfCeil' \| 'halfFloor' \| 'halfExpand' \| 'halfTrunc' \| 'halfEven'` | Oui | `'halfExpand'` | | `roundingIncrement` | Incrément d’arrondi. Les valeurs autres que la valeur par défaut exigent que les nombres effectifs minimal et maximal de chiffres après la virgule soient identiques et ne peuvent pas être combinées avec l’arrondi aux chiffres significatifs ni avec une `roundingPriority` autre que `'auto'`. | `1 \| 2 \| 5 \| 10 \| 20 \| 25 \| 50 \| 100 \| 200 \| 250 \| 500 \| 1000 \| 2000 \| 2500 \| 5000` | Oui | `1` | | `useGrouping` | Indique si et quand utiliser les séparateurs de groupement. | `boolean \| 'always' \| 'auto' \| 'min2'` | Oui | `'auto'` ; `'min2'` avec les valeurs par défaut pour la notation compacte | | `notation` | Format de notation des nombres. | `'standard' \| 'scientific' \| 'engineering' \| 'compact'` | Oui | `'standard'` | | `compactDisplay` | Style d’affichage de la notation compacte. | `'short' \| 'long'` | Oui | `'short'` | | `signDisplay` | Moment auquel afficher le signe. | `'auto' \| 'never' \| 'always' \| 'exceptZero' \| 'negative'` | Oui | `'auto'` | | `trailingZeroDisplay` | Indique si les zéros finaux doivent être affichés. | `'auto' \| 'stripIfInteger'` | Oui | `'auto'` | Lorsque `notation: 'compact'` est défini sans option de chiffres fractionnaires ou significatifs, les valeurs effectives par défaut sont `minimumFractionDigits: 0`, `maximumFractionDigits: 0`, `minimumSignificantDigits: 1` et `maximumSignificantDigits: 2`. Dans ce cas, `roundingPriority` vaut par défaut `'morePrecision'` et `useGrouping` vaut par défaut `'min2'`. Définir `style: 'unit'` nécessite également une `unit` valide. ## 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.