n2words 5.0.0 → 5.1.0

package/src/en-NG.js

@@ -23,7 +23,9 @@
 import { parseCardinalValue } from './utils/parse-cardinal.js'
 import { parseCurrencyValue } from './utils/parse-currency.js'
 import { parseOrdinalValue } from './utils/parse-ordinal.js'
-import { validateOptions } from './utils/validate-options.js'
+import { checkMax } from './utils/check-max.js'
+import { western } from './utils/scale.js'
+import { resolveOptions } from './utils/resolve-options.js'
 
 // ============================================================================
 // Vocabulary (module-level constants)
@@ -38,9 +40,13 @@ const SCALES = [
   'quintillion', 'sextillion', 'septillion', 'octillion', 'nonillion',
   'decillion', 'undecillion', 'duodecillion', 'tredecillion', 'quattuordecillion',
   'quindecillion', 'sexdecillion', 'septendecillion', 'octodecillion', 'novemdecillion',
-  'vigintillion'
+  'vigintillion',
 ]
 
+export const cardinalMax = western(SCALES.length)
+export const ordinalMax = western(SCALES.length)
+export const currencyMax = western(SCALES.length)
+
 const HUNDRED = 'hundred'
 const ZERO = 'zero'
 const NEGATIVE = 'minus'
@@ -64,11 +70,10 @@ const segmentResult = { word: '', hasHundred: false }
 
 /**
  * Builds words for a 0-999 segment.
- *
  * @param {number} n - Number 0-999
- * @returns {{ word: string, hasHundred: boolean }}
+ * @returns {{ word: string, hasHundred: boolean }} The segment words and whether it includes a hundreds place
  */
