# generaltranslation: General Translation Core SDK: formatNum
URL: https://generaltranslation.com/fr/docs/core/class/methods/formatting/format-num.mdx
---
title: formatNum
description: Référence de l’API de la méthode formatNum pour formater des nombres selon les conventions du paramètre régional
---

## Vue d’ensemble

La méthode `formatNum` formate les nombres selon les conventions du paramètre régional à l’aide de l’API d’internationalisation.
Elle gère automatiquement les séparateurs décimaux, les séparateurs de milliers et les systèmes de numération en fonction du paramètre régional cible.

```typescript
const gt = new GT({ targetLocale: 'de' });

const formatted = gt.formatNum(1234.56, {
  style: 'decimal',
  minimumFractionDigits: 2
});
// Retourne : "1.234,56" (formatage des nombres en allemand)
```


## Référence

### Paramètres

| Nom        | Type                  | Description                                |
| ---------- | --------------------- | ------------------------------------------ |
| `number`   | `number`              | Le nombre à mettre en forme                |
| `options?` | `NumberFormatOptions` | Configuration de mise en forme facultative |

### NumberFormatOptions

Étend `Intl.NumberFormatOptions` en ajoutant une spécification de paramètre régional supplémentaire :

| Nom                         | Type                                                                                                                 | Description                                                                                                 |
| --------------------------- | -------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `locales?`                  | `string \| string[]`                                                                                                 | Remplace les paramètres régionaux utilisés pour le formatage (par défaut, ceux de l’instance sont utilisés) |
| `style?`                    | `'decimal' \| 'currency' \| 'percent' \| 'unit'`                                                                     | Style de formatage des nombres                                                                              |
| `currency?`                 | `string`                                                                                                             | Code de devise (obligatoire lorsque le style est 'currency')                                        |
| `currencyDisplay?`          | `'symbol' \| 'narrowSymbol' \| 'code' \| 'name'`                                                                     | Mode d’affichage de la devise                                                                               |
| `currencySign?`             | `'standard' \| 'accounting'`                                                                                         | Signe monétaire à utiliser                                                                                  |
| `unit?`                     | `string`                                                                                                             | Identifiant d’unité (obligatoire lorsque le style est 'unit')                                       |
| `unitDisplay?`              | `'short' \| 'narrow' \| 'long'`                                                                                      | Mode d’affichage de l’unité                                                                                 |
| `minimumIntegerDigits?`     | `number`                                                                                                             | Nombre minimal de chiffres entiers (1-21)                                                                   |
| `minimumFractionDigits?`    | `number`                                                                                                             | Nombre minimal de chiffres fractionnaires (0-20)                                                            |
| `maximumFractionDigits?`    | `number`                                                                                                             | Nombre maximal de chiffres fractionnaires (0-20)                                                            |
| `minimumSignificantDigits?` | `number`                                                                                                             | Nombre minimal de chiffres significatifs (1-21)                                                             |
| `maximumSignificantDigits?` | `number`                                                                                                             | Nombre maximal de chiffres significatifs (1-21)                                                             |
| `useGrouping?`              | `boolean \| 'always' \| 'auto' \| 'min2'`                                                                            | Indique s’il faut utiliser des séparateurs de groupement                                                    |
| `notation?`                 | `'standard' \| 'scientific' \| 'engineering' \| 'compact'`                                                           | Format de notation des nombres                                                                              |
| `compactDisplay?`           | `'short' \| 'long'`                                                                                                  | Style d’affichage de la notation compacte                                                                   |
| `signDisplay?`              | `'auto' \| 'never' \| 'always' \| 'exceptZero'`                                                                      | Indique quand afficher le signe                                                                             |
| `roundingMode?`             | `'ceil' \| 'floor' \| 'expand' \| 'trunc' \| 'halfCeil' \| 'halfFloor' \| 'halfExpand' \| 'halfTrunc' \| 'halfEven'` | Mode d’arrondi                                                                                              |
| `roundingIncrement?`        | `1 \| 2 \| 5 \| 10 \| 20 \| 25 \| 50 \| 100`                                                                         | Incrément d’arrondi                                                                                         |
| `trailingZeroDisplay?`      | `'auto' \| 'stripIfInteger'`                                                                                         | Indique s’il faut afficher les zéros finaux                                                                 |

### Renvoie

`chaîne` - Le nombre formaté conformément aux conventions du paramètre régional.

***

## Exemples

### Formatage de base des nombres

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

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

// Formatage décimal de base
console.log(gt.formatNum(1234.567));
// Output: "1,234.567"

// Formatage avec le paramètre régional allemand
console.log(gt.formatNum(1234.567, { locales: 'de-DE' }));
// Output: "1.234,567"

// Formatage avec le paramètre régional français  
console.log(gt.formatNum(1234.567, { locales: 'fr-FR' }));
// Output: "1 234,567"
```


### Formatage des devises

```typescript copy
// Formatage en dollar américain
console.log(gt.formatNum(1234.56, {
  style: 'currency',
  currency: 'USD'
}));
// Output: "$1,234.56"

// Formatage en euro avec le paramètre régional allemand
console.log(gt.formatNum(1234.56, {
  style: 'currency',
  currency: 'EUR',
  locales: 'de-DE'
}));
// Output: "1.234,56 €"

// Options d'affichage de la devise
console.log(gt.formatNum(1234.56, {
  style: 'currency',
  currency: 'USD',
  currencyDisplay: 'code'
}));
// Output: "USD 1,234.56"

// Format comptable (parenthèses pour les valeurs négatives)
console.log(gt.formatNum(-1234.56, {
  style: 'currency',
  currency: 'USD',
  currencySign: 'accounting'
}));
// Output: "($1,234.56)"
```


### Pourcentages et notation scientifique

```typescript copy
// Pourcentage de base
console.log(gt.formatNum(0.1234, { style: 'percent' }));
// Sortie : "12%"

// Pourcentage avec décimales
console.log(gt.formatNum(0.1234, {
  style: 'percent',
  minimumFractionDigits: 1,
  maximumFractionDigits: 2
}));
// Sortie : "12.34%"

// Notation compacte
console.log(gt.formatNum(1234567, { notation: 'compact' }));
// Sortie : "1.2M"

// Notation scientifique
console.log(gt.formatNum(1234567, { notation: 'scientific' }));
// Sortie : "1.235E6"
```

***


## Remarques

* Le formatage des nombres suit automatiquement les conventions propres au paramètre régional
* La méthode utilise `Intl.NumberFormat`, intégré au navigateur, pour des performances et une précision optimales
* Le formatage des devises nécessite à la fois `style: 'currency'` et un code `currency` valide
* Le formatage des unités nécessite à la fois `style: 'unit'` et un identifiant `unit` valide

## Étapes suivantes

* Consultez la documentation de [`Intl.NumberFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat) pour découvrir d’autres options
* Consultez [`format-message`](/docs/core/class/methods/formatting/format-message) pour le formatage de messages avec interpolation de nombres
* Consultez la version autonome de [`format-num`](/docs/core/functions/formatting/format-num) pour l’utiliser sans instance GT
* Consultez [`get-locale-properties`](/docs/core/class/methods/locales/get-locale-properties) pour obtenir des informations de formatage spécifiques au paramètre régional