Utility FunctionsFormatting

formatNum

Fonction autonome pour formater les nombres selon les conventions de la locale

Vue d’ensemble

La fonction autonome formatNum met en forme les nombres selon les conventions propres à la locale, sans nécessiter d’instance de GT. Elle offre les mêmes fonctionnalités que la méthode de la classe GT, mais peut être utilisée indépendamment.

import { formatNum } from 'generaltranslation';

const formatted = formatNum(1234.56, {
  locales: 'de-DE',
  style: 'currency',
  currency: 'EUR'
});
// Renvoie : "1.234,56 €"

Références

Paramètres

NomTypeDescription
numbernumberNombre à formater
optionsNumberFormatOptions & { locales: string | string[] }Configuration de formatage avec locales obligatoires

NumberFormatOptions

NomTypeDescription
localesstring | string[]Obligatoire — Locales pour le formatage
style?'decimal' | 'currency' | 'percent' | 'unit'Style de formatage des nombres
currency?stringCode de devise (obligatoire lorsque le style est 'currency')
minimumIntegerDigits?numberNombre minimal de chiffres entiers (1–21)
minimumFractionDigits?numberNombre minimal de chiffres fractionnaires (0–20)
maximumFractionDigits?numberNombre maximal de chiffres fractionnaires (0–20)
useGrouping?boolean | 'always' | 'auto' | 'min2'Indique s’il faut utiliser des séparateurs de regroupement
notation?'standard' | 'scientific' | 'engineering' | 'compact'Format de notation des nombres

Renvoie

string - Le nombre formaté selon les conventions de la locale.


Exemple

Utilisation basique

import { formatNum } from 'generaltranslation';

// Formatage de base des nombres
console.log(formatNum(1234.567, { locales: 'en-US' }));
// Sortie : "1,234.567"

// Formatage allemand
console.log(formatNum(1234.567, { locales: 'de-DE' }));
// Sortie : "1.234,567"

Formatage des devises

// Dollar américain
console.log(formatNum(1234.56, {
  locales: 'en-US',
  style: 'currency',
  currency: 'USD'
}));
// Résultat : "$1,234.56"

// Euro avec locale allemande
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"

Notes

  • Contrairement à la méthode de la classe GT, le paramètre locales est obligatoire
  • 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 pour améliorer les performances avec des combinaisons locale/options répétées
  • Les locales de secours sont traitées dans l’ordre si la locale principale n’est pas prise en charge
  • Toutes les options standard de Intl.NumberFormat sont prises en charge

Prochaines étapes

  • Consultez la documentation Intl.NumberFormat pour davantage d’options
  • Voir formatDateTime pour le formatage de dates en autonomie
  • Voir formatMessage pour le formatage autonome de messages
  • Voir la méthode de la classe GT formatNum pour un usage par instance
  • Voir formatCurrency pour un formatage spécialisé des montants en devise

Que pensez-vous de ce guide ?

formatNum