n2words 3.1.0 → 4.0.0

package/lib/languages/fa.js

@@ -1,134 +0,0 @@
-/**
- * Persian language converter - Functional Implementation
- *
- * Self-contained converter using recursive decomposition.
- *
- * Key features:
- * - "و" (and) conjunction for compound numbers
- * - Omit "یک" (one) before thousand
- * - Pre-composed hundreds (دویست, سيصد, etc.)
- */
-
-import { parseNumericValue } from '../utils/parse-numeric.js'
-
-// ============================================================================
-// Vocabulary
-// ============================================================================
-
-const ONES = { 1: 'یک', 2: 'دو', 3: 'سه', 4: 'چهار', 5: 'پنج', 6: 'شش', 7: 'هفت', 8: 'هشت', 9: 'نه' }
-const TEENS = { 10: 'ده', 11: 'یازده', 12: 'دوازده', 13: 'سیزده', 14: 'چهارده', 15: 'پانزده', 16: 'شانزده', 17: 'هفده', 18: 'هجده', 19: 'نوزده' }
-const TENS = { 20: 'بیست', 30: 'سی', 40: 'چهل', 50: 'پنجاه', 60: 'شصت', 70: 'هفتاد', 80: 'هشتاد', 90: 'نود' }
-const HUNDREDS = { 100: 'صد', 200: 'دویست', 300: 'سيصد', 400: 'چهار صد', 500: 'پانصد', 600: 'ششصد', 700: 'هفتصد', 800: 'هشتصد', 900: 'نهصد' }
-
-const THOUSAND = 'هزار'
-const MILLION = 'میلیون'
-
-const ZERO = 'صفر'
-const NEGATIVE = 'منفى'
-const DECIMAL_SEP = 'ممیّز'
-
-// ============================================================================
-// Conversion Functions
-// ============================================================================
-
-function integerToWords (n) {
-  if (n === 0n) return ZERO
-
-  // 1-9
-  if (n <= 9n) {
-    return ONES[Number(n)]
-  }
-
-  // 10-19
-  if (n <= 19n) {
-    return TEENS[Number(n)]
-  }
-
-  // 20-99
-  if (n < 100n) {
-    const ones = n % 10n
-    const tens = n - ones
-    if (ones === 0n) {
-      return TENS[Number(tens)]
-    }
-    return `${TENS[Number(tens)]} و ${ONES[Number(ones)]}`
-  }
-
-  // 100-999
-  if (n < 1000n) {
-    const hundreds = 100n * (n / 100n)
-    const remainder = n - hundreds
-    if (remainder === 0n) {
-      return HUNDREDS[Number(hundreds)]
-    }
-    return `${HUNDREDS[Number(hundreds)]} و ${integerToWords(remainder)}`
-  }
-
-  // 1000-999999
-  if (n < 1_000_000n) {
-    const thousandMultiplier = n / 1000n
-    // Persian omits "one" before thousand: 1000 is just "هزار", not "یک هزار"
-    const thousandPrefix = thousandMultiplier === 1n
-      ? ''
-      : integerToWords(thousandMultiplier) + ' '
-    const remainder = n % 1000n
-    const suffix = remainder === 0n ? '' : ' ' + integerToWords(remainder)
-    return `${thousandPrefix}${THOUSAND}${suffix}`
-  }
-
-  // 1000000+
-  const millionMultiplier = n / 1_000_000n
-  const millionPrefix = integerToWords(millionMultiplier) + ' ' + MILLION
-  const remainder = n % 1_000_000n
-  const suffix = remainder === 0n ? '' : ' و ' + integerToWords(remainder)
-  return `${millionPrefix}${suffix}`
-}
-
-function decimalPartToWords (decimalPart) {
-  let result = ''
-  let i = 0
-
-  while (i < decimalPart.length && decimalPart[i] === '0') {
-    if (result) result += ' '
-    result += ZERO
-    i++
-  }
-
-  const remainder = decimalPart.slice(i)
-  if (remainder) {
-    if (result) result += ' '
-    result += integerToWords(BigInt(remainder))
-  }
-
-  return result
-}
-
-/**
- * Converts a numeric value to Persian words.
- *
- * @param {number | string | bigint} value - The numeric value to convert
- * @returns {string} The number in Persian words
- */
-function toWords (value) {
-  const { isNegative, integerPart, decimalPart } = parseNumericValue(value)
-
-  let result = ''
-
-  if (isNegative) {
-    result = NEGATIVE + ' '
-  }
-
-  result += integerToWords(integerPart)
-
-  if (decimalPart) {
-    result += ' ' + DECIMAL_SEP + ' ' + decimalPartToWords(decimalPart)
-  }
-
-  return result
-}
-
-// ============================================================================
-// Exports
-// ============================================================================
-
-export { toWords }

