Utility FunctionsFormatting

formatNum

Eigenständige Funktion zum Formatieren von Zahlen gemäß den Konventionen der Locale

Übersicht

Die eigenständige Funktion formatNum formatiert Zahlen gemäß lokalspezifischen Konventionen, ohne dass eine GT-Instanz erforderlich ist. Sie bietet dieselbe Funktionalität wie die Methode der GT-Klasse, kann jedoch auch unabhängig verwendet werden.

import { formatNum } from 'generaltranslation';

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

Referenzen

Parameter

NameTypBeschreibung
numbernumberDie zu formatierende Zahl
optionsNumberFormatOptions & { locales: string | string[] }Formatierungskonfiguration mit erforderlichen locales

NumberFormatOptions

NameTypeBeschreibung
localesstring | string[]Erforderlich – Locales für die Formatierung
style?'decimal' | 'currency' | 'percent' | 'unit'Zahlenformatstil
currency?stringWährungscode (erforderlich, wenn style 'currency' ist)
minimumIntegerDigits?numberMinimale Anzahl ganzer Stellen (1–21)
minimumFractionDigits?numberMinimale Anzahl von Nachkommastellen (0–20)
maximumFractionDigits?numberMaximale Anzahl von Nachkommastellen (0–20)
useGrouping?boolean | 'always' | 'auto' | 'min2'Ob Gruppierungstrennzeichen verwendet werden
notation?'standard' | 'scientific' | 'engineering' | 'compact'Zahlen­notation

Rückgabe

string – Die formatierte Zahl gemäß den Konventionen der locale.


Beispiel

Grundlegende Verwendung

import { formatNum } from 'generaltranslation';

// Grundlegende Zahlenformatierung
console.log(formatNum(1234.567, { locales: 'en-US' }));
// Ausgabe: "1,234.567"

// Deutsche Formatierung
console.log(formatNum(1234.567, { locales: 'de-DE' }));
// Ausgabe: "1.234,567"

Währungsformatierung

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

// Euro mit deutschem Locale
console.log(formatNum(1234.56, {
  locales: 'de-DE',
  style: 'currency',
  currency: 'EUR'
}));
// Ausgabe: "1.234,56 €"

// Japanischer Yen
console.log(formatNum(1234.56, {
  locales: 'ja-JP',
  style: 'currency',
  currency: 'JPY'
}));
// Ausgabe: "¥1,235"

Hinweise

  • Im Unterschied zur Methode der GT-Klasse ist der Parameter locales erforderlich
  • Verwendet dasselbe zugrunde liegende Intl.NumberFormat wie die Methode der GT-Klasse
  • Ergebnisse werden intern zwischengespeichert, um die Performance bei wiederholten Kombinationen aus locale/options zu verbessern
  • Fallback-Locales werden in der angegebenen Reihenfolge verarbeitet, wenn die primäre Locale nicht unterstützt wird
  • Alle Standard-Intl.NumberFormat options werden unterstützt

Nächste Schritte

  • Sieh dir die Dokumentation zu Intl.NumberFormat für weitere options an
  • Sieh dir formatDateTime für die alleinstehende Datumsformatierung an
  • Sieh dir formatMessage für die alleinstehende Nachrichtenformatierung an
  • Sieh dir die GT-Klasse formatNum für die instanzbasierte Verwendung an
  • Sieh dir formatCurrency für die spezialisierte Währungsformatierung an

Wie ist dieser Leitfaden?

formatNum