n2words 3.1.0 → 5.0.0

package/{lib/languages/fr.js → src/fr-FR.js}

@@ -1,7 +1,7 @@
 /**
- * French language converter - Functional Implementation
+ * French (France) language converter
  *
- * Self-contained module with its own input validation, ready for subpath exports.
+ * CLDR: fr-FR | French as used in France
  *
  * French-specific rules:
  * - Vigesimal patterns: 70 = soixante-dix, 80 = quatre-vingts, 90 = quatre-vingt-dix
@@ -11,8 +11,10 @@
  * - Omit "un" before mille
  */
 
-import { parseNumericValue } from '../utils/parse-numeric.js'
-import { validateOptions } from '../utils/validate-options.js'
+import { parseCardinalValue } from './utils/parse-cardinal.js'
+import { parseCurrencyValue } from './utils/parse-currency.js'
+import { parseOrdinalValue } from './utils/parse-ordinal.js'
+import { validateOptions } from './utils/validate-options.js'
 
 // ============================================================================
 // Vocabulary (module-level constants)
@@ -32,6 +34,25 @@ const ZERO = 'zéro'
 const NEGATIVE = 'moins'
 const DECIMAL_SEP = 'virgule'
 
+// ============================================================================
+// Ordinal Vocabulary
+// ============================================================================
+
+// Ordinal suffix
+const ORDINAL_SUFFIX = 'ième'
+
+// Special ordinals
+const PREMIER = 'premier'
+
+// ============================================================================
+// Currency Vocabulary (Euro)
+// ============================================================================
+
+const EURO = 'euro'
+const EUROS = 'euros'
+const CENTIME = 'centime'
+const CENTIMES = 'centimes'
+
 // ============================================================================
 // Segment Building
 // ============================================================================