package/lib/languages/fi.d.ts

@@ -1,14 +0,0 @@
-/**
- * Converts a numeric value to Finnish words.
- *
- * @param {number | string | bigint} value - The numeric value to convert
- * @returns {string} The number in Finnish words
- * @throws {TypeError} If value is not a valid numeric type
- * @throws {Error} If value is not a valid number format
- *
- * @example
- * toWords(21)       // 'kaksikymmentäyksi'
- * toWords(1000)     // 'tuhat'
- * toWords('3.14')   // 'kolme pilkku yksi neljä'
- */
-export function toWords(value: number | string | bigint): string;

package/lib/languages/fil.d.ts

@@ -1,7 +0,0 @@
-/**
- * Converts a numeric value to Filipino words.
- *
- * @param {number | string | bigint} value - The numeric value to convert
- * @returns {string} The number in Filipino words
- */
-export function toWords(value: number | string | bigint): string;

package/lib/languages/fr-BE.d.ts

@@ -1,11 +0,0 @@
-/**
- * Converts a numeric value to Belgian French words.
- *
- * @param {number | string | bigint} value - The numeric value to convert
- * @param {Object} [options] - Optional configuration
- * @param {boolean} [options.withHyphenSeparator=false] - Use hyphens between words
- * @returns {string} The number in Belgian French words
- */
-export function toWords(value: number | string | bigint, options?: {
-    withHyphenSeparator?: boolean | undefined;
-}): string;

package/lib/languages/fr.d.ts

@@ -1,21 +0,0 @@
-/**
- * Converts a numeric value to French words.
- *
- * This is the main public API. It accepts any valid numeric input
- * (number, string, or bigint) and handles parsing internally.
- *
- * @param {number | string | bigint} value - The numeric value to convert
- * @param {Object} [options] - Optional configuration
- * @param {boolean} [options.withHyphenSeparator=false] - Use hyphens between all words
- * @returns {string} The number in French words
- * @throws {TypeError} If value is not a valid numeric type
- * @throws {Error} If value is not a valid number format
- *
- * @example
- * toWords(21)           // 'vingt et un'
- * toWords(80)           // 'quatre-vingts'
- * toWords(1000000)      // 'un million'
- */
-export function toWords(value: number | string | bigint, options?: {
-    withHyphenSeparator?: boolean | undefined;
-}): string;

package/lib/languages/gu.d.ts

@@ -1,7 +0,0 @@
-/**
- * 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 toWords(value: number | string | bigint): string;

package/lib/languages/ha.d.ts

@@ -1,7 +0,0 @@
-/**
- * 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 toWords(value: number | string | bigint): string;

package/lib/languages/hbo.d.ts

@@ -1,13 +0,0 @@
-/**
- * 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 toWords(value: number | string | bigint, options?: {
-    gender?: "masculine" | "feminine" | undefined;
-    andWord?: string | undefined;
-}): string;

package/lib/languages/he.d.ts

@@ -1,13 +0,0 @@
-/**
- * Converts a numeric value to Modern 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 Modern Hebrew words
- */
-export function toWords(value: number | string | bigint, options?: {
-    gender?: "masculine" | "feminine" | undefined;
-    andWord?: string | undefined;
-}): string;

package/lib/languages/he.js

