# General Translation Platform: formatNum URL: https://generaltranslation.com/fr/docs/platform/core/reference/utility-functions/formatting/format-num.mdx Docs index: https://generaltranslation.com/llms.txt Description: Met en forme les nombres, la Currency, les pourcentages et les valeurs numériques sans instance GT. Référence d’API pour formatNum. [`formatNum`](/docs/platform/core/reference/gt-class-methods/formatting/format-num) est une fonction utilitaire autonome de la bibliothèque Core de General Translation qui met en forme les nombres selon les conventions propres au paramètre régional. Elle renvoie une chaîne adaptée au paramètre régional pour les décimales, la Currency, les pourcentages et les unités. ## Aperçu [#overview] Importez `formatNum` directement depuis `generaltranslation` et appelez-le avec le nombre à formater et un objet d’options. Il ne nécessite ni clé API ni instance [GT](/docs/platform/core/reference/gt-class/constructor), vous pouvez donc l’utiliser partout où vous avez besoin d’un formatage ponctuel de nombres. Pour un formatage basé sur une instance qui hérite du paramètre régional de l’instance, utilisez plutôt la méthode [`formatNum`](/docs/platform/core/reference/gt-class-methods/formatting/format-num) sur une instance [`GT`](/docs/platform/core/reference/gt-class/constructor). ```typescript import { formatNum } from 'generaltranslation'; const formatted = formatNum(1234.56, { locales: 'de-DE', style: 'currency', currency: 'EUR', }); // Retourne : "1.234,56 €" ``` Signature : ```typescript formatNum( number: number, 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) que la méthode de la classe GT ; toutes les options standard de `Intl.NumberFormat` sont donc prises en charge. * **Résolution du paramètre régional.** Lorsque `locales` est un tableau, les paramètres régionaux sont testés dans l’ordre, et le premier paramètre régional pris en charge est utilisé. Lorsque `locales` est omis, la valeur de repli est le paramètre régional par défaut de la bibliothèque, `en`. * **Mise en cache.** Les résultats sont mis en cache en interne afin d’améliorer les performances pour les combinaisons répétées de paramètres régionaux et d’options. ## Paramètres [#parameters] | Paramètre | Description | Type | Facultatif | Par défaut | | --------------------- | --------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | ---------- | ---------- | | [`number`](#number) | Le nombre à formater. | `number` | Non | — | | [`options`](#options) | Configuration du formatage, y compris le ou les paramètres régionaux cibles et les options `Intl.NumberFormat`. | `{ locales?: string \| string[] } & Intl.NumberFormatOptions` | Oui | `{}` | ### `number` [#number] **Type** `number` · **Obligatoire** La valeur numérique à mettre en forme. ### `options` [#options] **Type** `{ locales?: string | string[] } & Intl.NumberFormatOptions` · **Facultatif** · **Par défaut** `{}` Configuration du formatage. Le tableau répertorie les options courantes exposées par les types Core publiés ainsi que 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 des détails standard et propres à l’exécution complémentaires). | Propriété | Description | Type | Facultatif | Par défaut | | -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `locales` | Paramètre(s) régional(aux) à utiliser pour le formatage. Lorsqu’un tableau est fourni, ils sont essayés dans l’ordre. | `string \| string[]` | Oui | `en` | | `localeMatcher` | Algorithme de mise en correspondance des paramètres régionaux. | `'lookup' \| 'best fit'` | Oui | `'best fit'` | | `numberingSystem` | Système de numérotation, tel que `latn` ou `arab`. | `string` | Oui | `'latn'` | | `style` | Style de formatage des nombres. | `'decimal' \| 'currency' \| 'percent' \| 'unit'` | Oui | `'decimal'` | | `currency` | Code de Currency (requis lorsque `style` vaut `'currency'`). | `string` | Oui | — | | `currencyDisplay` | Mode d’affichage de la Currency. | `'symbol' \| 'narrowSymbol' \| 'code' \| 'name'` | Oui | `'symbol'` | | `currencySign` | Signe monétaire à utiliser. | `'standard' \| 'accounting'` | Oui | `'standard'` | | `unit` | Identifiant d’unité (requis lorsque `style` vaut `'unit'`). | `string` | Oui | — | | `unitDisplay` | Mode d’affichage de l’unité. | `'short' \| 'narrow' \| 'long'` | Oui | `'short'` | | `minimumIntegerDigits` | Nombre minimal de chiffres dans la partie entière (1–21). | `number` | Oui | `1` | | `minimumFractionDigits` | Nombre minimal de chiffres fractionnaires (0–100). Le style influe sur la valeur par défaut. | `number` | Oui | `0` pour les nombres décimaux et les pourcentages ; nombre de décimales de la Currency pour les Currency ; `0` avec les valeurs par défaut de la notation compacte | | `maximumFractionDigits` | Nombre maximal de chiffres fractionnaires (0–100). Le style et la valeur minimale influent sur la valeur par défaut. | `number` | Oui | `3` pour les nombres décimaux ; `0` pour les pourcentages ; nombre de décimales de la Currency pour les Currency ; `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` | Mode d’interaction entre les paramètres des chiffres fractionnaires et significatifs. | `'auto' \| 'morePrecision' \| 'lessPrecision'` | Oui | `'auto'` ; `'morePrecision'` 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'` | | `useGrouping` | Indique s’il faut utiliser des séparateurs de regroupement, et quand. | `boolean \| 'always' \| 'auto' \| 'min2'` | Oui | `'auto'` ; `'min2'` avec la notation compacte | | `signDisplay` | Moment auquel afficher le signe. | `'auto' \| 'never' \| 'always' \| 'exceptZero' \| 'negative'` | Oui | `'auto'` | | `roundingMode` | Mode d’arrondi. | `'ceil' \| 'floor' \| 'expand' \| 'trunc' \| 'halfCeil' \| 'halfFloor' \| 'halfExpand' \| 'halfTrunc' \| 'halfEven'` | Oui | `'halfExpand'` | | `roundingIncrement` | Incrément d’arrondi. Les valeurs autres que celle par défaut nécessitent que les nombres effectifs minimal et maximal de chiffres fractionnaires soient égaux et ne peuvent pas être combinées avec un 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` | | `trailingZeroDisplay` | Indique s’il faut afficher les zéros non significatifs. | `'auto' \| 'stripIfInteger'` | Oui | `'auto'` | Lorsque `notation: 'compact'` est défini sans option relative aux 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'`. ## Valeur de retour [#returns] **Type** `string` Le nombre mis en forme conformément aux conventions du paramètre régional. ## Exemples [#examples] ```typescript import { formatNum } from 'generaltranslation'; // Formatage de nombre de base console.log(formatNum(1234.567, { locales: 'en-US' })); // Résultat : "1,234.567" // Formatage allemand console.log(formatNum(1234.567, { locales: 'de-DE' })); // Résultat : "1.234,567" ``` ```typescript // Formatage de devise // Dollar américain console.log(formatNum(1234.56, { locales: 'en-US', style: 'currency', currency: 'USD', })); // Résultat : "$1,234.56" // Euro avec le paramètre régional allemand console.log(formatNum(1234.56, { locales: 'de-DE', style: 'currency', currency: 'EUR', })); // Résultat : "1.234,56 €" // Yen japonais console.log(formatNum(1234.56, { locales: 'ja-JP', style: 'currency', currency: 'JPY', })); // Résultat : "¥1,235" ``` ## Remarques [#notes] * Utilise le même `Intl.NumberFormat` sous-jacent que la méthode de la classe GT. * Les résultats sont mis en cache en interne afin d’améliorer les performances lorsque les mêmes combinaisons de paramètre régional et d’options sont réutilisées. * Les paramètres régionaux de secours sont traités dans l’ordre si le paramètre régional principal n’est pas pris en charge. * Toutes les options standard de `Intl.NumberFormat` sont prises en charge. ## Sitemap See the full [sitemap](https://generaltranslation.com/sitemap.md) for all pages.