# General Translation Platform: formatCurrency URL: https://generaltranslation.com/fr/docs/platform/core/reference/utility-functions/formatting/format-currency.mdx Docs index: https://generaltranslation.com/llms.txt Description: Met en forme une valeur monétaire selon le paramètre régional sans instance GT. Référence d’API pour formatCurrency. [`formatCurrency`](/docs/platform/core/reference/gt-class-methods/formatting/format-currency) est une fonction utilitaire autonome de la bibliothèque Core de General Translation qui met en forme une valeur numérique sous forme de chaîne monétaire localisée. Elle encapsule l’API intégrée `Intl.NumberFormat` avec le style `currency`. ## Vue d’ensemble [#overview] Importez `formatCurrency` directement depuis `generaltranslation` et appelez-la avec une valeur, un code de devise et un objet d’options. Elle ne nécessite ni clé API ni instance de [GT](/docs/platform/core/reference/gt-class/constructor). Pour un formatage basé sur une instance et qui hérite du paramètre régional de celle-ci, utilisez plutôt la méthode [`formatCurrency`](/docs/platform/core/reference/gt-class-methods/formatting/format-currency) sur une instance de [`GT`](/docs/platform/core/reference/gt-class/constructor). ```typescript import { formatCurrency } from 'generaltranslation'; const price = formatCurrency(1234.56, 'EUR', { locales: ['de-DE'] }); // "1.234,56 €" ``` Signature : ```typescript formatCurrency( value: number, currency: string, options?: { locales?: string | string[] } & Intl.NumberFormatOptions ): string ``` ## Fonctionnement [#how-it-works] * **API sous-jacente.** Utilise le même [`Intl.NumberFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat) avec `style: 'currency'` que la méthode de la classe GT. * **Résolution du paramètre régional.** Si `locales` est omis, le paramètre régional par défaut de la bibliothèque, `en`, est utilisé. * **Placement du symbole.** Le symbole monétaire, les séparateurs de groupement et le format décimal dépendent du paramètre régional résolu. ## 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, par exemple `USD` ou `EUR`. | `string` | Non | — | | [`options`](#options) | Configuration de formatage, y compris le ou les paramètres régionaux cibles. | `{ locales?: string \| string[] } & Intl.NumberFormatOptions` | 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** · **Par défaut** `{}` Configuration de formatage. Le tableau répertorie les options de devise 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 propres au runtime). | Propriété | Description | Type | Facultatif | Par défaut | | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------- | | `locales` | Paramètre(s) régional(aux) utilisé(s) pour le formatage. | `string \| string[]` | Oui | `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` applique le style de devise, sauf si vous le remplacez. | `'decimal' \| 'currency' \| 'percent' \| 'unit'` | Oui | `'currency'` | | `currency` | Code de devise utilisé par le formateur. L’argument positionnel `currency` fournit cette valeur, sauf si vous le remplacez. | `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 d’unité. Obligatoire lorsque `style` vaut `'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 | nombre de décimales de l’unité mineure de la devise ; `0` avec les valeurs par défaut de la notation compacte | | `maximumFractionDigits` | Nombre maximal de chiffres après la virgule (0–100), au moins égal à `minimumFractionDigits`. | `number` | Oui | nombre de décimales de l’unité mineure de la devise ; `0` avec les valeurs par défaut de 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 de la notation compacte | | `roundingPriority` | Interaction entre les paramètres de chiffres fractionnaires et de chiffres significatifs. | `'auto' \| 'morePrecision' \| 'lessPrecision'` | Oui | `'auto'` ; `'morePrecision'` avec les valeurs par défaut de 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 minimal et maximal effectifs de chiffres fractionnaires soient égaux et ne peuvent pas être combinées avec un arrondi aux chiffres significatifs ni avec une valeur de `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 des séparateurs de groupement. | `boolean \| 'always' \| 'auto' \| 'min2'` | Oui | `'auto'` ; `'min2'` avec les valeurs par défaut de 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 s’il faut afficher les zéros non significatifs. | `'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` prend par défaut la valeur `'morePrecision'` et `useGrouping`, la valeur `'min2'`. Définir `style: 'unit'` nécessite également une `unit` valide. ## Returns [#returns] **Type** `string` La valeur formatée comme une chaîne monétaire localisée. ## Exemples [#examples] ```typescript import { formatCurrency } from 'generaltranslation'; // Dollars américains console.log(formatCurrency(1234.56, 'USD', { locales: 'en-US' })); // Output: "$1,234.56" // Euros, paramètre régional allemand console.log(formatCurrency(1234.56, 'EUR', { locales: 'de-DE' })); // Output: "1.234,56 €" // Yen japonais (sans chiffres décimaux) console.log(formatCurrency(1234, 'JPY', { locales: 'ja-JP' })); // Output: "￥1,234" ``` ## Remarques [#notes] * Passez toujours une valeur `locales` explicite afin d’obtenir une sortie correcte et déterministe. * Passez n’importe quelle option `Intl.NumberFormatOptions` (par exemple `minimumFractionDigits`) avec `locales` pour affiner le résultat. ## Sitemap See the full [sitemap](https://generaltranslation.com/sitemap.md) for all pages.