n2words 1.24.0 → 2.0.0

package/lib/languages/sv.js

@@ -1,24 +1,20 @@
-import GreedyScaleLanguage from '../classes/greedy-scale-language.js'
+import { GreedyScaleLanguage } from '../classes/greedy-scale-language.js'
 
 /**
  * Swedish language converter.
  *
- * Converts numbers to Swedish words, supporting:
- * - Negative numbers (prepended with "minus")
- * - Decimal numbers (word "komma" between whole and fractional parts)
- * - Numbers up to quadrillions
- *
- * Merge rules:
- * - Hyphenated for compound tens (e.g., "tjugo-tre")
- * - "och" (and) after hundreds (e.g., "hundra och ett")
- * - Space-separated for larger composites (e.g., "en miljon")
+ * Supports:
+ * - Hyphenation for compound tens (tjugo-tre)
+ * - "och" (and) after hundreds
+ * - Space-separated larger composites
  */
 export class Swedish extends GreedyScaleLanguage {
   negativeWord = 'minus'
   decimalSeparatorWord = 'komma'
   zeroWord = 'noll'
   wordSeparator = ' '
-  scaleWordPairs = [
+
+  scaleWords = [
     [1_000_000_000_000_000_000_000_000_000n, 'kvadriljon'],
     [1_000_000_000_000_000_000_000_000n, 'triljon'],
     [1_000_000_000_000_000_000_000n, 'biljon'],
@@ -58,70 +54,37 @@ export class Swedish extends GreedyScaleLanguage {
     [0n, 'noll']
   ]
 
-  /**
-   * Merges two adjacent word-number pairs according to Swedish grammar rules.
-   *
-   * Swedish-specific rules:
-   * - Implicit "ett": `mergeScales({ 'ett': 1n }, { 'hundra': 100n })` → `{ 'hundra': 100n }`
-   * - Hyphenated compounds: `mergeScales({ 'tjugo': 20n }, { 'tre': 3n })` → `{ 'tjugo-tre': 23n }`
-   * - "och" after hundreds: `mergeScales({ 'hundra': 100n }, { 'ett': 1n })` → `{ 'hundra och ett': 101n }`
-   * - "en" for millions: `mergeScales({ 'ett': 1n }, { 'miljon': 1000000n })` → `{ 'en miljon': 1000000n }`
-   *
-   * @param {Object} leftPair Left word-set as `{ word: BigInt }`.
-   * @param {Object} rightPair Right word-set as `{ word: BigInt }`.
-   * @returns {Object} Merged pair with combined word and resulting numeric value.
-   *
-   * @example
-   * mergeScales({ 'ett': 1n }, { 'hundra': 100n }); // { 'hundra': 100n }
-   * mergeScales({ 'tjugo': 20n }, { 'tre': 3n }); // { 'tjugo-tre': 23n }
-   */
-  mergeScales (leftPair, rightPair) {
-    const leftWord = Object.keys(leftPair)[0]
-    const rightWord = Object.keys(rightPair)[0]
-    const leftNumber = Object.values(leftPair)[0]
-    const rightNumber = Object.values(rightPair)[0]
+  /** Combines two word-sets according to Swedish grammar rules. */
+  combineWordSets (preceding, following) {
+    const precedingWord = Object.keys(preceding)[0]
+    const followingWord = Object.keys(following)[0]
+    const precedingValue = Object.values(preceding)[0]
+    const followingValue = Object.values(following)[0]
 
-    if (leftNumber === 1n && rightNumber < 100n) {
-      return rightPair
+    if (precedingValue === 1n && followingValue < 100n) {
+      return following
     }
 
     // Omit 'ett' before 'hundra' and 'tusen'
-    if (leftNumber === 1n && (rightNumber === 100n || rightNumber === 1000n)) {
-      return rightPair
+    if (precedingValue === 1n && (followingValue === 100n || followingValue === 1000n)) {
+      return following
     }
 
-    if (leftNumber < 100n && leftNumber > rightNumber) {
-      return { [`${leftWord}-${rightWord}`]: leftNumber + rightNumber }
+    if (precedingValue < 100n && precedingValue > followingValue) {
+      return { [`${precedingWord}-${followingWord}`]: precedingValue + followingValue }
     }
 
-    if (leftNumber >= 100n && rightNumber < 100n) {
-      return { [`${leftWord} och ${rightWord}`]: leftNumber + rightNumber }
+    if (precedingValue >= 100n && followingValue < 100n) {
+      return { [`${precedingWord} och ${followingWord}`]: precedingValue + followingValue }
     }
 
-    if (rightNumber > leftNumber) {
-      if (leftNumber === 1n && rightNumber >= 1_000_000n) {
-        return { [`en ${rightWord}`]: leftNumber * rightNumber }
+    if (followingValue > precedingValue) {
+      if (precedingValue === 1n && followingValue >= 1_000_000n) {
+        return { [`en ${followingWord}`]: precedingValue * followingValue }
       }
-      return { [`${leftWord} ${rightWord}`]: leftNumber * rightNumber }
+      return { [`${precedingWord} ${followingWord}`]: precedingValue * followingValue }
     }
 
-    return { [`${leftWord} ${rightWord}`]: leftNumber + rightNumber }
+    return { [`${precedingWord} ${followingWord}`]: precedingValue + followingValue }
   }
 }
-
-/**
- * Converts a number to Swedish cardinal (written) form.
- *
- * @param {number|string|bigint} value The number to convert.
- * @param {Object} [options] Conversion options (see Swedish class options).
- * @returns {string} The number expressed in Swedish words.
- * @throws {TypeError} If value is NaN or invalid type.
- * @throws {Error} If value is an invalid number string.
- *
- * @example
- * convertToWords(42); // 'fyrtio-två'
- * convertToWords('1.5'); // 'ett komma fem'
- */
-export default function convertToWords (value, options = {}) {
-  return new Swedish(options).convertToWords(value)
-}

package/lib/languages/sw.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Swahili language converter.
+ *
+ * Supports:
+ * - Swahili number words (moja, mbili, tatu)
+ * - Space-separated components
+ * - Simple decimal point notation
+ */
+export class Swahili extends AbstractLanguage {
+    onesWords: {
+        0: string;
+        1: string;
+        2: string;
+        3: string;
+        4: string;
+        5: string;
+        6: string;
+        7: string;
+        8: string;
+        9: string;
+    };
+    tensWords: {
+        10: string;
+        20: string;
+        30: string;
+        40: string;
+        50: string;
+        60: string;
+        70: string;
+        80: string;
+        90: string;
+    };
+    scaleWords: string[];
+    wordsUnder100(n: any): any;
+    wordsUnder1000(n: any): any;
+    splitBy3(number: any): number[];
+    integerToWords(integerPart: any): string;
+}
+import { AbstractLanguage } from '../classes/abstract-language.js';

package/lib/languages/sw.js

@@ -1,10 +1,19 @@
-import AbstractLanguage from '../classes/abstract-language.js'
+import { AbstractLanguage } from '../classes/abstract-language.js'
 
-class Swahili extends AbstractLanguage {
+/**
+ * Swahili language converter.
+ *
+ * Supports:
+ * - Swahili number words (moja, mbili, tatu)
+ * - Space-separated components
+ * - Simple decimal point notation
+ */
+export class Swahili extends AbstractLanguage {
   negativeWord = 'minus'
   decimalSeparatorWord = 'nukta'
   zeroWord = 'sifuri'
-  digits = {
+
+  onesWords = {
     0: 'sifuri',
     1: 'moja',
     2: 'mbili',
@@ -17,7 +26,7 @@ class Swahili extends AbstractLanguage {
     9: 'tisa'
   }
 
-  tens = {
+  tensWords = {
     10: 'kumi',
     20: 'ishirini',
     30: 'thelathini',
@@ -29,7 +38,7 @@ class Swahili extends AbstractLanguage {
     90: 'tisini'
   }
 
-  scales = [
+  scaleWords = [
     '',
     'elfu',
     'milioni',
@@ -38,16 +47,16 @@ class Swahili extends AbstractLanguage {
   ]
 
   wordsUnder100 (n) {
-    if (n < 10) return this.digits[n]
-    if (n === 10) return this.tens[10]
+    if (n < 10) return this.onesWords[n]
+    if (n === 10) return this.tensWords[10]
     if (n < 20) {
       // 11-19: 'kumi na <digit>'
-      return this.tens[10] + ' na ' + this.digits[n - 10]
+      return this.tensWords[10] + ' na ' + this.onesWords[n - 10]
     }
     const tens = Math.trunc(n / 10) * 10
     const ones = n % 10
-    if (ones === 0) return this.tens[tens]
-    return this.tens[tens] + ' na ' + this.digits[ones]
+    if (ones === 0) return this.tensWords[tens]
+    return this.tensWords[tens] + ' na ' + this.onesWords[ones]
   }
 
   wordsUnder1000 (n) {
@@ -58,10 +67,10 @@ class Swahili extends AbstractLanguage {
     const parts = []
 
     // Hundreds: 'mia <digit>'
-    parts.push('mia ' + this.digits[hundreds])
+    parts.push('mia ' + this.onesWords[hundreds])
     if (rest > 0) {
       if (rest < 10) {
-        parts.push('na ' + this.digits[rest])
+        parts.push('na ' + this.onesWords[rest])
       } else {
         parts.push(this.wordsUnder100(rest))
       }
@@ -85,10 +94,10 @@ class Swahili extends AbstractLanguage {
     return groups
   }
 
-  convertWholePart (number) {
-    if (number === 0n) return this.zeroWord
+  integerToWords (integerPart) {
+    if (integerPart === 0n) return this.zeroWord
 
-    const groups = this.splitBy3(number)
+    const groups = this.splitBy3(integerPart)
     const parts = []
 
     for (let i = 0; i < groups.length; i++) {
@@ -98,7 +107,7 @@ class Swahili extends AbstractLanguage {
       // scale word
       if (scaleIndex === 0) {
         if (val < 10 && parts.length > 0) {
-          parts.push('na ' + this.digits[val])
+          parts.push('na ' + this.onesWords[val])
         } else if (val === 100 && parts.length > 0) {
           // In compound numbers (e.g., 1100 -> 'elfu moja mia'), use 'mia' not 'mia moja'
           parts.push('mia')
@@ -108,14 +117,10 @@ class Swahili extends AbstractLanguage {
       } else {
         // e.g., 'elfu moja', 'milioni mbili'
         const unit = (val === 1) ? 'moja' : this.wordsUnder1000(val)
-        parts.push(this.scales[scaleIndex] + ' ' + unit)
+        parts.push(this.scaleWords[scaleIndex] + ' ' + unit)
       }
     }
 
     return parts.join(' ').trim()
   }
 }
-
-export default function convertToWords (value, options = {}) {
-  return new Swahili(options).convertToWords(value)
-}

package/lib/languages/ta.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Tamil language converter.
+ *
+ * Supports:
+ * - Tamil numbering system
+ * - Tamil script
+ * - Complete word forms for 0-99
+ */
+export class Tamil extends AbstractLanguage {
+    belowHundredWords: string[];
+    hundredsWords: string[];
+    onesWords: string[];
+    scaleWords: string[];
+    /** Convert numbers below 100 to Tamil words. */
+    convertBelowHundred(number: any): string;
+    convertBelowThousand(number: any): string;
+    splitIndian(number: any): number[];
+    integerToWords(integerPart: any): string;
+}
+import { AbstractLanguage } from '../classes/abstract-language.js';

package/lib/languages/ta.js

@@ -1,11 +1,20 @@
-import AbstractLanguage from '../classes/abstract-language.js'
-
-class Tamil extends AbstractLanguage {
+import { AbstractLanguage } from '../classes/abstract-language.js'
+
+/**
+ * Tamil language converter.
+ *
+ * Supports:
+ * - Tamil numbering system
+ * - Tamil script
+ * - Complete word forms for 0-99
+ */
+export class Tamil extends AbstractLanguage {
   negativeWord = 'மைனஸ்'
   decimalSeparatorWord = 'புள்ளி'
   zeroWord = 'பூஜ்ஜியம்'
-  convertDecimalsPerDigit = true // Enable digit-by-digit decimal conversion
-  belowHundred = [
+  usePerDigitDecimals = true // Enable digit-by-digit decimal conversion
+
+  belowHundredWords = [
     'பூஜ்ஜியம்',
     'ஒன்று',
     'இரண்டு',
@@ -108,7 +117,7 @@ class Tamil extends AbstractLanguage {
     'தொண்ணூற்று ஒன்பது'
   ]
 
-  hundreds = [
+  hundredsWords = [
     '',
     'நூறு',
     'இருநூறு',
@@ -121,8 +130,8 @@ class Tamil extends AbstractLanguage {
     'தொள்ளாயிரம்'
   ]
 
-  // Digits map 1–9 for decimal reading
-  digits = [
+  // Ones words map 1–9 for decimal reading
+  onesWords = [
     'ஒன்று',
     'இரண்டு',
     'மூன்று',
@@ -134,7 +143,7 @@ class Tamil extends AbstractLanguage {
     'ஒன்பது'
   ]
 
-  scales = [
+  scaleWords = [
     '',
     'ஆயிரம்',
     'லட்சம்',
@@ -146,14 +155,9 @@ class Tamil extends AbstractLanguage {
     'சங்கு'
   ]
 
-  /**
-   * Convert numbers below 100 to Tamil words.
-   *
-   * @param {number} number The number to convert (0-99).
-   * @returns {string} The Tamil representation.
-   */
+  /** Convert numbers below 100 to Tamil words. */
   convertBelowHundred (number) {
-    return this.belowHundred[number]
+    return this.belowHundredWords[number]
   }
 
   convertBelowThousand (number) {
@@ -162,7 +166,7 @@ class Tamil extends AbstractLanguage {
 
     const hundreds = Math.trunc(number / 100)
     const remainder = number % 100
-    let hundredPart = this.hundreds[hundreds]
+    let hundredPart = this.hundredsWords[hundreds]
 
     if (remainder > 0) {
       if (hundredPart.endsWith('ம்')) {
@@ -198,10 +202,10 @@ class Tamil extends AbstractLanguage {
     return groups
   }
 
-  convertWholePart (number) {
-    if (number === 0n) return this.zeroWord
+  integerToWords (integerPart) {
+    if (integerPart === 0n) return this.zeroWord
 
-    const groups = this.splitIndian(number)
+    const groups = this.splitIndian(integerPart)
     const groupCount = groups.length
     const words = []
 
@@ -212,15 +216,11 @@ class Tamil extends AbstractLanguage {
       const scaleIndex = groupCount - i - 1
       const groupWords = (groupValue === 1 && scaleIndex > 0) ? 'ஒரு' : this.convertBelowThousand(groupValue)
       words.push(groupWords)
-      if (scaleIndex > 0 && this.scales[scaleIndex]) {
-        words.push(this.scales[scaleIndex])
+      if (scaleIndex > 0 && this.scaleWords[scaleIndex]) {
+        words.push(this.scaleWords[scaleIndex])
       }
     }
 
     return words.join(' ').trim()
   }
 }
-
-export default function convertToWords (value, options = {}) {
-  return new Tamil(options).convertToWords(value)
-}

package/lib/languages/te.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Telugu language converter.
+ *
+ * Supports:
+ * - Telugu numbering system
+ * - Telugu script
+ * - Complete word forms for 0-99
+ */
+export class Telugu extends AbstractLanguage {
+    belowHundredWords: string[];
+    hundredsWords: string[];
+    onesWords: string[];
+    scaleWords: string[];
+    /** Convert numbers below 100 to Telugu words. */
+    convertBelowHundred(number: any): string;
+    /** Convert numbers below 1000 to Telugu words. */
+    convertBelowThousand(number: any): string;
+    /** Split a number using Indian-style grouping (3-2-2 digits from right). */
+    splitIndian(number: any): number[];
+    integerToWords(integerPart: any): string;
+}
+import { AbstractLanguage } from '../classes/abstract-language.js';

package/lib/languages/te.js

@@ -1,11 +1,20 @@
-import AbstractLanguage from '../classes/abstract-language.js'
-
-class Telugu extends AbstractLanguage {
+import { AbstractLanguage } from '../classes/abstract-language.js'
+
+/**
+ * Telugu language converter.
+ *
+ * Supports:
+ * - Telugu numbering system
+ * - Telugu script
+ * - Complete word forms for 0-99
+ */
+export class Telugu extends AbstractLanguage {
   negativeWord = 'మైనస్'
   decimalSeparatorWord = 'పాయింట్'
   zeroWord = 'సున్నా'
-  convertDecimalsPerDigit = true // Enable digit-by-digit decimal conversion
-  belowHundred = [
+  usePerDigitDecimals = true // Enable digit-by-digit decimal conversion
+
+  belowHundredWords = [
     'సున్నా',
     'ఒకటి',
     'రెండు',
@@ -108,7 +117,7 @@ class Telugu extends AbstractLanguage {
     'తొంభై తొమ్మిది'
   ]
 
-  hundreds = [
+  hundredsWords = [
     '',
     'వంద',
     'రెండు వందలు',
@@ -121,8 +130,8 @@ class Telugu extends AbstractLanguage {
     'తొమ్మిది వందలు'
   ]
 
-  // Digits map 1–9 for decimal reading
-  digits = [
+  // Ones words map 1–9 for decimal reading
+  onesWords = [
     'ఒకటి',
     'రెండు',
     'మూడు',
@@ -134,7 +143,7 @@ class Telugu extends AbstractLanguage {
     'తొమ్మిది'
   ]
 
-  scales = [
+  scaleWords = [
     '',
     'వెయ్యి',
     'లక్ష',
@@ -146,29 +155,19 @@ class Telugu extends AbstractLanguage {
     'శంకు'
   ]
 
-  /**
-   * Convert numbers below 100 to Telugu words.
-   *
-   * @param {number} number The number to convert (0-99).
-   * @returns {string} The Telugu representation.
-   */
+  /** Convert numbers below 100 to Telugu words. */
   convertBelowHundred (number) {
-    return this.belowHundred[number]
+    return this.belowHundredWords[number]
   }
 
-  /**
-   * Convert numbers below 1000 to Telugu words.
-   *
-   * @param {number} number The number to convert (0-999).
-   * @returns {string} The Telugu representation.
-   */
+  /** Convert numbers below 1000 to Telugu words. */
   convertBelowThousand (number) {
     if (number === 0) return ''
     if (number < 100) return this.convertBelowHundred(number)
 
     const hundreds = Math.trunc(number / 100)
     const remainder = number % 100
-    const parts = [this.hundreds[hundreds]]
+    const parts = [this.hundredsWords[hundreds]]
 
     if (remainder > 0) {
       parts.push(this.convertBelowHundred(remainder))
@@ -177,12 +176,7 @@ class Telugu extends AbstractLanguage {
     return parts.join(' ').trim()
   }
 
-  /**
-   * Split a number using Indian-style grouping (3-2-2 digits from right).
-   *
-   * @param {bigint} number The number to split.
-   * @returns {number[]} Array of number groups.
-   */
+  /** Split a number using Indian-style grouping (3-2-2 digits from right). */
   splitIndian (number) {
     const numStr = number.toString()
     if (numStr.length <= 3) return [Number(numStr)]
@@ -201,10 +195,10 @@ class Telugu extends AbstractLanguage {
     return groups
   }
 
-  convertWholePart (number) {
-    if (number === 0n) return this.zeroWord
+  integerToWords (integerPart) {
+    if (integerPart === 0n) return this.zeroWord
 
-    const groups = this.splitIndian(number)
+    const groups = this.splitIndian(integerPart)
     const groupCount = groups.length
     const words = []
 
@@ -215,15 +209,11 @@ class Telugu extends AbstractLanguage {
       const scaleIndex = groupCount - i - 1
       const groupWords = (groupValue === 1 && scaleIndex > 0) ? 'ఒక' : this.convertBelowThousand(groupValue)
       words.push(groupWords)
-      if (scaleIndex > 0 && this.scales[scaleIndex]) {
-        words.push(this.scales[scaleIndex])
+      if (scaleIndex > 0 && this.scaleWords[scaleIndex]) {
+        words.push(this.scaleWords[scaleIndex])
       }
     }
 
     return words.join(' ').trim()
   }
 }
-
-export default function convertToWords (value, options = {}) {
-  return new Telugu(options).convertToWords(value)
-}

package/lib/languages/th.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Thai language converter.
+ *
+ * Supports:
+ * - Thai numerals (ศูนย์, หนึ่ง, สอง, สาม)
+ * - No word separators (continuous Thai script)
+ * - Digit-by-digit decimal reading
+ */
+export class Thai extends AbstractLanguage {
+    onesWords: string[];
+    /** Converts numbers below one million to Thai words. */
+    convertBelowMillion(number: any): string;
+    /** Split a number into million-sized groups for processing. */
+    splitMillionGroups(number: any): number[];
+    integerToWords(integerPart: any): string;
+}
+import { AbstractLanguage } from '../classes/abstract-language.js';