n2words 1.20.0 → 1.22.0

package/lib/i18n/zh.d.ts

@@ -2,17 +2,17 @@
  * Converts a value to cardinal (written) form.
  * @param {number|string|bigint} value Number to be convert.
  * @param {object} [options] Options for class.
- * @throws {Error} Value cannot be invalid.
  * @returns {string} Value in cardinal (written) format.
+ * @throws {Error} Value cannot be invalid.
  */
-export default function _default(value: number | string | bigint, options?: object): string;
+export default function floatToCardinal(value: number | string | bigint, options?: object): string;
 export class N2WordsZH extends BaseLanguage {
     constructor(options: any);
     merge(lPair: any, rPair: any): {
         [x: string]: bigint;
     };
-    decimalToCardinal(decimal: any): any;
-    digit(num: any): any;
-    zeroDigit(num: any): number;
+    decimalToCardinal(decimal: any): string;
+    digit(number_: any): any;
+    zeroDigit(number_: any): number;
 }
-import BaseLanguage from '../classes/BaseLanguage.js';
+import BaseLanguage from '../classes/base-language.js';

package/lib/i18n/zh.js

@@ -1,4 +1,4 @@
-import BaseLanguage from '../classes/BaseLanguage.js';
+import BaseLanguage from '../classes/base-language.js';
 
 export class N2WordsZH extends BaseLanguage {
   constructor(options) {
@@ -8,9 +8,9 @@ export class N2WordsZH extends BaseLanguage {
       zero: '零',
       spaceSeparator: ''
     }, options), [
-      [1000000000000n, '万'],
-      [100000000n, '亿'],
-      [10000n, '万'],
+      [1_000_000_000_000n, '万'],
+      [100_000_000n, '亿'],
+      [10_000n, '万'],
       [1000n, '仟'],
       [100n, '佰'],
       [10n, '拾'],
@@ -48,7 +48,7 @@ export class N2WordsZH extends BaseLanguage {
   }
 
   decimalToCardinal(decimal) {
-    const decimalPartArray = decimal.split('');
+    const decimalPartArray = [...decimal];
 
     const decimalPartWordsArray = decimalPartArray.map(decimal =>
       this.getCardWord(decimal)
@@ -57,12 +57,12 @@ export class N2WordsZH extends BaseLanguage {
     return decimalPartWordsArray.join(this.spaceSeparator);
   }
 
-  digit(num) {
-    return num.toString().length;
+  digit(number_) {
+    return number_.toString().length;
   }
 
-  zeroDigit(num) {
-    return Array.from(num.toString()).filter(c => c == '0').length;
+  zeroDigit(number_) {
+    return [...number_.toString()].filter(c => c == '0').length;
   }
 }
 
@@ -70,9 +70,9 @@ export class N2WordsZH extends BaseLanguage {
  * Converts a value to cardinal (written) form.
  * @param {number|string|bigint} value Number to be convert.
  * @param {object} [options] Options for class.
- * @throws {Error} Value cannot be invalid.
  * @returns {string} Value in cardinal (written) format.
+ * @throws {Error} Value cannot be invalid.
  */
-export default function (value, options = {}) {
+export default function floatToCardinal (value, options = {}) {
   return new N2WordsZH(options).floatToCardinal(value);
 }

package/lib/n2words.d.ts

@@ -1,7 +1,9 @@
+export default floatToCardinal;
 /**
  * Converts a number to written form.
  * @param {number|string|bigint} value The number to convert.
  * @param {object} [options] User options.
  * @returns {string} Value in written format.
+ * TODO [2024-06] Migrate to object destructing for parameters
  */
-export default function _default(value: number | string | bigint, options?: object): string;
+declare function floatToCardinal(value: number | string | bigint, options?: object): string;

package/lib/n2words.js

@@ -1,3 +1,7 @@
+/**
+ * @module n2words
+ */
+
 import n2wordsAR from './i18n/ar.js';
 import n2wordsAZ from './i18n/az.js';
 import n2wordsCZ from './i18n/cz.js';
@@ -20,6 +24,7 @@ import n2wordsNL from './i18n/nl.js';
 import n2wordsNO from './i18n/no.js';
 import n2wordsPL from './i18n/pl.js';
 import n2wordsPT from './i18n/pt.js';
+import n2wordsRO from './i18n/ro.js';
 import n2wordsRU from './i18n/ru.js';
 import n2wordsSR from './i18n/sr.js';
 import n2wordsTR from './i18n/tr.js';
@@ -50,6 +55,7 @@ const dict = {
   'no': n2wordsNO,
   'pl': n2wordsPL,
   'pt': n2wordsPT,
+  'ro': n2wordsRO,
   'ru': n2wordsRU,
   'sr': n2wordsSR,
   'tr': n2wordsTR,
@@ -63,15 +69,19 @@ const dict = {
  * @param {number|string|bigint} value The number to convert.
  * @param {object} [options] User options.
  * @returns {string} Value in written format.
+ * TODO [2024-06] Migrate to object destructing for parameters
  */
-export default function (value, options = { lang: 'en' }) {
-  const fn = dict[options.lang];
-  if (fn != null) return fn(value, options);
+// eslint-disable-next-line unicorn/no-object-as-default-parameter
+function floatToCardinal(value, options = { lang: 'en' }) {
+  const function_ = dict[options.lang];
+  if (function_ != undefined) return function_(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);
+    .map((_, index, array) => array.slice(0, array.length - index).join('-')) // ['en-UK', 'en']
+    .find(l => dict[l] != undefined);
+  if (fallbackLang != undefined) return dict[fallbackLang](value, options);
 
-  throw Error('Unsupported language: ' + value + '.');
+  throw new Error('Unsupported language: ' + value + '.');
 }
+
+export default floatToCardinal;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "n2words",
-  "version": "1.20.0",
-  "description": "n2words converts a numerical number into a written one, supports 27 languages and has zero dependencies.",
+  "version": "1.22.0",
+  "description": "n2words converts a numerical number into a written one, supports 28 languages and has zero dependencies.",
   "keywords": [
     "n2words",
     "convert",
@@ -43,7 +43,10 @@
   "bugs": {
     "url": "https://github.com/forzagreen/n2words/issues"
   },
-  "repository": "github:forzagreen/n2words",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/forzagreen/n2words.git"
+  },
   "license": "MIT",
   "author": "Wael TELLAT",
   "contributors": [
@@ -59,15 +62,17 @@
   "unpkg": "dist/n2words.js",
   "files": [
     "lib/*",
-    "dist/*",
-    "types/*"
+    "dist/*"
   ],
   "scripts": {
     "bench": "node bench.js",
-    "build": "webpack --config webpack.config.js --progress",
+    "build": "webpack --progress",
     "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",
+    "docs": "jsdoc -c ./conf.json",
+    "lint": "npm run lint:js && npm run lint:md",
+    "lint:js": "eslint lib/ test/ examples/ *.js",
+    "lint:md": "markdownlint-cli2 *.md",
     "test": "ava --verbose",
     "test:cjs": "ava --verbose test/import.cjs",
     "test:core": "ava --verbose test/core.js",
@@ -91,26 +96,30 @@
     ]
   },
   "devDependencies": {
-    "@babel/core": "^7.23.9",
-    "@babel/preset-env": "^7.23.9",
-    "ava": "^6.1.1",
-    "babel-loader": "^9.1.3",
+    "@babel/core": "^7.28.0",
+    "@babel/preset-env": "^7.28.0",
+    "@eslint/js": "^9.32.0",
+    "@stylistic/eslint-plugin-js": "^2.13.0",
+    "ava": "^6.4.1",
+    "babel-loader": "^9.2.1",
     "benchmark": "^2.1.4",
-    "c8": "^9.1.0",
-    "chalk": "^5.3.0",
-    "chromedriver": "^121.0.2",
-    "core-js": "^3.36.0",
-    "eslint": "^8.56.0",
-    "eslint-plugin-ava": "^14.0.0",
-    "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-jsdoc": "^48.1.0",
-    "eslint-plugin-node": "^11.1.0",
+    "c8": "^10.1.3",
+    "chalk": "^5.5.0",
+    "chromedriver": "^138.0.5",
+    "core-js": "^3.45.0",
+    "eslint": "^9.32.0",
+    "eslint-plugin-ava": "^15.1.0",
+    "eslint-plugin-jsdoc": "^52.0.3",
+    "eslint-plugin-n": "^17.21.3",
+    "eslint-plugin-unicorn": "^60.0.0",
+    "jsdoc": "^4.0.4",
+    "markdownlint-cli2": "^0.18.1",
     "microtime": "^3.1.1",
-    "selenium-webdriver": "^4.17.0",
-    "webpack": "^5.90.2",
+    "selenium-webdriver": "^4.34.0",
+    "webpack": "^5.101.0",
     "webpack-cli": "^5.1.4"
   },
   "engines": {
-    "node": "18 || >=20"
+    "node": "^20 || ^22 || >=24"
   }
 }