-function buildSegment (n) {
+function buildSegment(n) {
   if (n === 0) {
     segmentResult.word = ''
     segmentResult.hasHundred = false
@@ -83,9 +88,11 @@ function buildSegment (n) {
   let tensOnes = ''
   if (tens === 1) {
     tensOnes = TEENS[ones]
-  } else if (tens >= 2) {
+  }
+  else if (tens >= 2) {
     tensOnes = ones > 0 ? TENS[tens] + '-' + ONES[ones] : TENS[tens]
-  } else if (ones > 0) {
+  }
+  else if (ones > 0) {
     tensOnes = ONES[ones]
   }
 
@@ -93,11 +100,13 @@ function buildSegment (n) {
   if (hundreds > 0) {
     if (tensOnes) {
       segmentResult.word = ONES[hundreds] + ' ' + HUNDRED + ' and ' + tensOnes
-    } else {
+    }
+    else {
       segmentResult.word = ONES[hundreds] + ' ' + HUNDRED
     }
     segmentResult.hasHundred = true
-  } else {
+  }
+  else {
     segmentResult.word = tensOnes
     segmentResult.hasHundred = false
   }
@@ -111,11 +120,10 @@ function buildSegment (n) {
 
 /**
  * Converts a non-negative integer to English words.
- *
  * @param {bigint} n - Non-negative integer to convert
  * @returns {string} English words
  */
-function integerToWords (n) {
+function integerToWords(n) {
   if (n === 0n) return ZERO
 
   // Fast path: numbers < 1000
@@ -146,11 +154,10 @@ function integerToWords (n) {
 /**
  * Builds words for numbers >= 1,000,000.
  * Uses BigInt division for faster segment extraction.
- *
  * @param {bigint} n - Number >= 1,000,000
  * @returns {string} English words
  */
-function buildLargeNumberWords (n) {
+function buildLargeNumberWords(n) {
   // Extract segments using BigInt division
   // Segments are stored least-significant first (index 0 = ones, 1 = thousands, etc.)
   const segments = []
@@ -193,7 +200,8 @@ function buildLargeNumberWords (n) {
     if (i > 0) {
       result += ' ' + SCALES[i - 1]
       prevWasScale = true
-    } else {
+    }
+    else {
       prevWasScale = false
     }
   }
@@ -203,11 +211,10 @@ function buildLargeNumberWords (n) {
 
 /**
  * Converts decimal digits to English words.
- *
  * @param {string} decimalPart - Decimal digits (without the point)
  * @returns {string} English words for decimal part
  */
-function decimalPartToWords (decimalPart) {
+function decimalPartToWords(decimalPart) {
   let result = ''
 
   // Handle leading zeros
@@ -233,19 +240,20 @@ function decimalPartToWords (decimalPart) {
  *
  * This is the main public API. It accepts any valid numeric input
  * (number, string, or bigint) and handles parsing internally.
- *
  * @param {number | string | bigint} value - The numeric value to convert
  * @returns {string} The number in English words
  * @throws {TypeError} If value is not a valid numeric type
  * @throws {Error} If value is not a valid number format
- *
  * @example
  * toCardinal(42)           // 'forty-two'
  * toCardinal(-3.14)        // 'minus three point fourteen'
  * toCardinal('1000000')    // 'one million'
  */
-function toCardinal (value) {
+function toCardinal(value) {
   const { isNegative, integerPart, decimalPart } = parseCardinalValue(value)
+  // Both the integer part and the decimal's significant digits are spelled via
+  // the scale builder, so both must clear the ceiling.
+  checkMax(integerPart, cardinalMax, decimalPart)
 
   let result = ''
 
@@ -269,11 +277,10 @@ function toCardinal (value) {
 /**
  * Builds ordinal words for a 0-999 segment (final segment only).
  * Returns ordinal form: "first", "twenty-third", "one hundred forty-fifth"
- *
  * @param {number} n - Number 0-999
  * @returns {string} Ordinal words for this segment
  */
-function buildOrdinalSegment (n) {
+function buildOrdinalSegment(n) {
   const ones = n % 10
   const tens = Math.trunc(n / 10) % 10
   const hundreds = Math.trunc(n / 100)
@@ -283,15 +290,18 @@ function buildOrdinalSegment (n) {
   if (tens === 1) {
     // Teens: 10-19 → "tenth" through "nineteenth"
     tensOnesOrdinal = ORDINAL_TEENS[ones]
-  } else if (tens >= 2) {
+  }
+  else if (tens >= 2) {
     if (ones > 0) {
       // Compound: "twenty-first", "thirty-second", etc.
       tensOnesOrdinal = TENS[tens] + '-' + ORDINAL_ONES[ones]
-    } else {
+    }
+    else {
       // Round tens: "twentieth", "thirtieth", etc.
       tensOnesOrdinal = ORDINAL_TENS[tens]
     }
-  } else if (ones > 0) {
+  }
+  else if (ones > 0) {
     // Single digit: "first", "second", etc.
     tensOnesOrdinal = ORDINAL_ONES[ones]
   }
@@ -301,7 +311,8 @@ function buildOrdinalSegment (n) {
     if (tensOnesOrdinal) {
       // "one hundred twenty-first"
       return ONES[hundreds] + ' ' + HUNDRED + ' ' + tensOnesOrdinal
-    } else {
+    }
+    else {
       // "one hundredth", "two hundredth", etc.
       return ONES[hundreds] + ' hundredth'
     }
@@ -313,11 +324,10 @@ function buildOrdinalSegment (n) {
 /**
  * Converts a positive integer to ordinal words.
  * Generates ordinals directly without string manipulation.
- *
  * @param {bigint} n - Positive integer to convert
  * @returns {string} Ordinal English words
  */
-function integerToOrdinal (n) {
+function integerToOrdinal(n) {
   // Fast path: numbers < 1000
   if (n < 1000n) {
     return buildOrdinalSegment(Number(n))
@@ -345,11 +355,10 @@ function integerToOrdinal (n) {
 /**
  * Builds ordinal words for numbers >= 1,000,000.
  * All segments except the final one are cardinal; final segment is ordinal.
- *
  * @param {bigint} n - Number >= 1,000,000
  * @returns {string} Ordinal English words
  */
-function buildLargeOrdinal (n) {
+function buildLargeOrdinal(n) {
   // Extract segments (least-significant first)
   const segments = []
   let temp = n
@@ -383,11 +392,13 @@ function buildLargeOrdinal (n) {
       if (i === 0) {
         // Units position: use ordinal segment
         result += buildOrdinalSegment(segment)
-      } else {
+      }
+      else {
         // Scale position with no remainder below: "one millionth"
         result += buildSegment(segment).word + ' ' + SCALES[i - 1] + 'th'
       }
-    } else {
+    }
+    else {
       // Non-final segments are cardinal
       result += buildSegment(segment).word
       if (i > 0) {
@@ -401,12 +412,10 @@ function buildLargeOrdinal (n) {
 
 /**
  * Converts a numeric value to Nigerian English ordinal words.
- *
  * @param {number | string | bigint} value - The numeric value to convert (must be a positive integer)
  * @returns {string} The number as ordinal words (e.g., "first", "forty-second")
  * @throws {TypeError} If value is not a valid numeric type
  * @throws {RangeError} If value is negative, zero, or has a decimal part
- *
  * @example
  * toOrdinal(1)    // 'first'
  * toOrdinal(2)    // 'second'
@@ -417,8 +426,9 @@ function buildLargeOrdinal (n) {
  * toOrdinal(101)  // 'one hundred first'
  * toOrdinal(1000) // 'one thousandth'
  */
-function toOrdinal (value) {
+function toOrdinal(value) {
   const integerPart = parseOrdinalValue(value)
+  checkMax(integerPart, ordinalMax)
   return integerToOrdinal(integerPart)
 }
 
@@ -426,16 +436,21 @@ function toOrdinal (value) {
 // CURRENCY: toCurrency(value, options?)
 // ============================================================================
 
+/**
+ * @typedef {object} CurrencyOptions
+ * @property {boolean} [and] - Use "and" between naira and kobo (e.g., "one naira and fifty kobo")
+ */
+
+/** @type {Required<CurrencyOptions>} */
+export const currencyDefaults = { and: true }
+
 /**
  * Converts a numeric value to Nigerian English currency words.
- *
  * @param {number | string | bigint} value - The currency amount to convert
- * @param {Object} [options] - Optional configuration
- * @param {boolean} [options.and=true] - Use "and" between naira and kobo (e.g., "one naira and fifty kobo")
+ * @param {CurrencyOptions} [options] - Optional configuration
  * @returns {string} The amount in Nigerian English currency words
  * @throws {TypeError} If value is not a valid numeric type
  * @throws {Error} If value is not a valid number format
- *
  * @example
  * toCurrency(42.50)                    // 'forty-two naira and fifty kobo'
  * toCurrency(1)                        // 'one naira'
@@ -443,10 +458,10 @@ function toOrdinal (value) {
  * toCurrency(0.01)                     // 'one kobo'
  * toCurrency(42.50, { and: false })    // 'forty-two naira fifty kobo'
  */
-function toCurrency (value, options) {
-  options = validateOptions(options)
+function toCurrency(value, options) {
   const { isNegative, dollars: naira, cents: kobo } = parseCurrencyValue(value)
-  const { and: useAnd = true } = options
+  checkMax(naira, currencyMax)
+  const { and: useAnd } = resolveOptions(options, currencyDefaults)
 
   // Build result
   let result = ''

package/src/en-NZ.d.ts

@@ -1,11 +1,40 @@
+export const cardinalMax: bigint;
+export const ordinalMax: bigint;
+export const currencyMax: bigint;
+/**
+ * @typedef {object} CurrencyOptions
+ * @property {boolean} [and] - Use "and" between dollars and cents
+ */
+/** @type {Required<CurrencyOptions>} */
+export const currencyDefaults: Required<CurrencyOptions>;
+export type CurrencyOptions = {
+    /**
+     * - Use "and" between dollars and cents
+     */
+    and?: boolean | undefined;
+};
 /**
  * Converts a numeric value to New Zealand English words.
- *
  * @param {number | string | bigint} value - The numeric value to convert
  * @returns {string} The number in English words
  * @throws {TypeError} If value is not a valid numeric type
  * @throws {Error} If value is not a valid number format
  */
 export function toCardinal(value: number | string | bigint): string;
-export function toOrdinal(value: any): string;
-export function toCurrency(value: any, options: any): string;
+/**
+ * Converts a numeric value to New Zealand English ordinal words.
+ * @param {number | string | bigint} value - The numeric value to convert (positive integer)
+ * @returns {string} The number as ordinal words
+ * @throws {TypeError} If value is not a valid numeric type
+ * @throws {RangeError} If value is negative, zero, or has a decimal part
+ */
+export function toOrdinal(value: number | string | bigint): string;
+/**
+ * Converts a numeric value to New Zealand English currency words (New Zealand Dollar).
+ * @param {number | string | bigint} value - The currency amount to convert
+ * @param {CurrencyOptions} [options] - Optional configuration
+ * @returns {string} The amount in New Zealand English currency words
+ * @throws {TypeError} If value is not a valid numeric type
+ * @throws {Error} If value is not a valid number format
+ */
+export function toCurrency(value: number | string | bigint, options?: CurrencyOptions): string;

package/src/en-NZ.js

@@ -20,7 +20,9 @@
 import { parseCardinalValue } from './utils/parse-cardinal.js'
 import { parseCurrencyValue } from './utils/parse-currency.js'
 import { parseOrdinalValue } from './utils/parse-ordinal.js'
-import { validateOptions } from './utils/validate-options.js'
+import { checkMax } from './utils/check-max.js'
+import { western } from './utils/scale.js'
+import { resolveOptions } from './utils/resolve-options.js'
 
 // ============================================================================
 // Vocabulary (module-level constants)
@@ -35,9 +37,13 @@ const SCALES = [
   'quintillion', 'sextillion', 'septillion', 'octillion', 'nonillion',
   'decillion', 'undecillion', 'duodecillion', 'tredecillion', 'quattuordecillion',
   'quindecillion', 'sexdecillion', 'septendecillion', 'octodecillion', 'novemdecillion',
-  'vigintillion'
+  'vigintillion',
 ]
 
+export const cardinalMax = western(SCALES.length)
+export const ordinalMax = western(SCALES.length)
+export const currencyMax = western(SCALES.length)
+
 const HUNDRED = 'hundred'
 const ZERO = 'zero'
 const NEGATIVE = 'minus'
@@ -63,11 +69,10 @@ const segmentResult = { word: '', hasHundred: false }
 
 /**
  * Builds words for a 0-999 segment.
- *
  * @param {number} n - Number 0-999
- * @returns {{ word: string, hasHundred: boolean }}
+ * @returns {{ word: string, hasHundred: boolean }} The segment words and whether a hundreds part is present
  */
-function buildSegment (n) {
+function buildSegment(n) {
   if (n === 0) {
     segmentResult.word = ''
     segmentResult.hasHundred = false
@@ -82,9 +87,11 @@ function buildSegment (n) {
   let tensOnes = ''
   if (tens === 1) {
     tensOnes = TEENS[ones]
-  } else if (tens >= 2) {
+  }
+  else if (tens >= 2) {
     tensOnes = ones > 0 ? TENS[tens] + '-' + ONES[ones] : TENS[tens]
-  } else if (ones > 0) {
+  }
+  else if (ones > 0) {
     tensOnes = ONES[ones]
   }
 
@@ -92,11 +99,13 @@ function buildSegment (n) {
   if (hundreds > 0) {
     if (tensOnes) {
       segmentResult.word = ONES[hundreds] + ' ' + HUNDRED + ' and ' + tensOnes
-    } else {
+    }
+    else {
       segmentResult.word = ONES[hundreds] + ' ' + HUNDRED
     }
     segmentResult.hasHundred = true
-  } else {
+  }
+  else {
     segmentResult.word = tensOnes
     segmentResult.hasHundred = false
   }
@@ -110,11 +119,10 @@ function buildSegment (n) {
 
 /**
  * Converts a non-negative integer to English words.
- *
  * @param {bigint} n - Non-negative integer to convert
  * @returns {string} English words
  */
-function integerToWords (n) {
+function integerToWords(n) {
   if (n === 0n) return ZERO
 
   // Fast path: numbers < 1000
@@ -144,11 +152,10 @@ function integerToWords (n) {
 
 /**
  * Builds words for numbers >= 1,000,000.
- *
  * @param {bigint} n - Number >= 1,000,000
  * @returns {string} English words
  */
-function buildLargeNumberWords (n) {
+function buildLargeNumberWords(n) {
   const segments = []
   let temp = n
   while (temp > 0n) {
@@ -184,7 +191,8 @@ function buildLargeNumberWords (n) {
     if (i > 0) {
       result += ' ' + SCALES[i - 1]
       prevWasScale = true
-    } else {
+    }
+    else {
       prevWasScale = false
     }
   }
@@ -194,11 +202,10 @@ function buildLargeNumberWords (n) {
 
 /**
  * Converts decimal digits to English words.
- *
  * @param {string} decimalPart - Decimal digits (without the point)
  * @returns {string} English words for decimal part
  */
-function decimalPartToWords (decimalPart) {
+function decimalPartToWords(decimalPart) {
   let result = ''
 
   let i = 0
@@ -219,14 +226,16 @@ function decimalPartToWords (decimalPart) {
 
 /**
  * Converts a numeric value to New Zealand English words.
- *
  * @param {number | string | bigint} value - The numeric value to convert
  * @returns {string} The number in English words
  * @throws {TypeError} If value is not a valid numeric type
  * @throws {Error} If value is not a valid number format
  */
-function toCardinal (value) {
+function toCardinal(value) {
   const { isNegative, integerPart, decimalPart } = parseCardinalValue(value)
+  // Both the integer part and the decimal's significant digits are spelled via
+  // the scale builder, so both must clear the ceiling.
+  checkMax(integerPart, cardinalMax, decimalPart)
 
   let result = ''
 
@@ -247,7 +256,12 @@ function toCardinal (value) {
 // ORDINAL
 // ============================================================================
 
-function buildOrdinalSegment (n) {
+/**
+ * Builds ordinal words for a 0-999 segment.
+ * @param {number} n - Number 0-999
+ * @returns {string} Ordinal words
+ */
+function buildOrdinalSegment(n) {
   const ones = n % 10
   const tens = Math.trunc(n / 10) % 10
   const hundreds = Math.trunc(n / 100)
@@ -255,20 +269,24 @@ function buildOrdinalSegment (n) {
   let tensOnesOrdinal = ''
   if (tens === 1) {
     tensOnesOrdinal = ORDINAL_TEENS[ones]
-  } else if (tens >= 2) {
+  }
+  else if (tens >= 2) {
     if (ones > 0) {
       tensOnesOrdinal = TENS[tens] + '-' + ORDINAL_ONES[ones]
-    } else {
+    }
+    else {
       tensOnesOrdinal = ORDINAL_TENS[tens]
     }
-  } else if (ones > 0) {
+  }
+  else if (ones > 0) {
     tensOnesOrdinal = ORDINAL_ONES[ones]
   }
 
   if (hundreds > 0) {
     if (tensOnesOrdinal) {
       return ONES[hundreds] + ' ' + HUNDRED + ' ' + tensOnesOrdinal
-    } else {
+    }
+    else {
       return ONES[hundreds] + ' hundredth'
     }
   }
@@ -276,7 +294,12 @@ function buildOrdinalSegment (n) {
   return tensOnesOrdinal
 }
 
-function integerToOrdinal (n) {
+/**
+ * Converts a non-negative integer to English ordinal words.
+ * @param {bigint} n - Non-negative integer to convert
+ * @returns {string} English ordinal words
+ */
+function integerToOrdinal(n) {
   if (n < 1000n) {
     return buildOrdinalSegment(Number(n))
   }
@@ -296,7 +319,12 @@ function integerToOrdinal (n) {
   return buildLargeOrdinal(n)
 }
 
-function buildLargeOrdinal (n) {
+/**
+ * Builds ordinal words for numbers >= 1,000,000.
+ * @param {bigint} n - Number >= 1,000,000
+ * @returns {string} English ordinal words
+ */
+function buildLargeOrdinal(n) {
   const segments = []
   let temp = n
   while (temp > 0n) {
@@ -325,10 +353,12 @@ function buildLargeOrdinal (n) {
     if (isLowestSegment) {
       if (i === 0) {
         result += buildOrdinalSegment(segment)
-      } else {
+      }
+      else {
         result += buildSegment(segment).word + ' ' + SCALES[i - 1] + 'th'
       }
-    } else {
+    }
+    else {
       result += buildSegment(segment).word
       if (i > 0) {
         result += ' ' + SCALES[i - 1]
@@ -339,8 +369,16 @@ function buildLargeOrdinal (n) {
   return result
 }
 
-function toOrdinal (value) {
+/**
+ * Converts a numeric value to New Zealand English ordinal words.
+ * @param {number | string | bigint} value - The numeric value to convert (positive integer)
+ * @returns {string} The number as ordinal words
+ * @throws {TypeError} If value is not a valid numeric type
+ * @throws {RangeError} If value is negative, zero, or has a decimal part
+ */
+function toOrdinal(value) {
   const integerPart = parseOrdinalValue(value)
+  checkMax(integerPart, ordinalMax)
   return integerToOrdinal(integerPart)
 }
 
@@ -348,10 +386,26 @@ function toOrdinal (value) {
 // CURRENCY
 // ============================================================================
 
-function toCurrency (value, options) {
-  options = validateOptions(options)
+/**
+ * @typedef {object} CurrencyOptions
+ * @property {boolean} [and] - Use "and" between dollars and cents
+ */
+
+/** @type {Required<CurrencyOptions>} */
+export const currencyDefaults = { and: true }
+
+/**
+ * Converts a numeric value to New Zealand English currency words (New Zealand Dollar).
+ * @param {number | string | bigint} value - The currency amount to convert
+ * @param {CurrencyOptions} [options] - Optional configuration
+ * @returns {string} The amount in New Zealand English currency words
+ * @throws {TypeError} If value is not a valid numeric type
+ * @throws {Error} If value is not a valid number format
+ */
+function toCurrency(value, options) {
   const { isNegative, dollars, cents } = parseCurrencyValue(value)
-  const { and: useAnd = true } = options
+  checkMax(dollars, currencyMax)
+  const { and: useAnd } = resolveOptions(options, currencyDefaults)
 
   let result = ''
   if (isNegative) result = NEGATIVE + ' '

package/src/en-PH.d.ts

@@ -1,11 +1,40 @@
+export const cardinalMax: bigint;
+export const ordinalMax: bigint;
+export const currencyMax: bigint;
+/**
+ * @typedef {object} CurrencyOptions
+ * @property {boolean} [and] - Use "and" between pesos and centavos
+ */
+/** @type {Required<CurrencyOptions>} */
+export const currencyDefaults: Required<CurrencyOptions>;
+export type CurrencyOptions = {
+    /**
+     * - Use "and" between pesos and centavos
+     */
+    and?: boolean | undefined;
+};
 /**
  * Converts a numeric value to Philippine English words.
- *
  * @param {number | string | bigint} value - The numeric value to convert
  * @returns {string} The number in English words
  * @throws {TypeError} If value is not a valid numeric type
  * @throws {Error} If value is not a valid number format
  */
 export function toCardinal(value: number | string | bigint): string;
-export function toOrdinal(value: any): string;
-export function toCurrency(value: any, options: any): string;
+/**
+ * Converts a numeric value to Philippine English ordinal words.
+ * @param {number | string | bigint} value - The numeric value to convert (must be a positive integer)
+ * @returns {string} The number as ordinal words (e.g., "first", "forty-second")
+ * @throws {TypeError} If value is not a valid numeric type
+ * @throws {RangeError} If value is negative, zero, or has a decimal part
+ */
+export function toOrdinal(value: number | string | bigint): string;
+/**
+ * Converts a numeric value to Philippine English currency words.
+ * @param {number | string | bigint} value - The numeric value to convert
+ * @param {CurrencyOptions} [options] - Optional configuration
+ * @returns {string} The amount in Philippine English currency words
+ * @throws {TypeError} If value is not a valid numeric type
+ * @throws {Error} If value is not a valid number format
+ */
+export function toCurrency(value: number | string | bigint, options?: CurrencyOptions): string;