@@ -44,7 +65,7 @@ function buildSegment (n) {
   if (n === 0) return { word: '', endsWithCents: false, endsWithVingts: false }
 
   const tensOnes = n % 100
-  const hundreds = Math.floor(n / 100)
+  const hundreds = Math.trunc(n / 100)
 
   const parts = []
   let endsWithCents = false
@@ -84,7 +105,7 @@ function buildSegment (n) {
     parts.push(TEENS[tensOnes - 10])
   } else if (tensOnes < 70) {
     // 20-69: standard tens + ones
-    const t = Math.floor(tensOnes / 10)
+    const t = Math.trunc(tensOnes / 10)
     const o = tensOnes % 10
     if (o === 0) {
       parts.push(TENS[t])
@@ -324,26 +345,171 @@ function decimalPartToWords (decimalPart, withHyphen) {
  * @throws {Error} If value is not a valid number format
  *
  * @example
- * toWords(21)           // 'vingt et un'
- * toWords(80)           // 'quatre-vingts'
- * toWords(1000000)      // 'un million'
+ * toCardinal(21)           // 'vingt et un'
+ * toCardinal(80)           // 'quatre-vingts'
+ * toCardinal(1000000)      // 'un million'
  */
-function toWords (value, options) {
+function toCardinal (value, options) {
   options = validateOptions(options)
-  const { isNegative, integerPart, decimalPart } = parseNumericValue(value)
-  const withHyphen = options.withHyphenSeparator || false
+  const { isNegative, integerPart, decimalPart } = parseCardinalValue(value)
+
+  // Apply option defaults
+  const { withHyphenSeparator = false } = options
 
   let result = ''
-  const sep = withHyphen ? '-' : ' '
+  const sep = withHyphenSeparator ? '-' : ' '
 
   if (isNegative) {
     result = NEGATIVE + sep
   }
 
-  result += integerToWords(integerPart, withHyphen)
+  result += integerToWords(integerPart, withHyphenSeparator)
 
   if (decimalPart) {
-    result += sep + DECIMAL_SEP + sep + decimalPartToWords(decimalPart, withHyphen)
+    result += sep + DECIMAL_SEP + sep + decimalPartToWords(decimalPart, withHyphenSeparator)
+  }
+
+  return result
+}
+
+// ============================================================================
+// ORDINAL: toOrdinal(value)
+// ============================================================================
+
+/**
+ * Converts a cardinal number word to its ordinal form.
+ * Rules:
+ * - 1 → premier (special case)
+ * - Drop final -e before adding -ième (quatre → quatrième)
+ * - cinq → cinquième (add -u- before -ième)
+ * - neuf → neuvième (f → v before -ième)
+ *
+ * @param {string} cardinalWord - Cardinal word to convert
+ * @returns {string} Ordinal form
+ */
+function cardinalToOrdinal (cardinalWord) {
+  // Handle special endings
+  if (cardinalWord.endsWith('cinq')) {
+    // cinq → cinquième (add 'u')
+    return cardinalWord + 'u' + ORDINAL_SUFFIX
+  }
+
+  if (cardinalWord.endsWith('neuf')) {
+    // neuf → neuvième (f → v)
+    return cardinalWord.slice(0, -1) + 'v' + ORDINAL_SUFFIX
+  }
+
+  // Drop plural -s from cents/vingts/millions/etc. (quatre-vingts → quatre-vingtième)
+  // Note: "trois", "six" also end in s but that's not a plural
+  if (cardinalWord.endsWith('cents') ||
+      cardinalWord.endsWith('vingts') ||
+      cardinalWord.endsWith('millions') ||
+      cardinalWord.endsWith('milliards') ||
+      cardinalWord.endsWith('billions') ||
+      cardinalWord.endsWith('billiards') ||
+      cardinalWord.endsWith('trillions') ||
+      cardinalWord.endsWith('trilliards') ||
+      cardinalWord.endsWith('quadrillions') ||
+      cardinalWord.endsWith('quadrilliards')) {
+    return cardinalWord.slice(0, -1) + ORDINAL_SUFFIX
+  }
+
+  // Drop final -e before adding -ième (quatre → quatrième)
+  if (cardinalWord.endsWith('e')) {
+    return cardinalWord.slice(0, -1) + ORDINAL_SUFFIX
+  }
+
+  // Default: just add -ième
+  return cardinalWord + ORDINAL_SUFFIX
+}
+
+/**
+ * Converts a positive integer to French ordinal words.
+ *
+ * @param {bigint} n - Positive integer
+ * @returns {string} French ordinal words
+ */
+function integerToOrdinal (n) {
+  // Special case: 1 → premier
+  if (n === 1n) {
+    return PREMIER
+  }
+
+  // Get cardinal form and convert to ordinal
+  const cardinalWord = integerToWords(n, false)
+  return cardinalToOrdinal(cardinalWord)
+}
+
+/**
+ * Converts a numeric value to French ordinal words.
+ *
+ * French ordinals: premier (1st), then cardinal + ième.
+ * Special rules: quatre→quatrième, cinq→cinquième, neuf→neuvième.
+ *
+ * @param {number | string | bigint} value - The numeric value to convert (positive integer)
+ * @returns {string} The number as ordinal words
+ * @throws {TypeError} If value is not a valid numeric type
+ * @throws {RangeError} If value is negative, zero, or has a decimal part
+ *
+ * @example
+ * toOrdinal(1)    // 'premier'
+ * toOrdinal(2)    // 'deuxième'
+ * toOrdinal(4)    // 'quatrième'
+ * toOrdinal(5)    // 'cinquième'
+ * toOrdinal(9)    // 'neuvième'
+ * toOrdinal(21)   // 'vingt et unième'
+ * toOrdinal(100)  // 'centième'
+ * toOrdinal(1000) // 'millième'
+ */
+function toOrdinal (value) {
+  const integerPart = parseOrdinalValue(value)
+  return integerToOrdinal(integerPart)
+}
+
+// ============================================================================
+// CURRENCY: toCurrency(value, options?)
+// ============================================================================
+
+/**
+ * Converts a numeric value to French currency words (Euro).
+ *
+ * @param {number | string | bigint} value - The currency amount to convert
+ * @param {Object} [options] - Optional configuration
+ * @param {boolean} [options.and=true] - Use "et" between euros and centimes
+ * @returns {string} The amount in French currency words
+ * @throws {TypeError} If value is not a valid numeric type
+ * @throws {Error} If value is not a valid number format
+ *
+ * @example
+ * toCurrency(42.50)                 // 'quarante-deux euros et cinquante centimes'
+ * toCurrency(1)                     // 'un euro'
+ * toCurrency(0.99)                  // 'quatre-vingt-dix-neuf centimes'
+ * toCurrency(0.01)                  // 'un centime'
+ * toCurrency(42.50, { and: false }) // 'quarante-deux euros cinquante centimes'
+ */
+function toCurrency (value, options) {
+  options = validateOptions(options)
+  const { isNegative, dollars: euros, cents: centimes } = parseCurrencyValue(value)
+  const { and: useAnd = true } = options
+
+  // Build result
+  let result = ''
+  if (isNegative) result = NEGATIVE + ' '
+
+  // Euros part
+  if (euros > 0n || centimes === 0n) {
+    result += integerToWords(euros, false)
+    // In French, 0 and 1 are singular: "zéro euro", "un euro"
+    result += ' ' + (euros <= 1n ? EURO : EUROS)
+  }
+
+  // Centimes part
+  if (centimes > 0n) {
+    if (euros > 0n) {
+      result += useAnd ? ' et ' : ' '
+    }
+    result += integerToWords(centimes, false)
+    result += ' ' + (centimes === 1n ? CENTIME : CENTIMES)
   }
 
   return result
@@ -353,4 +519,4 @@ function toWords (value, options) {
 // Public API
 // ============================================================================
 
-export { toWords }
+export { toCardinal, toOrdinal, toCurrency }

package/src/gu-IN.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Converts a numeric value to Gujarati words.
+ *
+ * @param {number | string | bigint} value - The numeric value to convert
+ * @returns {string} The number in Gujarati words
+ */
+export function toCardinal(value: number | string | bigint): string;
+/**
+ * Converts a numeric value to Gujarati ordinal words.
+ *
+ * @param {number | string | bigint} value - The numeric value to convert (positive integer)
+ * @returns {string} The number as ordinal words
+ * @throws {TypeError} If value is not a valid numeric type
+ * @throws {RangeError} If value is negative, zero, or has a decimal part
+ *
+ * @example
+ * toOrdinal(1)    // 'પહેલું'
+ * toOrdinal(2)    // 'બીજું'
+ * toOrdinal(10)   // 'દસમું'
+ */
+export function toOrdinal(value: number | string | bigint): string;
+/**
+ * Converts a numeric value to Gujarati currency words (Indian Rupee).
+ *
+ * @param {number | string | bigint} value - The currency amount to convert
+ * @returns {string} The amount in Gujarati currency words
+ * @throws {TypeError} If value is not a valid numeric type
+ * @throws {Error} If value is not a valid number format
+ *
+ * @example
+ * toCurrency(42.50)  // 'બેતાળીસ રૂપિયા પચાસ પૈસા'
+ * toCurrency(1)      // 'એક રૂપિયો'
+ * toCurrency(0.01)   // 'એક પૈસો'
+ */
+export function toCurrency(value: number | string | bigint): string;

package/{lib/languages/gu.js → src/gu-IN.js}

@@ -1,7 +1,7 @@
 /**
- * Gujarati language converter - Functional Implementation
+ * Gujarati (India) language converter
  *
- * Self-contained module with its own input validation, ready for subpath exports.
+ * CLDR: gu-IN | Gujarati as used in India
  *
  * Key features:
  * - Indian numbering system (હજાર, લાખ, કરોડ)
@@ -11,7 +11,9 @@
  * - Per-digit decimal reading
  */
 
-import { parseNumericValue } from '../utils/parse-numeric.js'
+import { parseCardinalValue } from './utils/parse-cardinal.js'
+import { parseCurrencyValue } from './utils/parse-currency.js'
+import { parseOrdinalValue } from './utils/parse-ordinal.js'
 
 // ============================================================================
 // Vocabulary
@@ -22,6 +24,28 @@ const NEGATIVE = 'ઋણ'
 const DECIMAL_SEP = 'દશાંશ'
 const HUNDRED = 'સો'
 
+// ============================================================================
+// Ordinal Vocabulary
+// ============================================================================
+
+// Ordinal suffix (adds to cardinal for numbers >= 7)
+const ORDINAL_SUFFIX = 'મું'
+
+// Special ordinals for first few numbers (1-6 have irregular forms)
+const ORDINAL_SPECIAL = ['', 'પહેલું', 'બીજું', 'ત્રીજું', 'ચોથું', 'પાંચમું', 'છઠ્ઠું']
+
+// ============================================================================
+// Currency Vocabulary (Indian Rupee)
+// ============================================================================
+
+// Rupee: singular/plural
+const RUPEE = 'રૂપિયો'
+const RUPEES = 'રૂપિયા'
+
+// Paisa: singular/plural
+const PAISA = 'પૈસો'
+const PAISE = 'પૈસા'
+
 const BELOW_HUNDRED = [
   'શૂન્ય', 'એક', 'બે', 'ત્રણ', 'ચાર', 'પાંચ', 'છ', 'સાત', 'આઠ', 'નવ',
   'દસ', 'અગિયાર', 'બાર', 'તેર', 'ચૌદ', 'પંદર', 'સોળ', 'સત્તર', 'અઢાર', 'ઓગણીસ',
@@ -125,8 +149,8 @@ function decimalPartToWords (decimalPart) {
  * @param {number | string | bigint} value - The numeric value to convert
  * @returns {string} The number in Gujarati words
  */
-function toWords (value) {
-  const { isNegative, integerPart, decimalPart } = parseNumericValue(value)
+function toCardinal (value) {
+  const { isNegative, integerPart, decimalPart } = parseCardinalValue(value)
 
   let result = ''
 
@@ -143,8 +167,93 @@ function toWords (value) {
   return result
 }
 
+// ============================================================================
+// ORDINAL: toOrdinal(value)
+// ============================================================================
+
+/**
+ * Converts a positive integer to Gujarati ordinal words.
+ *
+ * Gujarati ordinals: First 6 are irregular, then add -મું suffix.
+ *
+ * @param {bigint} n - Positive integer to convert
+ * @returns {string} Gujarati ordinal words
+ */
+function integerToOrdinal (n) {
+  // Special ordinals for 1-6
+  if (n >= 1n && n <= 6n) {
+    return ORDINAL_SPECIAL[Number(n)]
+  }
+
+  // For 7 and above, add suffix to cardinal
+  const cardinal = integerToWords(n)
+  return cardinal + ORDINAL_SUFFIX
+}
+
+/**
+ * Converts a numeric value to Gujarati ordinal words.
+ *
+ * @param {number | string | bigint} value - The numeric value to convert (positive integer)
+ * @returns {string} The number as ordinal words
+ * @throws {TypeError} If value is not a valid numeric type
+ * @throws {RangeError} If value is negative, zero, or has a decimal part
+ *
+ * @example
+ * toOrdinal(1)    // 'પહેલું'
+ * toOrdinal(2)    // 'બીજું'
+ * toOrdinal(10)   // 'દસમું'
+ */
+function toOrdinal (value) {
+  const integerPart = parseOrdinalValue(value)
+  return integerToOrdinal(integerPart)
+}
+
+// ============================================================================
+// CURRENCY: toCurrency(value, options?)
+// ============================================================================
+
+/**
+ * Converts a numeric value to Gujarati currency words (Indian Rupee).
+ *
+ * @param {number | string | bigint} value - The currency amount to convert
+ * @returns {string} The amount in Gujarati currency words
+ * @throws {TypeError} If value is not a valid numeric type
+ * @throws {Error} If value is not a valid number format
+ *
+ * @example
+ * toCurrency(42.50)  // 'બેતાળીસ રૂપિયા પચાસ પૈસા'
+ * toCurrency(1)      // 'એક રૂપિયો'
+ * toCurrency(0.01)   // 'એક પૈસો'
+ */
+function toCurrency (value) {
+  const { isNegative, dollars: rupees, cents: paise } = parseCurrencyValue(value)
+
+  // Build result
+  let result = ''
+  if (isNegative) result = NEGATIVE + ' '
+
+  // Rupees part - show if non-zero, or if no paise
+  if (rupees > 0n || paise === 0n) {
+    result += integerToWords(rupees)
+    // Singular for 1 rupee, plural otherwise
+    result += ' ' + (rupees === 1n ? RUPEE : RUPEES)
+  }
+
+  // Paise part
+  if (paise > 0n) {
+    if (rupees > 0n) {
+      result += ' '
+    }
+    result += integerToWords(paise)
+    // Singular for 1 paisa, plural otherwise
+    result += ' ' + (paise === 1n ? PAISA : PAISE)
+  }
+
+  return result
+}
+
 // ============================================================================
 // Exports
 // ============================================================================
 
-export { toWords }
+export { toCardinal, toOrdinal, toCurrency }

package/src/ha-NG.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Converts a numeric value to Hausa words.
+ *
+ * @param {number | string | bigint} value - The numeric value to convert
+ * @returns {string} The number in Hausa words
+ */
+export function toCardinal(value: number | string | bigint): string;
+/**
+ * Converts a numeric value to Hausa ordinal words.
+ *
+ * @param {number | string | bigint} value - The numeric value to convert (positive integer)
+ * @returns {string} The number as ordinal words
+ * @throws {TypeError} If value is not a valid numeric type
+ * @throws {RangeError} If value is negative, zero, or has a decimal part
+ *
+ * @example
+ * toOrdinal(1)    // 'na farko'
+ * toOrdinal(2)    // 'na biyu'
+ * toOrdinal(10)   // 'na goma'
+ */
+export function toOrdinal(value: number | string | bigint): string;
+/**
+ * Converts a numeric value to Hausa currency words (Nigerian Naira).
+ *
+ * Uses naira and kobo (100 kobo = 1 naira).
+ *
+ * @param {number | string | bigint} value - The currency amount to convert
+ * @returns {string} The amount in Hausa currency words
+ * @throws {TypeError} If value is not a valid numeric type
+ * @throws {Error} If value is not a valid number format
+ *
+ * @example
+ * toCurrency(42)     // 'arba'in da biyu naira'
+ * toCurrency(1.50)   // 'ɗaya naira da hamsin kobo'
+ * toCurrency(-5)     // 'babu biyar naira'
+ */
+export function toCurrency(value: number | string | bigint): string;

package/{lib/languages/ha.js → src/ha-NG.js}

@@ -1,7 +1,7 @@
 /**
- * Hausa language converter - Functional Implementation
+ * Hausa (Nigeria) language converter
  *
- * Self-contained module with its own input validation, ready for subpath exports.
+ * CLDR: ha-NG | Hausa as used in Nigeria
  *
  * Key features:
  * - Authentic Boko orthography with ɗ (hooked d) and ' (glottal stop)
@@ -13,7 +13,9 @@
  * - Per-digit decimal reading
  */
 
-import { parseNumericValue } from '../utils/parse-numeric.js'
+import { parseCardinalValue } from './utils/parse-cardinal.js'
+import { parseCurrencyValue } from './utils/parse-currency.js'
+import { parseOrdinalValue } from './utils/parse-ordinal.js'
 
 // ============================================================================
 // Vocabulary
@@ -34,6 +36,22 @@ const DECIMAL_SEP = 'digo'
 // Short scale
 const SCALE_WORDS = ['', THOUSAND, 'miliyan', 'biliyan']
 
+// ============================================================================
+// Ordinal Vocabulary
+// ============================================================================
+
+// Hausa ordinals: "na" + cardinal (na ɗaya = 1st, na biyu = 2nd)
+// First has special form "na fari" or "farko"
+const ORDINAL_PREFIX = 'na'
+const ORDINAL_FIRST = 'na farko'
+
+// ============================================================================
+// Currency Vocabulary (Nigerian Naira)
+// ============================================================================
+
+const NAIRA = 'naira'
+const KOBO = 'kobo'
+
 // ============================================================================
 // Precomputed Lookup Table
 // ============================================================================
@@ -47,8 +65,8 @@ function buildSegment (n) {
   if (n === 0) return ''
 
   const ones = n % 10
-  const tensDigit = Math.floor(n / 10) % 10
-  const hundredsDigit = Math.floor(n / 100)
+  const tensDigit = Math.trunc(n / 10) % 10
+  const hundredsDigit = Math.trunc(n / 100)
 
   const parts = []
 
@@ -200,8 +218,8 @@ function decimalPartToWords (decimalPart) {
  * @param {number | string | bigint} value - The numeric value to convert
  * @returns {string} The number in Hausa words
  */
-function toWords (value) {
-  const { isNegative, integerPart, decimalPart } = parseNumericValue(value)
+function toCardinal (value) {
+  const { isNegative, integerPart, decimalPart } = parseCardinalValue(value)
 
   let result = ''
 
@@ -218,8 +236,89 @@ function toWords (value) {
   return result
 }
 
+// ============================================================================
+// ORDINAL: toOrdinal(value)
+// ============================================================================
+
+/**
+ * Converts a non-negative integer to Hausa ordinal words.
+ *
+ * Hausa ordinals: na farko (1st), na biyu (2nd), na uku (3rd), etc.
+ *
+ * @param {bigint} n - Positive integer to convert
+ * @returns {string} Hausa ordinal words
+ */
+function integerToOrdinal (n) {
+  // Special form for first
+  if (n === 1n) return ORDINAL_FIRST
+
+  // For 2+, use "na" prefix + cardinal
+  return ORDINAL_PREFIX + ' ' + integerToWords(n)
+}
+
+/**
+ * Converts a numeric value to Hausa ordinal words.
+ *
+ * @param {number | string | bigint} value - The numeric value to convert (positive integer)
+ * @returns {string} The number as ordinal words
+ * @throws {TypeError} If value is not a valid numeric type
+ * @throws {RangeError} If value is negative, zero, or has a decimal part
+ *
+ * @example
+ * toOrdinal(1)    // 'na farko'
+ * toOrdinal(2)    // 'na biyu'
+ * toOrdinal(10)   // 'na goma'
+ */
+function toOrdinal (value) {
+  const integerPart = parseOrdinalValue(value)
+  return integerToOrdinal(integerPart)
+}
+
+// ============================================================================
+// CURRENCY: toCurrency(value)
+// ============================================================================
+
+/**
+ * Converts a numeric value to Hausa currency words (Nigerian Naira).
+ *
+ * Uses naira and kobo (100 kobo = 1 naira).
+ *
+ * @param {number | string | bigint} value - The currency amount to convert
+ * @returns {string} The amount in Hausa currency words
+ * @throws {TypeError} If value is not a valid numeric type
+ * @throws {Error} If value is not a valid number format
+ *
+ * @example
+ * toCurrency(42)     // 'arba'in da biyu naira'
+ * toCurrency(1.50)   // 'ɗaya naira da hamsin kobo'
+ * toCurrency(-5)     // 'babu biyar naira'
+ */
+function toCurrency (value) {
+  const { isNegative, dollars: naira, cents: kobo } = parseCurrencyValue(value)
+
+  let result = ''
+  if (isNegative) {
+    result = NEGATIVE + ' '
+  }
+
+  // Naira part
+  if (naira > 0n || kobo === 0n) {
+    result += integerToWords(naira) + ' ' + NAIRA
+  }
+
+  // Kobo part
+  if (kobo > 0n) {
+    if (naira > 0n) {
+      result += ' da '
+    }
+    result += integerToWords(kobo) + ' ' + KOBO
+  }
+
+  return result
+}
+
 // ============================================================================
 // Exports
 // ============================================================================
 
-export { toWords }
+export { toCardinal, toOrdinal, toCurrency }

package/src/hbo-IL.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Converts a numeric value to Biblical Hebrew words.
+ *
+ * @param {number | string | bigint} value - The numeric value to convert
+ * @param {Object} [options] - Optional configuration
+ * @param {('masculine'|'feminine')} [options.gender='masculine'] - Grammatical gender
+ * @param {string} [options.andWord='ו'] - Custom conjunction word
+ * @returns {string} The number in Biblical Hebrew words
+ */
+export function toCardinal(value: number | string | bigint, options?: {
+    gender?: "masculine" | "feminine" | undefined;
+    andWord?: string | undefined;
+}): string;
+/**
+ * Converts a numeric value to Biblical Hebrew ordinal words.
+ *
+ * @param {number | string | bigint} value - The numeric value to convert
+ * @returns {string} The ordinal in Biblical Hebrew words
+ * @throws {TypeError} If value is not a valid numeric type
+ * @throws {Error} If value is not a positive integer
+ *
+ * @example
+ * toOrdinal(1)   // 'ראשון'
+ * toOrdinal(21)  // 'עשרים וראשון'
+ */
+export function toOrdinal(value: number | string | bigint): string;
+/**
+ * Converts a numeric value to Biblical Hebrew Shekel currency words.
+ *
+ * @param {number | string | bigint} value - The numeric value to convert
+ * @returns {string} The currency in Biblical Hebrew words
+ * @throws {TypeError} If value is not a valid numeric type
+ * @throws {Error} If value is not a valid number format
+ *
+ * @example
+ * toCurrency(1)     // 'שקל אחד'
+ * toCurrency(2.50)  // 'שניים שקלים חמישים גרות'
+ */
+export function toCurrency(value: number | string | bigint): string;