n2words 1.24.0 → 2.0.0

package/lib/languages/th.js

@@ -1,21 +1,24 @@
-import AbstractLanguage from '../classes/abstract-language.js'
-
-class Thai extends AbstractLanguage {
+import { AbstractLanguage } from '../classes/abstract-language.js'
+
+/**
+ * Thai language converter.
+ *
+ * Supports:
+ * - Thai numerals (ศูนย์, หนึ่ง, สอง, สาม)
+ * - No word separators (continuous Thai script)
+ * - Digit-by-digit decimal reading
+ */
+export class Thai extends AbstractLanguage {
   negativeWord = 'ลบ'
   decimalSeparatorWord = 'จุด'
   zeroWord = 'ศูนย์'
   wordSeparator = ''
-  convertDecimalsPerDigit = true // Enable digit-by-digit decimal conversion
+  usePerDigitDecimals = true // Enable digit-by-digit decimal conversion
 
-  // Digits map 1–9
-  digits = ['หนึ่ง', 'สอง', 'สาม', 'สี่', 'ห้า', 'หก', 'เจ็ด', 'แปด', 'เก้า']
+  // Ones words map 1–9
+  onesWords = ['หนึ่ง', 'สอง', 'สาม', 'สี่', 'ห้า', 'หก', 'เจ็ด', 'แปด', 'เก้า']
 
-  /**
-   * Convert numbers below one million to Thai words.
-   *
-   * @param {number} number The number to convert (0-999999).
-   * @returns {string} The Thai representation.
-   */
+  /** Converts numbers below one million to Thai words. */
   convertBelowMillion (number) {
     if (number === 0) return ''
 
@@ -34,23 +37,23 @@ class Thai extends AbstractLanguage {
     const ones = value % 10
 
     if (hundredThousands > 0) {
-      parts.push(this.digits[hundredThousands - 1] + 'แสน')
+      parts.push(this.onesWords[hundredThousands - 1] + 'แสน')
     }
 
     if (tenThousands > 0) {
       if (tenThousands === 1) {
         parts.push('หนึ่งหมื่น')
       } else {
-        parts.push(this.digits[tenThousands - 1] + 'หมื่น')
+        parts.push(this.onesWords[tenThousands - 1] + 'หมื่น')
       }
     }
 
     if (thousands > 0) {
-      parts.push(this.digits[thousands - 1] + 'พัน')
+      parts.push(this.onesWords[thousands - 1] + 'พัน')
     }
 
     if (hundreds > 0) {
-      parts.push(this.digits[hundreds - 1] + 'ร้อย')
+      parts.push(this.onesWords[hundreds - 1] + 'ร้อย')
     }
 
     if (tens > 0) {
@@ -59,7 +62,7 @@ class Thai extends AbstractLanguage {
       } else if (tens === 2) {
         parts.push('ยี่สิบ')
       } else {
-        parts.push(this.digits[tens - 1] + 'สิบ')
+        parts.push(this.onesWords[tens - 1] + 'สิบ')
       }
     }
 
@@ -68,19 +71,14 @@ class Thai extends AbstractLanguage {
       if (ones === 1 && (tens > 0 || hasHigher)) {
         parts.push('เอ็ด')
       } else {
-        parts.push(this.digits[ones - 1])
+        parts.push(this.onesWords[ones - 1])
       }
     }
 
     return parts.join('')
   }
 
-  /**
-   * Split a number into million-sized groups for processing.
-   *
-   * @param {bigint} number The number to split.
-   * @returns {number[]} Array of number groups.
-   */
+  /** Split a number into million-sized groups for processing. */
   splitMillionGroups (number) {
     const groups = []
     let remaining = number
@@ -95,12 +93,12 @@ class Thai extends AbstractLanguage {
     return groups
   }
 
-  convertWholePart (number) {
-    if (number === 0n) {
+  integerToWords (integerPart) {
+    if (integerPart === 0n) {
       return this.zeroWord
     }
 
-    const groups = this.splitMillionGroups(number)
+    const groups = this.splitMillionGroups(integerPart)
     const parts = []
 
     for (let i = 0; i < groups.length; i++) {
@@ -117,7 +115,3 @@ class Thai extends AbstractLanguage {
     return parts.join('')
   }
 }
-
-export default function convertToWords (value, options = {}) {
-  return new Thai(options).convertToWords(value)
-}

package/lib/languages/tr.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Turkish language converter.
+ *
+ * Supports:
+ * - Omits 'bir' (one) before hundreds and thousands
+ * - Optional space removal via dropSpaces option
+ */
+export class Turkish extends TurkicLanguage {
+    constructor(options?: {});
+    scaleWords: (string | bigint)[][];
+}
+import { TurkicLanguage } from '../classes/turkic-language.js';

package/lib/languages/tr.js

@@ -1,25 +1,19 @@
-import TurkicLanguage from '../classes/turkic-language.js'
-
-/**
- * @typedef {Object} TurkishOptions
- * @property {boolean} [dropSpaces=false] Remove spaces between words if true.
- */
+import { TurkicLanguage } from '../classes/turkic-language.js'
 
 /**
  * Turkish language converter.
  *
- * Inherits from TurkicLanguage shared patterns:
- * - Space-separated number combinations
- * - Omits '1' before hundreds and thousands
- * - Optional word spacing (dropSpaces option)
- * - Supports 'ş', 'ç', 'ğ', 'ı', 'ü', 'ö' characters
+ * Supports:
+ * - Omits 'bir' (one) before hundreds and thousands
+ * - Optional space removal via dropSpaces option
  */
 export class Turkish extends TurkicLanguage {
   negativeWord = 'eksi'
   decimalSeparatorWord = 'virgül'
   zeroWord = 'sıfır'
   wordSeparator = ' '
-  scaleWordPairs = [
+
+  scaleWords = [
     [1_000_000_000_000_000_000n, 'kentilyon'],
     [1_000_000_000_000_000n, 'katrilyon'],
     [1_000_000_000_000n, 'trilyon'],
@@ -48,36 +42,15 @@ export class Turkish extends TurkicLanguage {
     [0n, 'sıfır']
   ]
 
-  /**
-   * Initializes the Turkish converter with language-specific options.
-   *
-   * @param {TurkishOptions} [options={}] Configuration options.
-   */
-  constructor ({ dropSpaces = false } = {}) {
+  constructor (options = {}) {
     super()
 
-    this.dropSpaces = dropSpaces
+    this.setOptions({
+      dropSpaces: false
+    }, options)
 
-    if (this.dropSpaces === true) {
+    if (this.options.dropSpaces) {
       this.wordSeparator = ''
     }
   }
 }
-
-/**
- * Converts a number to Turkish cardinal (written) form.
- *
- * @param {number|string|bigint} value The number to convert.
- * @param {Object} [options] Conversion options (see TR class).
- * @param {boolean} [options.dropSpaces=false] Remove spaces between words if true.
- * @returns {string} The number expressed in Turkish words.
- * @throws {TypeError} If value is NaN or invalid type.
- * @throws {Error} If value is an invalid number string.
- *
- * @example
- * convertToWords(42, { lang: 'tr' }); // 'kırk iki'
- * convertToWords(42, { lang: 'tr', dropSpaces: true }); // 'kırkiki'
- */
-export default function convertToWords (value, options = {}) {
-  return new Turkish(options).convertToWords(value)
-}

package/lib/languages/uk.d.ts

@@ -0,0 +1,85 @@
+/**
+ * Ukrainian language converter.
+ *
+ * Supports:
+ * - Three-form pluralization (one/few/many)
+ * - Gender agreement (один/одна, два/дві)
+ * - Ukrainian orthography and phonology
+ */
+export class Ukrainian extends SlavicLanguage {
+    onesWords: {
+        1: string;
+        2: string;
+        3: string;
+        4: string;
+        5: string;
+        6: string;
+        7: string;
+        8: string;
+        9: string;
+    };
+    onesFeminineWords: {
+        1: string;
+        2: string;
+        3: string;
+        4: string;
+        5: string;
+        6: string;
+        7: string;
+        8: string;
+        9: string;
+    };
+    teensWords: {
+        0: string;
+        1: string;
+        2: string;
+        3: string;
+        4: string;
+        5: string;
+        6: string;
+        7: string;
+        8: string;
+        9: string;
+    };
+    twentiesWords: {
+        2: string;
+        3: string;
+        4: string;
+        5: string;
+        6: string;
+        7: string;
+        8: string;
+        9: string;
+    };
+    hundredsWords: {
+        1: string;
+        2: string;
+        3: string;
+        4: string;
+        5: string;
+        6: string;
+        7: string;
+        8: string;
+        9: string;
+    };
+    pluralForms: {
+        1: string[];
+        2: string[];
+        3: string[];
+        4: string[];
+        5: string[];
+        6: string[];
+        7: string[];
+        8: string[];
+        9: string[];
+        10: string[];
+    };
+    /**
+     * Ukrainian thousands (тисяча) are feminine, requiring одна/двi forms.
+     * Other scales (million, billion, etc.) are masculine.
+     */
+    scaleGenders: {
+        1: boolean;
+    };
+}
+import { SlavicLanguage } from '../classes/slavic-language.js';

package/lib/languages/uk.js

@@ -1,39 +1,19 @@
-import SlavicLanguage from '../classes/slavic-language.js'
-
-/**
- * @typedef {Object} SlavicOptions
- * @property {boolean} [feminine=false] Use feminine forms for numbers.
- */
+import { SlavicLanguage } from '../classes/slavic-language.js'
 
 /**
  * Ukrainian language converter.
  *
- * Implements Ukrainian number words using the Slavic language pattern:
- * - Ukrainian number words (один/одна, два/дві, три, чотири...)
- * - Gender-aware forms (masculine/feminine)
- * - Slavic three-form pluralization (тисяча/тисячі/тисяч)
+ * Supports:
+ * - Three-form pluralization (one/few/many)
+ * - Gender agreement (один/одна, два/дві)
  * - Ukrainian orthography and phonology
- *
- * Key Features:
- * - Three-form pluralization system shared across Slavic languages
- *   * Form 1 (singular): 1 (e.g., "тисяча")
- *   * Form 2 (few): 2-4, 22-24, 32-34... excluding teens (e.g., "тисячі")
- *   * Form 3 (many): all other numbers (e.g., "тисяч")
- * - Chunk-based decomposition (splits into groups of 3 digits: ones, thousands, millions, etc.)
- * - Large number handling via thousands[] array with indexed [singular, few, many] forms
- *
- * Features:
- * - Ukrainian-specific letters (і, ї, ґ, є)
- * - Apostrophe usage (п'ять, дев'ять)
- * - Close structural similarity to Russian with distinct vocabulary
- *
- * Inherits from SlavicLanguage for complex pluralization algorithms.
  */
 export class Ukrainian extends SlavicLanguage {
   negativeWord = 'мiнус'
   decimalSeparatorWord = 'кома'
   zeroWord = 'нуль'
-  ones = {
+
+  onesWords = {
     1: 'один',
     2: 'два',
     3: 'три',
@@ -45,7 +25,7 @@ export class Ukrainian extends SlavicLanguage {
     9: 'дев\'ять'
   }
 
-  onesFeminine = {
+  onesFeminineWords = {
     1: 'одна',
     2: 'двi',
     3: 'три',
@@ -57,7 +37,7 @@ export class Ukrainian extends SlavicLanguage {
     9: 'дев\'ять'
   }
 
-  tens = {
+  teensWords = {
     0: 'десять',
     1: 'одинадцять',
     2: 'дванадцять',
@@ -70,7 +50,7 @@ export class Ukrainian extends SlavicLanguage {
     9: 'дев\'ятнадцять'
   }
 
-  twenties = {
+  twentiesWords = {
     2: 'двадцять',
     3: 'тридцять',
     4: 'сорок',
@@ -81,7 +61,7 @@ export class Ukrainian extends SlavicLanguage {
     9: 'дев\'яносто'
   }
 
-  hundreds = {
+  hundredsWords = {
     1: 'сто',
     2: 'двiстi',
     3: 'триста',
@@ -93,7 +73,7 @@ export class Ukrainian extends SlavicLanguage {
     9: 'дев\'ятсот'
   }
 
-  thousands = {
+  pluralForms = {
     1: ['тисяча', 'тисячi', 'тисяч'], // 10^ 3
     2: ['мiльйон', 'мiльйони', 'мiльйонiв'], // 10^ 6
     3: ['мiльярд', 'мiльярди', 'мiльярдiв'], // 10^ 9
@@ -105,18 +85,12 @@ export class Ukrainian extends SlavicLanguage {
     9: ['октильйон', 'октильйони', 'октильйонiв'], // 10^ 27
     10: ['нонiльйон', 'нонiльйони', 'нонiльйонiв'] // 10^ 30
   }
-}
 
-/**
- * Converts a number to Ukrainian cardinal (written) form.
- *
- * @param {number|string|bigint} value The number to convert.
- * @param {Object} [options={}] Configuration options.
- * @param {boolean} [options.feminine=false] Use feminine forms for numbers.
- * @returns {string} The number expressed in Ukrainian words.
- * @throws {TypeError} If value is NaN or invalid type.
- * @throws {Error} If value is an invalid number string.
- */
-export default function convertToWords (value, options = {}) {
-  return new Ukrainian(options).convertToWords(value)
+  /**
+   * Ukrainian thousands (тисяча) are feminine, requiring одна/двi forms.
+   * Other scales (million, billion, etc.) are masculine.
+   */
+  scaleGenders = {
+    1: true // thousands are feminine
+  }
 }

package/lib/languages/ur.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Urdu language converter.
+ *
+ * Supports:
+ * - Indian numbering system (ہزار, لاکھ, کروڑ)
+ * - Urdu script (right-to-left)
+ * - Complete word forms for 0-99
+ */
+export class Urdu extends SouthAsianLanguage {
+}
+import { SouthAsianLanguage } from '../classes/south-asian-language.js';

package/lib/languages/ur.js

@@ -1,11 +1,20 @@
-import SouthAsianLanguage from '../classes/south-asian-language.js'
+import { SouthAsianLanguage } from '../classes/south-asian-language.js'
 
-class Urdu extends SouthAsianLanguage {
+/**
+ * Urdu language converter.
+ *
+ * Supports:
+ * - Indian numbering system (ہزار, لاکھ, کروڑ)
+ * - Urdu script (right-to-left)
+ * - Complete word forms for 0-99
+ */
+export class Urdu extends SouthAsianLanguage {
   negativeWord = 'منفی'
   decimalSeparatorWord = 'اعشاریہ'
   zeroWord = 'صفر'
   hundredWord = 'سو'
-  belowHundred = [
+
+  belowHundredWords = [
     'صفر',
     'ایک',
     'دو',
@@ -120,7 +129,3 @@ class Urdu extends SouthAsianLanguage {
     'شنکھ'
   ]
 }
-
-export default function convertToWords (value, options = {}) {
-  return new Urdu(options).convertToWords(value)
-}

package/lib/languages/vi.d.ts

@@ -0,0 +1,72 @@
+/**
+ * Vietnamese language converter.
+ *
+ * Supports:
+ * - Special pronunciation rules (lăm for 5, mốt for final 1)
+ * - "Lẻ" (odd/extra) when tens place is zero
+ * - Vietnamese diacritical marks
+ */
+export class Vietnamese extends AbstractLanguage {
+    belowTwentyWords: {
+        0: string;
+        1: string;
+        2: string;
+        3: string;
+        4: string;
+        5: string;
+        6: string;
+        7: string;
+        8: string;
+        9: string;
+        10: string;
+        11: string;
+        12: string;
+        13: string;
+        14: string;
+        15: string;
+        16: string;
+        17: string;
+        18: string;
+        19: string;
+    };
+    twentiesWords: {
+        20: string;
+        30: string;
+        40: string;
+        50: string;
+        60: string;
+        70: string;
+        80: string;
+        90: string;
+    };
+    scaleWords: {
+        1: string;
+        2: string;
+        3: string;
+        4: string;
+        5: string;
+        6: string;
+        7: string;
+        8: string;
+        9: string;
+        10: string;
+        11: string;
+        12: string;
+        13: string;
+        14: string;
+        15: string;
+        16: string;
+        17: string;
+        18: string;
+        19: string;
+        20: string;
+    };
+    /** Convert numbers less than 100 to Vietnamese words. */
+    convertLess100(number: any): any;
+    /** Convert numbers less than 1000 to Vietnamese words. */
+    convertLess1000(number: any): any;
+    /** Convert numbers greater than 1000 to Vietnamese words. */
+    convertMore1000(number: any): any;
+    integerToWords(integerPart: any): any;
+}
+import { AbstractLanguage } from '../classes/abstract-language.js';