@@ -1,265 +0,0 @@
-/**
- * Modern Hebrew language converter - Functional Implementation
- *
- * Self-contained module with its own input validation, ready for subpath exports.
- *
- * Key features:
- * - Feminine grammatical forms (default in Modern Hebrew)
- * - Dual forms for 2, 200, 2000
- * - Special 1-9 thousands construct state
- * - "ו" (ve) conjunction rules vary by position
- * - Per-digit decimal reading
- */
-
-import { parseNumericValue } from '../utils/parse-numeric.js'
-import { validateOptions } from '../utils/validate-options.js'
-
-// ============================================================================
-// Vocabulary (arrays for indexed access - faster than object property lookup)
-// ============================================================================
-
-// Feminine forms (default in Modern Hebrew) - index 0 unused
-const ONES = ['', 'אחת', 'שתים', 'שלש', 'ארבע', 'חמש', 'שש', 'שבע', 'שמונה', 'תשע']
-const TEENS = ['עשר', 'אחת עשרה', 'שתים עשרה', 'שלש עשרה', 'ארבע עשרה', 'חמש עשרה', 'שש עשרה', 'שבע עשרה', 'שמונה עשרה', 'תשע עשרה']
-const TENS = ['', '', 'עשרים', 'שלשים', 'ארבעים', 'חמישים', 'ששים', 'שבעים', 'שמונים', 'תשעים']
-const HUNDREDS = ['', 'מאה', 'מאתיים', 'שלש מאות', 'ארבע מאות', 'חמש מאות', 'שש מאות', 'שבע מאות', 'שמונה מאות', 'תשע מאות']
-
-// Special forms for 1-9 thousand (index 0 unused)
-const THOUSANDS_SPECIAL = ['', 'אלף', 'אלפיים', 'שלשת אלפים', 'ארבעת אלפים', 'חמשת אלפים', 'ששת אלפים', 'שבעת אלפים', 'שמונת אלפים', 'תשעת אלפים']
-
-// Scale words (index 1 = thousands, 2 = millions, etc.)
-const SCALE = ['', 'אלף', 'מיליון', 'מיליארד', 'טריליון', 'קוודרליון', 'קווינטיליון']
-const SCALE_PLURAL = ['', 'אלפים', 'מיליונים', 'מיליארדים', 'טריליונים', 'קוודרליונים', 'קווינטיליונים']
-
-const ZERO = 'אפס'
-const NEGATIVE = 'מינוס'
-const DECIMAL_SEP = 'נקודה'
-
-// ============================================================================
-// Segment Building
-// ============================================================================
-
-/**
- * Builds segment word for scale segments (thousands, millions, etc.).
- * "ו" is added before tens and ones when following hundreds.
- */
-function buildScaleSegment (n, andWord) {
-  if (n === 0) return ''
-
-  const ones = n % 10
-  const tens = Math.floor(n / 10) % 10
-  const hundreds = Math.floor(n / 100)
-
-  let result = ''
-
-  // Hundreds
-  if (hundreds > 0) {
-    result = HUNDREDS[hundreds]
-  }
-
-  // Tens and ones
-  if (tens === 1) {
-    // Teens (10-19)
-    const teenWord = TEENS[ones]
-    if (result) {
-      result += ' ' + andWord + teenWord
-    } else {
-      result = teenWord
-    }
-  } else {
-    // Tens (20-90)
-    if (tens >= 2) {
-      if (result) {
-        result += ' ' + andWord + TENS[tens]
-      } else {
-        result = TENS[tens]
-      }
-    }
-
-    // Ones
-    if (ones > 0) {
-      if (result) {
-        result += ' ' + andWord + ONES[ones]
-      } else {
-        result = ONES[ones]
-      }
-    }
-  }
-
-  return result
-}
-
-/**
- * Builds segment word for units segment (no scale word).
- * "ו" is only added before the final ones digit.
- */
-function buildUnitsSegment (n, andWord) {
-  if (n === 0) return ''
-
-  const ones = n % 10
-  const tens = Math.floor(n / 10) % 10
-  const hundreds = Math.floor(n / 100)
-
-  let result = ''
-
-  // Hundreds
-  if (hundreds > 0) {
-    result = HUNDREDS[hundreds]
-  }
-
-  // Tens (no conjunction)
-  if (tens === 1) {
-    // Teens (10-19)
-    if (result) {
-      result += ' ' + TEENS[ones]
-    } else {
-      result = TEENS[ones]
-    }
-  } else {
-    if (tens >= 2) {
-      if (result) {
-        result += ' ' + TENS[tens]
-      } else {
-        result = TENS[tens]
-      }
-    }
-
-    // Ones - conjunction only here
-    if (ones > 0) {
-      if (result) {
-        result += ' ' + andWord + ONES[ones]
-      } else {
-        result = ONES[ones]
-      }
-    }
-  }
-
-  return result
-}
-
-// ============================================================================
-// Conversion Functions
-// ============================================================================
-
-/**
- * Converts a non-negative integer to Hebrew words.
- *
- * @param {bigint} n - Non-negative integer to convert
- * @param {Object} options - Conversion options
- * @returns {string} Hebrew words
- */
-function integerToWords (n, options) {
-  if (n === 0n) return ZERO
-
-  const andWord = options.andWord ?? 'ו'
-
-  // Fast path: numbers < 1000
-  if (n < 1000n) {
-    return buildUnitsSegment(Number(n), andWord)
-  }
-
-  // Extract segments using BigInt modulo
-  const segments = []
-  let temp = n
-  while (temp > 0n) {
-    segments.push(Number(temp % 1000n))
-    temp = temp / 1000n
-  }
-
-  // Build result string directly
-  let result = ''
-
-  for (let i = segments.length - 1; i >= 0; i--) {
-    const segment = segments[i]
-    if (segment === 0) continue
-
-    if (i === 0) {
-      // Units segment (no scale word)
-      const segmentWord = buildUnitsSegment(segment, andWord)
-      if (result) {
-        // Add "ו" before single-digit units when following scale words
-        if (segment <= 9) {
-          result += ' ' + andWord + segmentWord
-        } else {
-          result += ' ' + segmentWord
-        }
-      } else {
-        result = segmentWord
-      }
-    } else if (i === 1) {
-      // Thousands - special handling for 1-9
-      if (segment <= 9) {
-        if (result) result += ' '
-        result += THOUSANDS_SPECIAL[segment]
-      } else {
-        const segmentWord = buildScaleSegment(segment, andWord)
-        if (result) result += ' '
-        result += segmentWord + ' ' + SCALE[1]
-      }
-    } else {
-      // Millions and above
-      if (segment === 1) {
-        if (result) result += ' '
-        result += SCALE[i]
-      } else {
-        const segmentWord = buildScaleSegment(segment, andWord)
-        if (result) result += ' '
-        result += segmentWord + ' ' + SCALE_PLURAL[i]
-      }
-    }
-  }
-
-  return result
-}
-
-/**
- * Converts decimal digits to Hebrew words (digit by digit).
- *
- * @param {string} decimalPart - Decimal digits (without the point)
- * @returns {string} Hebrew words for decimal part
- */
-function decimalPartToWords (decimalPart) {
-  let result = ''
-
-  for (let i = 0; i < decimalPart.length; i++) {
-    const d = parseInt(decimalPart[i], 10)
-    if (result) result += ' '
-    result += d === 0 ? ZERO : ONES[d]
-  }
-
-  return result
-}
-
-/**
- * Converts a numeric value to Modern 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 Modern Hebrew words
- */
-function toWords (value, options) {
-  options = validateOptions(options)
-  const { isNegative, integerPart, decimalPart } = parseNumericValue(value)
-
-  let result = ''
-
-  if (isNegative) {
-    result = NEGATIVE + ' '
-  }
-
-  result += integerToWords(integerPart, options)
-
-  if (decimalPart) {
-    result += ' ' + DECIMAL_SEP + ' ' + decimalPartToWords(decimalPart)
-  }
-
-  return result
-}
-
-// ============================================================================
-// Exports
-// ============================================================================
-
-export { toWords }

package/lib/languages/hi.d.ts

@@ -1,7 +0,0 @@
-/**
- * Converts a numeric value to Hindi words.
- *
- * @param {number | string | bigint} value - The numeric value to convert
- * @returns {string} The number in Hindi words
- */
-export function toWords(value: number | string | bigint): string;

package/lib/languages/hr.d.ts

@@ -1,11 +0,0 @@
-/**
- * Converts a numeric value to Croatian words.
- *
- * @param {number | string | bigint} value - The numeric value to convert
- * @param {Object} [options] - Optional configuration
- * @param {('masculine'|'feminine')} [options.gender='masculine'] - Grammatical gender
- * @returns {string} The number in Croatian words
- */
-export function toWords(value: number | string | bigint, options?: {
-    gender?: "masculine" | "feminine" | undefined;
-}): string;