n2words 1.18.0 → 1.19.1

package/lib/classes/AbstractLanguage.d.ts

@@ -37,17 +37,17 @@ export default class _default {
      */
     get wholeNumber(): number;
     /**
-     * Convert decimal number to a string array of cardinal numbers.
+     * Convert ONLY decimal portion of number (processing leading zeros) to a string array of cardinal numbers.
      * @param {string} decimal Decimal string to convert.
      * @returns {string} Value in written format.
      */
     decimalToCardinal(decimal: string): string;
     /**
-     * Converts a number to written form.
-     * @param {number|string} value Number to be convert.
+     * Convert a number to cardinal form.
+     * @param {number|string|bigint} value Number to be convert.
      * @throws {Error} Value must be a valid number.
      * @returns {string} Value in written format.
      */
-    floatToCardinal(value: number | string): string;
+    floatToCardinal(value: number | string | bigint): string;
     #private;
 }

package/lib/classes/AbstractLanguage.js

@@ -20,8 +20,8 @@ export default class {
     // Merge supplied options with defaults
     options = Object.assign({
       negativeWord: '',
-      separatorWord: undefined,
-      zero: undefined,
+      separatorWord: '',
+      zero: '',
       spaceSeparator: ' '
     }, options);
 
@@ -68,42 +68,40 @@ export default class {
   }
 
   /**
-   * Convert decimal number to a string array of cardinal numbers.
+   * Convert ONLY decimal portion of number (processing leading zeros) to a string array of cardinal numbers.
    * @param {string} decimal Decimal string to convert.
    * @returns {string} Value in written format.
    */
   decimalToCardinal(decimal) {
     const words = [];
-    let allZero = true;
 
-    // Split decimal portion into an array of characters in reverse
+    // Split decimal string into an array of characters
     const chars = decimal.split('');
 
-    // Loop through array (from the end) adding leading zeros to output array
-    chars.forEach(char => {
-      if (char === '0') {
-        words.push(this.zero);
-      } else {
-        allZero = false;
-      }
-    });
+    // Loop through characters adding leading zeros to words array
+    let i = 0;
+    while (i < chars.length && chars[i] === '0') {
+      words.push(this.zero);
+      i++;
+    }
 
-    // Add decimal number to word array
-    if (allZero) {
+    // Prevent further processing if entire string was zeros
+    if (i === chars.length) {
       return words;
     }
 
+    // Convert and add remaining then return words array
     return words.concat(this.toCardinal(BigInt(decimal)));
   }
 
   /**
-   * Converts a number to written form.
-   * @param {number|string} value Number to be convert.
+   * Convert a number to cardinal form.
+   * @param {number|string|bigint} value Number to be convert.
    * @throws {Error} Value must be a valid number.
    * @returns {string} Value in written format.
    */
   floatToCardinal(value) {
-    // Validate user input value
+    // Validate user input value and convert to string (excluding BigInt)
     if (typeof value == 'number') {
       if (Number.isNaN(value)) {
         throw new Error('NaN is not an accepted number.');
@@ -111,7 +109,7 @@ export default class {
       value = value.toString();
     } else if (typeof value == 'string') {
       value = value.trim();
-      if (value.length == 0 || Number.isNaN(Number(value))) {
+      if (value.length === 0 || Number.isNaN(Number(value))) {
         throw new Error('"' + value + '" is not a valid number.');
       }
     } else if (typeof value != 'bigint') {
@@ -127,7 +125,7 @@ export default class {
       words.push(this.negativeWord);
     }
 
-    // Split value decimal (if any) (excluding BigInt)
+    // Split value decimal (if any) then convert to BigInt
     if (typeof value == 'bigint') {
       wholeNumber = value;
     } else {

package/lib/classes/BaseLanguage.d.ts

@@ -20,7 +20,7 @@ export default class _default extends AbstractLanguage {
         spaceSeparator?: string;
     }, cards: any[]);
     /**
-     * Get array of number matching "cards" from highest-to-lowest.
+     * Set array of number matching "cards" from highest-to-lowest.
      * First element in card array is the number to match while the second is the word to use.
      * @example
      * [
@@ -29,30 +29,34 @@ export default class _default extends AbstractLanguage {
      *   ...
      *   [1, 'one'],
      * ]
+     */
+    set cards(value: any[]);
+    /**
+     * Get array of number matching "cards" from highest-to-lowest.
      * @returns {Array} Array of number matching "cards" from highest-to-lowest.
      */
     get cards(): any[];
     /**
      * Get word for number if it matches a language card.
-     * @param {number} number Card number value.
+     * @param {number|bigint} number Card number value.
      * @returns {string|undefined} Return card word or undefined if no card.
      */
-    getCardWord(number: number): string | undefined;
+    getCardWord(number: number | bigint): string | undefined;
     /**
      * Get array of card matches.
-     * @param {number} value The number value to convert to cardinal form.
+     * @param {number|bigint} value The number value to convert to cardinal form.
      * @returns {object} Word sets (and pairs) from value.
      * @todo Simplify return object.
      */
-    toCardMatches(value: number): object;
+    toCardMatches(value: number | bigint): object;
     clean(words: any): any;
     postClean(out0: any): any;
     /**
      * Convert a whole number to written format.
-     * @param {number} value The number value to convert to cardinal form.
+     * @param {number|bigint} value The number value to convert to cardinal form.
      * @returns {string} Value in written format.
      */
-    toCardinal(value: number): string;
+    toCardinal(value: number | bigint): string;
     #private;
 }
 import AbstractLanguage from './AbstractLanguage.js';

package/lib/classes/BaseLanguage.js

@@ -25,6 +25,14 @@ export default class extends AbstractLanguage {
 
   /**
    * Get array of number matching "cards" from highest-to-lowest.
+   * @returns {Array} Array of number matching "cards" from highest-to-lowest.
+   */
+  get cards() {
+    return this.#cards;
+  }
+
+  /**
+   * Set array of number matching "cards" from highest-to-lowest.
    * First element in card array is the number to match while the second is the word to use.
    * @example
    * [
@@ -33,15 +41,14 @@ export default class extends AbstractLanguage {
    *   ...
    *   [1, 'one'],
    * ]
-   * @returns {Array} Array of number matching "cards" from highest-to-lowest.
    */
-  get cards() {
-    return this.#cards;
+  set cards(value) {
+    this.#cards = value;
   }
 
   /**
    * Get word for number if it matches a language card.
-   * @param {number} number Card number value.
+   * @param {number|bigint} number Card number value.
    * @returns {string|undefined} Return card word or undefined if no card.
    */
   getCardWord(number) {
@@ -54,7 +61,7 @@ export default class extends AbstractLanguage {
 
   /**
    * Get array of card matches.
-   * @param {number} value The number value to convert to cardinal form.
+   * @param {number|bigint} value The number value to convert to cardinal form.
    * @returns {object} Word sets (and pairs) from value.
    * @todo Simplify return object.
    */
@@ -153,7 +160,7 @@ export default class extends AbstractLanguage {
 
   /**
    * Convert a whole number to written format.
-   * @param {number} value The number value to convert to cardinal form.
+   * @param {number|bigint} value The number value to convert to cardinal form.
    * @returns {string} Value in written format.
    */
   toCardinal(value) {

package/lib/i18n/ar.d.ts

@@ -1,11 +1,11 @@
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.
  */
-export default function _default(value: number | string, options?: object): string;
+export default function _default(value: number | string | bigint, options?: object): string;
 export class Arabic extends AbstractLanguage {
     constructor(options: any);
     number: any;

package/lib/i18n/ar.js

@@ -205,7 +205,7 @@ export class Arabic extends AbstractLanguage {
 
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.

package/lib/i18n/az.d.ts

@@ -1,11 +1,11 @@
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.
  */
-export default function _default(value: number | string, options?: object): string;
+export default function _default(value: number | string | bigint, options?: object): string;
 export class N2WordsAZ extends BaseLanguage {
     constructor(options: any);
     merge(lPair: any, rPair: any): {

package/lib/i18n/az.js

@@ -56,7 +56,7 @@ export class N2WordsAZ extends BaseLanguage {
 
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.

package/lib/i18n/cz.d.ts

@@ -1,11 +1,11 @@
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.
  */
-export default function _default(value: number | string, options?: object): string;
+export default function _default(value: number | string | bigint, options?: object): string;
 export class N2WordsCZ extends N2WordsRU {
     ones: {
         1: string;

package/lib/i18n/cz.js

@@ -126,7 +126,7 @@ export class N2WordsCZ extends N2WordsRU {
 
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.

package/lib/i18n/de.d.ts

@@ -1,11 +1,11 @@
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.
  */
-export default function _default(value: number | string, options?: object): string;
+export default function _default(value: number | string | bigint, options?: object): string;
 export class N2WordsDE extends BaseLanguage {
     constructor(options: any);
     merge(curr: any, next: any): {

package/lib/i18n/de.js

@@ -97,7 +97,7 @@ export class N2WordsDE extends BaseLanguage {
 
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.

package/lib/i18n/dk.d.ts

@@ -1,11 +1,11 @@
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.
  */
-export default function _default(value: number | string, options?: object): string;
+export default function _default(value: number | string | bigint, options?: object): string;
 export class N2WordsDK extends BaseLanguage {
     constructor(options: any);
     ordFlag: any;

package/lib/i18n/dk.js

@@ -100,7 +100,7 @@ export class N2WordsDK extends BaseLanguage {
 
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.

package/lib/i18n/en.d.ts

@@ -1,11 +1,11 @@
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.
  */
-export default function _default(value: number | string, options?: object): string;
+export default function _default(value: number | string | bigint, options?: object): string;
 /**
  * This class is for converting numbers to english words.
  */

package/lib/i18n/en.js

@@ -76,7 +76,7 @@ export class English extends BaseLanguage {
 
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.

package/lib/i18n/es.d.ts

@@ -1,11 +1,11 @@
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.
  */
-export default function _default(value: number | string, options?: object): string;
+export default function _default(value: number | string | bigint, options?: object): string;
 export class N2WordsES extends BaseLanguage {
     constructor(options: any);
     genderStem: any;

package/lib/i18n/es.js

@@ -100,7 +100,7 @@ export class N2WordsES extends BaseLanguage {
 
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.

package/lib/i18n/fa.d.ts

@@ -1,11 +1,11 @@
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.
  */
-export default function _default(value: number | string, options?: object): string;
+export default function _default(value: number | string | bigint, options?: object): string;
 export class N2WordsFA extends AbstractLanguage {
     constructor(options: any);
     namedNumbers: {

package/lib/i18n/fa.js

@@ -96,7 +96,7 @@ export class N2WordsFA extends AbstractLanguage {
 
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.

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

@@ -1,11 +1,11 @@
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.
  */
-export default function _default(value: number | string, options?: object): string;
+export default function _default(value: number | string | bigint, options?: object): string;
 export class N2WordsFRBE extends N2WordsFR {
 }
 import { N2WordsFR } from './fr.js';

package/lib/i18n/fr-BE.js

@@ -10,7 +10,7 @@ export class N2WordsFRBE extends N2WordsFR {
 
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.

package/lib/i18n/fr.d.ts

@@ -1,11 +1,11 @@
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.
  */
-export default function _default(value: number | string, options?: object): string;
+export default function _default(value: number | string | bigint, options?: object): string;
 export class N2WordsFR extends BaseLanguage {
     constructor(options: any);
     merge(curr: any, next: any): {

package/lib/i18n/fr.js

@@ -87,7 +87,7 @@ export class N2WordsFR extends BaseLanguage {
 
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.

package/lib/i18n/he.d.ts

@@ -1,11 +1,11 @@
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.
  */
-export default function _default(value: number | string, options?: object): string;
+export default function _default(value: number | string | bigint, options?: object): string;
 export class N2WordsHE extends N2WordsRU {
     and: any;
     ones: {

package/lib/i18n/he.js

@@ -125,7 +125,7 @@ export class N2WordsHE extends N2WordsRU {
 
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.

package/lib/i18n/hr.d.ts

@@ -1,11 +1,11 @@
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.
  */
-export default function _default(value: number | string, options?: object): string;
+export default function _default(value: number | string | bigint, options?: object): string;
 export class N2WordsHR extends N2WordsRU {
     ones: {
         1: string[];

package/lib/i18n/hr.js

@@ -120,7 +120,7 @@ export class N2WordsHR extends N2WordsRU {
 
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.

package/lib/i18n/hu.d.ts

@@ -1,11 +1,11 @@
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.
  */
-export default function _default(value: number | string, options?: object): string;
+export default function _default(value: number | string | bigint, options?: object): string;
 export class N2WordsHU extends BaseLanguage {
     constructor(options: any);
     tensToCardinal(number: any): string;

package/lib/i18n/hu.js

@@ -125,7 +125,7 @@ export class N2WordsHU extends BaseLanguage {
 
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.

package/lib/i18n/id.d.ts

@@ -1,11 +1,11 @@
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.
  */
-export default function _default(value: number | string, options?: object): string;
+export default function _default(value: number | string | bigint, options?: object): string;
 export class N2WordsID extends AbstractLanguage {
     constructor(options: any);
     base: {

package/lib/i18n/id.js

@@ -156,7 +156,7 @@ export class N2WordsID extends AbstractLanguage {
 
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.

package/lib/i18n/it.d.ts

@@ -1,11 +1,11 @@
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.
  */
-export default function _default(value: number | string, options?: object): string;
+export default function _default(value: number | string | bigint, options?: object): string;
 export class N2WordsIT extends BaseLanguage {
     constructor(options: any);
     cardinalWords: string[];

package/lib/i18n/it.js

@@ -147,7 +147,7 @@ export class N2WordsIT extends BaseLanguage {
 
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.

package/lib/i18n/ko.d.ts

@@ -1,11 +1,11 @@
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.
  */
-export default function _default(value: number | string, options?: object): string;
+export default function _default(value: number | string | bigint, options?: object): string;
 export class N2WordsKO extends BaseLanguage {
     constructor(options: any);
     merge(lPair: any, rPair: any): {

package/lib/i18n/ko.js

@@ -46,7 +46,7 @@ export class N2WordsKO extends BaseLanguage {
 
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.

package/lib/i18n/lt.d.ts

@@ -1,11 +1,11 @@
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.
  */
-export default function _default(value: number | string, options?: object): string;
+export default function _default(value: number | string | bigint, options?: object): string;
 export class N2WordsLT extends N2WordsRU {
     ones: {
         1: string;

package/lib/i18n/lt.js

@@ -129,7 +129,7 @@ export class N2WordsLT extends N2WordsRU {
 
 /**
  * Converts a value to cardinal (written) form.
- * @param {number|string} value Number to be convert.
+ * @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.