Document formatNumber()

mathieuprog · Apr 14, 2023 · 9192057 · 9192057
1 parent e8f4c21
commit 9192057
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -355,6 +355,18 @@ import { useLocale } from 'solid-compose';
 const [locale, { setNumberFormat }] = useLocale();
 ```
 
+`formatNumber` allows to format a number according to the current locale's number formatting setting.
+
+```typescript
+import { formatNumber, useLocale } from 'solid-compose';
+
+const [locale, { setNumberFormat }] = useLocale();
+
+setNumberFormat(NumberFormat.SpaceComma);
+
+formatNumber(1000.01) // 1 000,01
+```
+
 ### Date format
 
 `setDateFormat` allows to change the date format: