n2words 1.17.0 → 1.19.0

package/lib/classes/AbstractLanguage.js

@@ -76,10 +76,10 @@ export default class {
     const words = [];
     let allZero = true;
 
-    // Split decimal portion into an array of characters in reverse
+    // Split decimal portion into an array of characters
     const chars = decimal.split('');
 
-    // Loop through array (from the end) adding leading zeros to output array
+    // Loop through characters adding zeros to output array
     chars.forEach(char => {
       if (char === '0') {
         words.push(this.zero);
@@ -88,7 +88,6 @@ export default class {
       }
     });
 
-    // Add decimal number to word array
     if (allZero) {
       return words;
     }

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

@@ -0,0 +1,11 @@
+/**
+ * Converts a value to cardinal (written) form.
+ * @param {number|string} value Number to be convert.
+ * @param {object} [options] Options for class.
+ * @throws {Error} Value cannot be invalid.
+ * @returns {string} Value in cardinal (written) format.
+ */
+export default function _default(value: number | string, options?: object): string;
+export class N2WordsFRBE extends N2WordsFR {
+}
+import { N2WordsFR } from './fr.js';

package/lib/i18n/fr-BE.js

@@ -0,0 +1,20 @@
+import { N2WordsFR } from './fr.js';
+
+export class N2WordsFRBE extends N2WordsFR {
+  constructor(options) {
+    options = Object.assign({}, options, { _region: 'BE' });
+
+    super(options);
+  }
+}
+
+/**
+ * Converts a value to cardinal (written) form.
+ * @param {number|string} value Number to be convert.
+ * @param {object} [options] Options for class.
+ * @throws {Error} Value cannot be invalid.
+ * @returns {string} Value in cardinal (written) format.
+ */
+export default function (value, options = {}) {
+  return new N2WordsFRBE(options).floatToCardinal(value);
+}

package/lib/i18n/fr.js

@@ -5,7 +5,8 @@ export class N2WordsFR extends BaseLanguage {
     options = Object.assign({
       negativeWord: 'moins',
       separatorWord: 'virgule',
-      zero: 'zéro'
+      zero: 'zéro',
+      _region: 'FR'
     }, options);
 
     super(options, [
@@ -19,7 +20,9 @@ export class N2WordsFR extends BaseLanguage {
       [1000000n, 'million'],
       [1000n, 'mille'],
       [100n, 'cent'],
+      ...(['BE'].includes(options._region) ? [[90n, 'nonante']] : []),
       [80n, 'quatre-vingts'],
+      ...(['BE'].includes(options._region) ? [[70n, 'septante']] : []),
       [60n, 'soixante'],
       [50n, 'cinquante'],
       [40n, 'quarante'],

package/lib/n2words.js

@@ -7,6 +7,7 @@ import n2wordsEN from './i18n/en.js';
 import n2wordsES from './i18n/es.js';
 import n2wordsFA from './i18n/fa.js';
 import n2wordsFR from './i18n/fr.js';
+import n2wordsFRBE from './i18n/fr-BE.js';
 import n2wordsHE from './i18n/he.js';
 import n2wordsHR from './i18n/hr.js';
 import n2wordsHU from './i18n/hu.js';
@@ -26,6 +27,37 @@ import n2wordsUK from './i18n/uk.js';
 import n2wordsVI from './i18n/vi.js';
 import n2wordsZH from './i18n/zh.js';
 
+const dict = {
+  'ar': n2wordsAR,
+  'az': n2wordsAZ,
+  'cz': n2wordsCZ,
+  'de': n2wordsDE,
+  'dk': n2wordsDK,
+  'en': n2wordsEN, // default
+  'es': n2wordsES,
+  'fa': n2wordsFA,
+  'fr': n2wordsFR,
+  'fr-BE': n2wordsFRBE,
+  'he': n2wordsHE, // only for numbers <= 9999
+  'hr': n2wordsHR,
+  'hu': n2wordsHU,
+  'id': n2wordsID,
+  'it': n2wordsIT,
+  'ko': n2wordsKO,
+  'lt': n2wordsLT,
+  'lv': n2wordsLV,
+  'nl': n2wordsNL,
+  'no': n2wordsNO,
+  'pl': n2wordsPL,
+  'pt': n2wordsPT,
+  'ru': n2wordsRU,
+  'sr': n2wordsSR,
+  'tr': n2wordsTR,
+  'uk': n2wordsUK,
+  'vi': n2wordsVI,
+  'zh': n2wordsZH,
+};
+
 /**
  * Converts a number to written form.
  * @param {number|string} value The number to convert.
@@ -33,34 +65,13 @@ import n2wordsZH from './i18n/zh.js';
  * @returns {string} Value in written format.
  */
 export default function (value, options = { lang: 'en' }) {
-  switch (options.lang) {
-    case 'en': return n2wordsEN(value, options); // default
-    case 'ar': return n2wordsAR(value, options);
-    case 'az': return n2wordsAZ(value, options);
-    case 'cz': return n2wordsCZ(value, options);
-    case 'de': return n2wordsDE(value, options);
-    case 'dk': return n2wordsDK(value, options);
-    case 'es': return n2wordsES(value, options);
-    case 'fa': return n2wordsFA(value, options);
-    case 'fr': return n2wordsFR(value, options);
-    case 'he': return n2wordsHE(value, options); // only for numbers <= 9999
-    case 'hr': return n2wordsHR(value, options);
-    case 'hu': return n2wordsHU(value, options);
-    case 'id': return n2wordsID(value, options);
-    case 'it': return n2wordsIT(value, options);
-    case 'ko': return n2wordsKO(value, options);
-    case 'lt': return n2wordsLT(value, options);
-    case 'lv': return n2wordsLV(value, options);
-    case 'nl': return n2wordsNL(value, options);
-    case 'no': return n2wordsNO(value, options);
-    case 'pl': return n2wordsPL(value, options);
-    case 'pt': return n2wordsPT(value, options);
-    case 'ru': return n2wordsRU(value, options);
-    case 'sr': return n2wordsSR(value, options);
-    case 'tr': return n2wordsTR(value, options);
-    case 'uk': return n2wordsUK(value, options);
-    case 'vi': return n2wordsVI(value, options);
-    case 'zh': return n2wordsZH(value, options);
-    default: throw Error('Unsupported language: ' + value + '.');
-  }
+  const fn = dict[options.lang];
+  if (fn != null) return fn(value, options);
+
+  const fallbackLang = options.lang.split('-') // 'en-UK' -> ['en', 'UK']
+    .map((_, i, arr) => arr.slice(0, arr.length - i).join('-')) // ['en-UK', 'en']
+    .find(l => dict[l] != null);
+  if (fallbackLang != null) return dict[fallbackLang](value, options);
+
+  throw Error('Unsupported language: ' + value + '.');
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "n2words",
-  "version": "1.17.0",
+  "version": "1.19.0",
   "description": "n2words converts a numerical number into a written one, supports 27 languages and has zero dependencies.",
   "keywords": [
     "n2words",
@@ -65,7 +65,7 @@
   "scripts": {
     "bench": "node bench.js",
     "build": "webpack --config webpack.config.js --progress",
-    "build:types": "npx -p typescript tsc lib/n2words.js dist/n2words.js --target es6 --module esnext --allowJs --declaration --emitDeclarationOnly",
+    "build:types": "npx -p typescript tsc lib/n2words.js dist/n2words.js --target es6 --module nodenext --allowJs --declaration --emitDeclarationOnly",
     "coverage": "c8 ava",
     "lint": "eslint --config .eslintrc.json lib/ test/ examples/ bench.js",
     "test": "ava --verbose",
@@ -91,26 +91,26 @@
     ]
   },
   "devDependencies": {
-    "@babel/core": "^7.22.11",
-    "@babel/preset-env": "^7.22.10",
-    "ava": "^5.3.1",
+    "@babel/core": "^7.23.9",
+    "@babel/preset-env": "^7.23.9",
+    "ava": "^6.1.1",
     "babel-loader": "^9.1.3",
     "benchmark": "^2.1.4",
-    "c8": "^8.0.1",
+    "c8": "^9.1.0",
     "chalk": "^5.3.0",
-    "chromedriver": "^116.0.0",
-    "core-js": "^3.32.1",
-    "eslint": "^8.48.0",
+    "chromedriver": "^121.0.0",
+    "core-js": "^3.35.1",
+    "eslint": "^8.56.0",
     "eslint-plugin-ava": "^14.0.0",
-    "eslint-plugin-import": "^2.28.1",
-    "eslint-plugin-jsdoc": "^46.5.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-jsdoc": "^48.0.6",
     "eslint-plugin-node": "^11.1.0",
     "microtime": "^3.1.1",
-    "selenium-webdriver": "^4.11.1",
-    "webpack": "^5.88.2",
+    "selenium-webdriver": "^4.17.0",
+    "webpack": "^5.90.1",
     "webpack-cli": "^5.1.4"
   },
   "engines": {
-    "node": "16 || 18 || >=20"
+    "node": "18 || >=20"
   }
 }