n2words 1.9.0 → 1.11.0

package/lib/classes/N2WordsAbs.mjs

@@ -1,50 +1,71 @@
 /**
- * This is an abstract class.
- * Must be inherited by all languages.
+ * Abstract class that must be inherited by all languages.
  */
-export default function () {
-  this.negative_word = '';
-  this.separator_word;
-  this.ZERO;
-  this.space_separator = ' '; // space
-  this.toCardinal = () => {}; // Must take an integer and return a string.
+export default class {
+  constructor() {
+    this.negativeWord = '';
+    this.separatorWord;
+    this.zero;
+    this.spaceSeparator = ' ';
+  }
 
-  this.toDecimal = (decimalPart) => {
+  /**
+   * Convert a number to cardinal (written) format.
+   *
+   * @param {number} value The number value to convert to cardinal form.
+   * @returns {string} Cardinal representation of number value.
+   */
+  toCardinal(value) {
+    return value;
+  }
+
+  /**
+   *
+   * @param {number} decimalPart Decimal part of the number to convert.
+   * @returns {string} Decimal part in written format.
+   */
+  toDecimal(decimalPart) {
     let decimalPartArray = Array.from(decimalPart);
     let decimalPartWordsArray = [];
     while (decimalPartArray[0] === '0') {
       // Leading zeros
       decimalPartArray.shift();
-      decimalPartWordsArray.push(this.ZERO);
+      decimalPartWordsArray.push(this.zero);
     }
     decimalPartWordsArray.push(this.toCardinal(parseInt(decimalPart, 10)));
 
-    return decimalPartWordsArray.join(this.space_separator);
-  };
+    return decimalPartWordsArray.join(this.spaceSeparator);
+  }
 
-  this.floatToCardinal = (value) => {
-    if (Number(value) === value) {
-      let words = [];
-      let positiveValue = Math.abs(value);
-      if (value % 1 === 0 || typeof this.separator_word === 'undefined') {
-        // if value is integer or if separator_word is not defined
-        words = [this.toCardinal(positiveValue)];
-      } else {
-        const splittedValue = positiveValue.toString().split('.');
-        const wholeNumberStr = this.toCardinal(parseInt(splittedValue[0], 10));
+  /**
+   *
+   * @param {number} value Float number.
+   * @throws {TypeError} Value must be a valid number.
+   * @returns {string|undefined} Cardinal number in written format.
+   */
+  floatToCardinal(value) {
+    if (isNaN(Number(value))) {
+      throw new TypeError(`Invalid number: ${value}, of type: ${typeof value}`);
+    }
+    value = Number(value);
+    let words = [];
+    let positiveValue = Math.abs(value);
+    if (value % 1 === 0 || typeof this.separatorWord === 'undefined') {
+      // if value is integer or if separatorWord is not defined
+      words = [this.toCardinal(positiveValue)];
+    } else {
+      const splittedValue = positiveValue.toString().split('.');
+      const wholeNumberStr = this.toCardinal(parseInt(splittedValue[0], 10));
 
-        let decimalPart = splittedValue[1];
+      let decimalPart = splittedValue[1];
 
-        const decimalPartStr = this.toDecimal(decimalPart);
-        words = [wholeNumberStr, this.separator_word, decimalPartStr];
-      }
-      if (value < 0) {
-        // negative numbers
-        words = [this.negative_word].concat(words);
-      }
-      return words.join(this.space_separator);
-    } else {
-      return undefined;
+      const decimalPartStr = this.toDecimal(decimalPart);
+      words = [wholeNumberStr, this.separatorWord, decimalPartStr];
+    }
+    if (value < 0) {
+      // negative numbers
+      words = [this.negativeWord].concat(words);
     }
-  };
+    return words.join(this.spaceSeparator);
+  }
 }

package/lib/classes/N2WordsBase.mjs

@@ -1,21 +1,19 @@
 import N2WordsAbs from './N2WordsAbs.mjs';
 
 /**
- * This class has common funtions used by multiple languages (mostly european).
+ * This class has common functions used by multiple languages (mostly european).
  */
-export default function() {
-  N2WordsAbs.call(this);
-
-  this.getValueFromCards = (elem) => {
+export default class extends N2WordsAbs {
+  getValueFromCards(elem) {
     // 100
     for (let i = 0; i < this.cards.length; i++) {
       if (Object.prototype.hasOwnProperty.call(this.cards[i], elem)) {
         return this.cards[i][elem];
       }
     }
-  };
+  }
 
-  this.splitnum = (value) => {
+  splitNum(value) {
     for (let i = 0; i < this.cards.length; i++) {
       if (this.cards[i][0] == '.') {
         continue;
@@ -42,24 +40,24 @@ export default function() {
         if (div == value) {
           return [(div * this.getValueFromCards(elem), div * elem)];
         }
-        out.push(this.splitnum(div));
+        out.push(this.splitNum(div));
       }
       out.push({
         [this.getValueFromCards(elem)]: elem,
       });
 
       if (mod) {
-        out.push(this.splitnum(mod));
+        out.push(this.splitNum(mod));
       }
       return out;
     }
-  };
+  }
 
-  this.scannum = (value) => {
-    return value.split('').map((v) => this.getValueFromCards(parseInt(v, 10)));
-  };
+  scanNum(value) {
+    return value.split('').map(v => this.getValueFromCards(parseInt(v, 10)));
+  }
 
-  this.clean = (val) => {
+  clean(val) {
     let out = val;
     while (val.length != 1) {
       out = [];
@@ -86,14 +84,22 @@ export default function() {
       val = out;
     }
     return out[0];
-  };
+  }
 
-  this.postClean = (out0) => out0.trimRight();
+  postClean(out0) {
+    return out0.trimRight();
+  }
 
-  this.toCardinal = (value) => {
-    const val = this.splitnum(value);
+  /**
+   * Convert a number to cardinal (written) format.
+   *
+   * @param {number} value The number value to convert to cardinal form.
+   * @returns {string} Cardinal representation of number value.
+   */
+  toCardinal(value) {
+    const val = this.splitNum(value);
     const preWords = Object.keys(this.clean(val))[0];
     const words = this.postClean(preWords);
     return words;
-  };
+  }
 }

package/lib/i18n/AR.mjs

@@ -1,130 +1,138 @@
 import N2WordsAbs from '../classes/N2WordsAbs.mjs';
 
-export default function() {
-  N2WordsAbs.call(this);
+export class N2WordsAR extends N2WordsAbs {
+  constructor() {
+    super();
 
-  this.integer_value = 0;
-  this._decimalValue = 0;
-  this.negative_word = "ناقص";
-  this.separator_word = "فاصلة";
-  this.number = 0;
-  this.ZERO = 'صفر';
-  // this.isCurrencyPartNameFeminine = true
-  // this.isCurrencyNameFeminine = false
-  this.arabicOnes = [
-    '', 'واحد', 'اثنان', 'ثلاثة', 'أربعة', 'خمسة', 'ستة', 'سبعة', 'ثمانية',
-    'تسعة',
-    'عشرة', 'أحد عشر', 'اثنا عشر', 'ثلاثة عشر', 'أربعة عشر', 'خمسة عشر',
-    'ستة عشر', 'سبعة عشر', 'ثمانية عشر',
-    'تسعة عشر',
-  ];
-  this.arabicFeminineOnes = [
-    '', 'إحدى', 'اثنتان', 'ثلاث', 'أربع', 'خمس', 'ست', 'سبع', 'ثمان',
-    'تسع',
-    'عشر', 'إحدى عشرة', 'اثنتا عشرة', 'ثلاث عشرة', 'أربع عشرة',
-    'خمس عشرة', 'ست عشرة', 'سبع عشرة', 'ثماني عشرة',
-    'تسع عشرة',
-  ];
-  this.arabicTens = ['عشرون', 'ثلاثون', 'أربعون', 'خمسون', 'ستون', 'سبعون', 'ثمانون', 'تسعون'];
-  this.arabicHundreds = ['', 'مائة', 'مئتان', 'ثلاثمائة', 'أربعمائة', 'خمسمائة', 'ستمائة', 'سبعمائة', 'ثمانمائة', 'تسعمائة'];
-  this.arabicAppendedTwos = ['مئتا', 'ألفا', 'مليونا', 'مليارا', 'تريليونا', 'كوادريليونا', 'كوينتليونا', 'سكستيليونا'];
-  this.arabicTwos = ['مئتان', 'ألفان', 'مليونان', 'ملياران', 'تريليونان', 'كوادريليونان', 'كوينتليونان', 'سكستيليونان'];
-  this.arabicGroup = ['مائة', 'ألف', 'مليون', 'مليار', 'تريليون', 'كوادريليون', 'كوينتليون', 'سكستيليون'];
-  this.arabicAppendedGroup = ['', 'ألفاً', 'مليوناً', 'ملياراً', 'تريليوناً', 'كوادريليوناً', 'كوينتليوناً', 'سكستيليوناً'];
-  this.arabicPluralGroups = ['', 'آلاف', 'ملايين', 'مليارات', 'تريليونات', 'كوادريليونات', 'كوينتليونات', 'سكستيليونات'];
-  this.digit_feminine_status = (digit/* , group_level */) => {
-    // if ((group_level == -1 && this.isCurrencyPartNameFeminine) || (group_level == 0 && this.isCurrencyNameFeminine)) {
+    this.integerValue = 0;
+    this.decimalValue = 0;
+    this.negativeWord = 'ناقص';
+    this.separatorWord = 'فاصلة';
+    this.number = 0;
+    this.zero = 'صفر';
+    // this.isCurrencyPartNameFeminine = true
+    // this.isCurrencyNameFeminine = false
+    this.arabicOnes = [
+      '', 'واحد', 'اثنان', 'ثلاثة', 'أربعة', 'خمسة', 'ستة', 'سبعة', 'ثمانية',
+      'تسعة',
+      'عشرة', 'أحد عشر', 'اثنا عشر', 'ثلاثة عشر', 'أربعة عشر', 'خمسة عشر',
+      'ستة عشر', 'سبعة عشر', 'ثمانية عشر',
+      'تسعة عشر',
+    ];
+    this.arabicFeminineOnes = [
+      '', 'إحدى', 'اثنتان', 'ثلاث', 'أربع', 'خمس', 'ست', 'سبع', 'ثمان',
+      'تسع',
+      'عشر', 'إحدى عشرة', 'اثنتا عشرة', 'ثلاث عشرة', 'أربع عشرة',
+      'خمس عشرة', 'ست عشرة', 'سبع عشرة', 'ثماني عشرة',
+      'تسع عشرة',
+    ];
+    this.arabicTens = ['عشرون', 'ثلاثون', 'أربعون', 'خمسون', 'ستون', 'سبعون', 'ثمانون', 'تسعون'];
+    this.arabicHundreds = ['', 'مائة', 'مئتان', 'ثلاثمائة', 'أربعمائة', 'خمسمائة', 'ستمائة', 'سبعمائة', 'ثمانمائة', 'تسعمائة'];
+    this.arabicAppendedTwos = ['مئتا', 'ألفا', 'مليونا', 'مليارا', 'تريليونا', 'كوادريليونا', 'كوينتليونا', 'سكستيليونا'];
+    this.arabicTwos = ['مئتان', 'ألفان', 'مليونان', 'ملياران', 'تريليونان', 'كوادريليونان', 'كوينتليونان', 'سكستيليونان'];
+    this.arabicGroup = ['مائة', 'ألف', 'مليون', 'مليار', 'تريليون', 'كوادريليون', 'كوينتليون', 'سكستيليون'];
+    this.arabicAppendedGroup = ['', 'ألفاً', 'مليوناً', 'ملياراً', 'تريليوناً', 'كوادريليوناً', 'كوينتليوناً', 'سكستيليوناً'];
+    this.arabicPluralGroups = ['', 'آلاف', 'ملايين', 'مليارات', 'تريليونات', 'كوادريليونات', 'كوينتليونات', 'سكستيليونات'];
+  }
+
+  digitFeminineStatus(digit/* , groupLevel */) {
+    // if ((groupLevel == -1 && this.isCurrencyPartNameFeminine) || (groupLevel == 0 && this.isCurrencyNameFeminine)) {
     //   return this.arabicFeminineOnes[parseInt(digit)]
     // }
     return this.arabicOnes[parseInt(digit)];
-  };
-  this.process_arabic_group = (group_number, group_level, remaining_number) => {
-    let tens = group_number % 100;
-    const hundreds = group_number / 100;
-    let ret_val = '';
+  }
+
+  processArabicGroup(groupNumber, groupLevel, remainingNumber) {
+    let tens = groupNumber % 100;
+    const hundreds = groupNumber / 100;
+    let retVal = '';
     if (parseInt(hundreds) > 0) {
-      ret_val = (
+      retVal = (
         tens == 0 && parseInt(hundreds) == 2
       ) ? this.arabicAppendedTwos[0] : this.arabicHundreds[parseInt(hundreds)];
     }
     if (tens > 0) {
       if (tens < 20) {
-        if (tens == 2 && parseInt(hundreds) == 0 && group_level > 0) {
-          ret_val = ([
+        if (tens == 2 && parseInt(hundreds) == 0 && groupLevel > 0) {
+          retVal = ([
             2000, 2000000, 2000000000, 2000000000000, 2000000000000000, 2000000000000000000
-          ].indexOf(this.integer_value) != -1) ? this.arabicAppendedTwos[
-            parseInt(group_level)] : this.arabicTwos[parseInt(group_level)
-          ];
+          ].indexOf(this.integerValue) != -1) ? this.arabicAppendedTwos[
+              parseInt(groupLevel)] : this.arabicTwos[parseInt(groupLevel)
+            ];
         } else {
-          if (ret_val != '') {
-            ret_val += ' و ';
+          if (retVal != '') {
+            retVal += ' و ';
           }
-          if (tens == 1 && group_level > 0 && hundreds == 0) {
-            ret_val += '';
+          if (tens == 1 && groupLevel > 0 && hundreds == 0) {
+            retVal += '';
           } else if (
-            (tens == 1 || tens == 2) && (group_level == 0 || group_level == -1) &&
-            (hundreds == 0 && remaining_number == 0)
+            (tens == 1 || tens == 2) && (groupLevel == 0 || groupLevel == -1) &&
+            (hundreds == 0 && remainingNumber == 0)
           ) {
-            ret_val += '';
+            retVal += '';
           } else {
-            ret_val += this.digit_feminine_status(parseInt(tens), group_level);
+            retVal += this.digitFeminineStatus(parseInt(tens), groupLevel);
           }
         }
       } else {
         const ones = tens % 10;
         tens = (tens / 10) - 2;
         if (ones > 0) {
-          if (ret_val != '' && tens < 4) {
-            ret_val += ' و ';
+          if (retVal != '' && tens < 4) {
+            retVal += ' و ';
           }
-          ret_val += this.digit_feminine_status(ones, group_level);
+          retVal += this.digitFeminineStatus(ones, groupLevel);
         }
-        if (ret_val != '' && ones != 0) {
-          ret_val += ' و ';
+        if (retVal != '' && ones != 0) {
+          retVal += ' و ';
         }
-        ret_val += this.arabicTens[parseInt(tens)];
+        retVal += this.arabicTens[parseInt(tens)];
       }
     }
-    return ret_val;
-  };
+    return retVal;
+  }
 
-  this.toCardinal = (number) => {
+  toCardinal(number) {
     if (parseInt(number) == 0) {
-      return this.ZERO;
+      return this.zero;
     }
-    let temp_number = number;
-    this.integer_value = number;
-    let ret_val = '';
+    let tempNumber = number;
+    this.integerValue = number;
+    let retVal = '';
     let group = 0;
-    while (temp_number > 0) {
-      const number_to_process = parseInt(temp_number % 1000);
-      temp_number = parseInt(temp_number / 1000);
-      const group_description = this.process_arabic_group(number_to_process, group, Math.floor(temp_number));
-      if (group_description != '') {
+    while (tempNumber > 0) {
+      const numberToProcess = parseInt(tempNumber % 1000);
+      tempNumber = parseInt(tempNumber / 1000);
+      const groupDescription = this.processArabicGroup(numberToProcess, group, Math.floor(tempNumber));
+      if (groupDescription != '') {
         if (group > 0) {
-          if (ret_val != '') {
-            ret_val = ' و ' + ret_val;
+          if (retVal != '') {
+            retVal = ' و ' + retVal;
           }
-          if (number_to_process != 2) {
-            if (number_to_process % 100 != 1) {
-              if (number_to_process >= 3 && number_to_process <= 10) {
-                ret_val = this.arabicPluralGroups[group] + ' ' + ret_val;
+          if (numberToProcess != 2) {
+            if (numberToProcess % 100 != 1) {
+              if (numberToProcess >= 3 && numberToProcess <= 10) {
+                retVal = this.arabicPluralGroups[group] + ' ' + retVal;
               } else {
-                if (ret_val != '') {
-                  ret_val = this.arabicAppendedGroup[group] + ' ' + ret_val;
+                if (retVal != '') {
+                  retVal = this.arabicAppendedGroup[group] + ' ' + retVal;
                 } else {
-                  ret_val = this.arabicGroup[group] + ' ' + ret_val;
+                  retVal = this.arabicGroup[group] + ' ' + retVal;
                 }
               }
             } else {
-              ret_val = this.arabicGroup[group] + ' ' + ret_val;
+              retVal = this.arabicGroup[group] + ' ' + retVal;
             }
           }
         }
-        ret_val = group_description + ' ' + ret_val;
+        retVal = groupDescription + ' ' + retVal;
       }
       group += 1;
     }
-    return ret_val.trim();
-  };
+    return retVal.trim();
+  }
+}
+
+export default function(n) {
+  return new N2WordsAR().floatToCardinal(n);
 }

package/lib/i18n/CZ.mjs

@@ -1,69 +1,71 @@
-import Num2Word_RU from './RU.mjs';
+import {N2WordsRU} from './RU.mjs';
 
-export default function () {
-  Num2Word_RU.call(this);
+export class N2WordsCZ extends N2WordsRU {
+  constructor() {
+    super();
 
-  this.negative_word = "mínus";
-  this.separator_word = "celá";
-  this.ZERO = 'nula';
-  this.ONES = {
-    1: 'jedna',
-    2: 'dva',
-    3: 'tři',
-    4: 'čtyři',
-    5: 'pět',
-    6: 'šest',
-    7: 'sedm',
-    8: 'osm',
-    9: 'devět'
-  };
-  this.TENS = {
-    0: 'deset',
-    1: 'jedenáct',
-    2: 'dvanáct',
-    3: 'třináct',
-    4: 'čtrnáct',
-    5: 'patnáct',
-    6: 'šestnáct',
-    7: 'sedmnáct',
-    8: 'osmnáct',
-    9: 'devatenáct'
-  };
-  this.TWENTIES = {
-    2: 'dvacet',
-    3: 'třicet',
-    4: 'čtyřicet',
-    5: 'padesát',
-    6: 'šedesát',
-    7: 'sedmdesát',
-    8: 'osmdesát',
-    9: 'devadesát'
-  };
-  this.HUNDREDS = {
-    1: 'sto',
-    2: 'dvěstě',
-    3: 'třista',
-    4: 'čtyřista',
-    5: 'pětset',
-    6: 'šestset',
-    7: 'sedmset',
-    8: 'osmset',
-    9: 'devětset'
-  };
-  this.THOUSANDS = {
-    1: ['tisíc', 'tisíce', 'tisíc'], // 10^ 3
-    2: ['milion', 'miliony', 'milionů'], // 10^ 6
-    3: ['miliarda', 'miliardy', 'miliard'], // 10^ 9
-    4: ['bilion', 'biliony', 'bilionů'], // 10^ 12
-    5: ['biliarda', 'biliardy', 'biliard'], // 10^ 15
-    6: ['trilion', 'triliony', 'trilionů'], // 10^ 18
-    7: ['triliarda', 'triliardy', 'triliard'], // 10^ 21
-    8: ['kvadrilion', 'kvadriliony', 'kvadrilionů'], // 10^ 24
-    9: ['kvadriliarda', 'kvadriliardy', 'kvadriliard'], // 10^ 27
-    10: ['quintillion', 'quintilliony', 'quintillionů'], // 10^ 30
-  };
+    this.negativeWord = 'mínus';
+    this.separatorWord = 'celá';
+    this.zero = 'nula';
+    this.ones = {
+      1: 'jedna',
+      2: 'dva',
+      3: 'tři',
+      4: 'čtyři',
+      5: 'pět',
+      6: 'šest',
+      7: 'sedm',
+      8: 'osm',
+      9: 'devět'
+    };
+    this.tens = {
+      0: 'deset',
+      1: 'jedenáct',
+      2: 'dvanáct',
+      3: 'třináct',
+      4: 'čtrnáct',
+      5: 'patnáct',
+      6: 'šestnáct',
+      7: 'sedmnáct',
+      8: 'osmnáct',
+      9: 'devatenáct'
+    };
+    this.twenties = {
+      2: 'dvacet',
+      3: 'třicet',
+      4: 'čtyřicet',
+      5: 'padesát',
+      6: 'šedesát',
+      7: 'sedmdesát',
+      8: 'osmdesát',
+      9: 'devadesát'
+    };
+    this.hundreds = {
+      1: 'sto',
+      2: 'dvěstě',
+      3: 'třista',
+      4: 'čtyřista',
+      5: 'pětset',
+      6: 'šestset',
+      7: 'sedmset',
+      8: 'osmset',
+      9: 'devětset'
+    };
+    this.thousands = {
+      1: ['tisíc', 'tisíce', 'tisíc'], // 10^ 3
+      2: ['milion', 'miliony', 'milionů'], // 10^ 6
+      3: ['miliarda', 'miliardy', 'miliard'], // 10^ 9
+      4: ['bilion', 'biliony', 'bilionů'], // 10^ 12
+      5: ['biliarda', 'biliardy', 'biliard'], // 10^ 15
+      6: ['trilion', 'triliony', 'trilionů'], // 10^ 18
+      7: ['triliarda', 'triliardy', 'triliard'], // 10^ 21
+      8: ['kvadrilion', 'kvadriliony', 'kvadrilionů'], // 10^ 24
+      9: ['kvadriliarda', 'kvadriliardy', 'kvadriliard'], // 10^ 27
+      10: ['quintillion', 'quintilliony', 'quintillionů'], // 10^ 30
+    };
+  }
 
-  this.pluralize = (n, forms) => {
+  pluralize(n, forms) {
     let form = 2;
     if (n == 1) {
       form = 0;
@@ -71,14 +73,14 @@ export default function () {
       form = 1;
     }
     return forms[form];
-  };
+  }
 
-  this.toCardinal = (number) => {
+  toCardinal(number) {
     if (parseInt(number) == 0) {
-      return this.ZERO;
+      return this.zero;
     }
     const words = [];
-    const chunks = this.splitbyx(JSON.stringify(number), 3);
+    const chunks = this.splitByX(JSON.stringify(number), 3);
     let i = chunks.length;
     for (let j = 0; j < chunks.length; j++) {
       const x = chunks[j];
@@ -86,22 +88,26 @@ export default function () {
       if (x == 0) {
         continue;
       }
-      const [n1, n2, n3] = this.get_digits(x);
+      const [n1, n2, n3] = this.getDigits(x);
       if (n3 > 0) {
-        words.push(this.HUNDREDS[n3]);
+        words.push(this.hundreds[n3]);
       }
       if (n2 > 1) {
-        words.push(this.TWENTIES[n2]);
+        words.push(this.twenties[n2]);
       }
       if (n2 == 1) {
-        words.push(this.TENS[n1]);
+        words.push(this.tens[n1]);
       } else if (n1 > 0 && !(i > 0 && x == 1)) {
-        words.push(this.ONES[n1]);
+        words.push(this.ones[n1]);
       }
       if (i > 0) {
-        words.push(this.pluralize(x, this.THOUSANDS[i]));
+        words.push(this.pluralize(x, this.thousands[i]));
       }
     }
     return words.join(' ');
-  };
+  }
+}
+
+export default function(n) {
+  return new N2WordsCZ().floatToCardinal(n);
 }