n2words 1.24.0 → 3.0.0

package/typings/languages/it.d.ts

@@ -1,51 +0,0 @@
-/**
- * Converts a number to Italian cardinal (written) form.
- *
- * @param {number|string|bigint} value The number to convert.
- * @param {Object} [options={}] Configuration options.
- * @returns {string} The number expressed in Italian words.
- * @throws {TypeError} If value is NaN or invalid type.
- * @throws {Error} If value is an invalid number string.
- */
-export default function convertToWords(value: number | string | bigint, options?: any): string;
-/**
- * Italian language converter.
- *
- * Converts numbers to Italian words following Italian conventions:
- * - Phonetic contractions (removes duplicate vowels: "ventotto" not "ventiotto")
- * - Accentuation rules for "tre" in compounds ("ventitré" not "ventitre")
- * - Special handling for "uno" and vowel agreement
- * - Complex composition patterns for large numbers
- *
- * Architecture Note:
- * Unlike other GreedyScaleLanguage subclasses, Italian uses a custom algorithm
- * rather than the standard highest-matching-scale approach. This is necessary
- * because Italian's word formation rules are irregular and context-dependent.
- * See tensToCardinal(), hundredsToCardinal(), and bigNumberToCardinal().
- *
- * Features:
- * - Vowel elision (e.g., "ventotto" not "ventiotto")
- * - Accentuation of final "tre" (ventitré, trentacinque - note: accent on compound tres)
- * - Exponent-based large number naming (milione, miliardo, trilione)
- * - Custom word construction for hundreds and thousands
- */
-export class Italian extends GreedyScaleLanguage {
-    cardinalWords: string[];
-    strTens: {
-        2: string;
-        3: string;
-        4: string;
-        6: string;
-    };
-    exponentPrefixes: string[];
-    accentuate(string: any): any;
-    omitIfZero(numberToString: any): any;
-    phoneticContraction(string: any): any;
-    tensToCardinal(number: any): any;
-    hundredsToCardinal(number: any): any;
-    thousandsToCardinal(number: any): string;
-    exponentLengthToString(exponentLength: any): string;
-    bigNumberToCardinal(number: any): string;
-    convertWholePart(number: any): any;
-}
-import GreedyScaleLanguage from '../classes/greedy-scale-language.js';

package/typings/languages/ja.d.ts

@@ -1,58 +0,0 @@
-/**
- * Converts a value to cardinal (written) form in Japanese.
- *
- * @param {number|string|bigint} value - Number to convert.
- * @param {Object} [options] - Options for the converter.
- * @returns {string} Value in Japanese kanji numerals.
- * @throws {Error} If value is invalid.
- *
- * @example
- * convertToWords(42, { lang: 'ja' }); // '四十二'
- * convertToWords(1000, { lang: 'ja' }); // '千'
- * convertToWords(10000, { lang: 'ja' }); // '一万'
- */
-export default function convertToWords(value: number | string | bigint, options?: any): string;
-/**
- * Japanese language converter.
- *
- * Converts numbers to Japanese kanji numerals using the Sino-Japanese system:
- * - Uses kanji characters (一, 二, 三, etc.)
- * - Grouping by 万 (man, 10,000) and 億 (oku, 100,000,000)
- * - Unique scale units: 兆 (chō, trillion), 京 (kei, 10^16)
- * - Special rules for 1: omitted before 十 (10), 百 (100), 千 (1000), but kept for 万 and above
- *
- * Key Features:
- * - Sino-Japanese number system (standard for general counting)
- * - Grouping by powers of 10,000 (万-based system, not 1,000)
- * - Scale units: 万 (10^4), 億 (10^8), 兆 (10^12), 京 (10^16)
- * - Special handling of 一 (one) prefix
- * - Support for very large numbers up to 無量大数 (10^68)
- *
- * Algorithm:
- * 1. Split number into groups of 4 digits (万-based, not 3-digit thousand-based)
- * 2. Convert each group to kanji using special rules
- * 3. Append appropriate scale word (万, 億, 兆, etc.)
- * 4. Join all groups
- *
- * Special Rules:
- * - 10, 100, 1000: Don't use 一 prefix (十, 百, 千 not 一十, 一百, 一千)
- * - 10,000+: Keep 一 prefix (一万, 一億, 一兆)
- * - Zero: 零 or 〇 (both acceptable, 零 is more formal)
- */
-export class Japanese extends AbstractLanguage {
-    scales: string[];
-    /**
-     * Converts a group of up to 4 digits to Japanese kanji.
-     * Handles special rules for omitting 一 before 十, 百, 千.
-     *
-     * Rule: Within a group, omit 一 before 十/百/千 EXCEPT when:
-     * - It's a lower group (not isTopGroup) AND
-     * - It would be the only character in that position
-     *
-     * @param {bigint} num - Number from 0 to 9999
-     * @param {boolean} isTopGroup - Whether this is the highest non-zero group
-     * @returns {string} Japanese kanji representation
-     */
-    convertGroup(num: bigint, isTopGroup?: boolean): string;
-}
-import AbstractLanguage from '../classes/abstract-language.js';

package/typings/languages/kn.d.ts

@@ -1,11 +0,0 @@
-/**
- * Converts a number to its word representation in Kannada.
- * @param {number|string|bigint} value - The number to convert
- * @param {Object} [options={}] - Conversion options
- * @returns {string} The word representation of the number
- * @example
- * convertToWords(42) // 'ನಲವತ್ತೆರಡು'
- * convertToWords(1000) // 'ಒಂದು ಸಾವಿರ'
- * convertToWords(100000) // 'ಒಂದು ಲಕ್ಷ'
- */
-export default function convertToWords(value: number | string | bigint, options?: any): string;

package/typings/languages/ko.d.ts

@@ -1,25 +0,0 @@
-/**
- * Converts a number to Korean cardinal (written) form.
- *
- * @param {number|string|bigint} value The number to convert.
- * @param {Object} [options] Conversion options (see Korean class options).
- * @returns {string} The number expressed in Korean words.
- * @throws {TypeError} If value is NaN or invalid type.
- * @throws {Error} If value is an invalid number string.
- *
- * @example
- * convertToWords(42); // '사십이'
- * convertToWords(10001); // '만 일'
- */
-export default function convertToWords(value: number | string | bigint, options?: any): string;
-/**
- * Korean language converter.
- *
- * Features:
- * - Space-separated for large numbers (>= 만/10,000)
- * - Concatenated for smaller numbers
- * - Omits '일' (1) before multipliers
- */
-export class Korean extends GreedyScaleLanguage {
-}
-import GreedyScaleLanguage from '../classes/greedy-scale-language.js';

package/typings/languages/lt.d.ts

@@ -1,110 +0,0 @@
-/**
- * Converts a number to Lithuanian cardinal (written) form.
- *
- * @param {number|string|bigint} value The number to convert.
- * @param {Object} [options={}] Configuration options.
- * @param {boolean} [options.feminine=false] Use feminine forms for numbers.
- * @returns {string} The number expressed in Lithuanian words.
- * @throws {TypeError} If value is NaN or invalid type.
- * @throws {Error} If value is an invalid number string.
- */
-export default function convertToWords(value: number | string | bigint, options?: {
-    feminine?: boolean;
-}): string;
-/**
- * @typedef {Object} SlavicOptions
- * @property {boolean} [feminine=false] Use feminine forms for numbers.
- */
-/**
- * Lithuanian language converter.
- *
- * Implements Lithuanian number words using the Slavic language pattern:
- * - Lithuanian number words (vienas/viena, du/dvi, trys, keturi...)
- * - Gender-aware forms (masculine/feminine)
- * - Baltic three-form pluralization (tūkstantis/tūkstančiai/tūkstančių)
- * - Lithuanian-specific declension patterns
- *
- * Key Features:
- * - Three-form pluralization system shared across Slavic/Baltic languages
- *   * Form 1 (singular): 1 (e.g., "tūkstantis")
- *   * Form 2 (few): 2-4, 22-24, 32-34... excluding teens (e.g., "tūkstančiai")
- *   * Form 3 (many): all other numbers (e.g., "tūkstančių")
- * - Chunk-based decomposition (splits into groups of 3 digits: ones, thousands, millions, etc.)
- * - Large number handling via thousands[] array with indexed [singular, few, many] forms
- * - Gender-specific number forms for 1 and 2 (masculine/feminine dual forms)
- *
- * Features:
- * - Dual gender forms (vienas/viena, du/dvi, keturi/keturios)
- * - Complex declension patterns for large numbers
- * - Baltic language characteristics
- *
- * Inherits from SlavicLanguage as Lithuanian uses similar pluralization.
- */
-export class Lithuanian extends SlavicLanguage {
-    ones: {
-        1: string;
-        2: string;
-        3: string;
-        4: string;
-        5: string;
-        6: string;
-        7: string;
-        8: string;
-        9: string;
-    };
-    onesFeminine: {
-        1: string;
-        2: string;
-        3: string;
-        4: string;
-        5: string;
-        6: string;
-        7: string;
-        8: string;
-        9: string;
-    };
-    tens: {
-        0: string;
-        1: string;
-        2: string;
-        3: string;
-        4: string;
-        5: string;
-        6: string;
-        7: string;
-        8: string;
-        9: string;
-    };
-    twenties: {
-        2: string;
-        3: string;
-        4: string;
-        5: string;
-        6: string;
-        7: string;
-        8: string;
-        9: string;
-    };
-    hundreds: string[];
-    thousands: {
-        1: string[];
-        2: string[];
-        3: string[];
-        4: string[];
-        5: string[];
-        6: string[];
-        7: string[];
-        8: string[];
-        9: string[];
-        10: string[];
-    };
-    pluralize(n: any, forms: any): any;
-    convertWholePart(number: any): string;
-}
-export type SlavicOptions = {
-    /**
-     * Use feminine forms for numbers.
-     */
-    feminine?: boolean;
-};
-import SlavicLanguage from '../classes/slavic-language.js';

package/typings/languages/lv.d.ts

@@ -1,99 +0,0 @@
-/**
- * Converts a number to Latvian cardinal (written) form.
- *
- * @param {number|string|bigint} value The number to convert.
- * @param {Object} [options={}] Configuration options.
- * @param {boolean} [options.feminine=false] Use feminine forms for numbers.
- * @returns {string} The number expressed in Latvian words.
- * @throws {TypeError} If value is NaN or invalid type.
- * @throws {Error} If value is an invalid number string.
- */
-export default function convertToWords(value: number | string | bigint, options?: {
-    feminine?: boolean;
-}): string;
-/**
- * @typedef {Object} SlavicOptions
- * @property {boolean} [feminine=false] Use feminine forms for numbers.
- */
-/**
- * Latvian language converter.
- *
- * Implements Latvian number words using the Slavic language pattern:
- * - Latvian number words (viens, divi, trīs, četri, pieci...)
- * - Latvian-specific pluralization patterns
- * - Baltic grammatical structure
- * - Simplified gender handling compared to Lithuanian
- *
- * Key Features:
- * - Three-form pluralization system shared across Slavic/Baltic languages
- *   * Form 1 (singular): 1 (e.g., "tūkstotis")
- *   * Form 2 (few): 2-4, 22-24, 32-34... excluding teens (e.g., "tūkstoši")
- *   * Form 3 (many): all other numbers (e.g., "tūkstošu")
- * - Chunk-based decomposition (splits into groups of 3 digits: ones, thousands, millions, etc.)
- * - Large number handling via thousands[] array with indexed [singular, few, many] forms
- *
- * Features:
- * - Latvian diacritical marks (ī, ā, ē, ū, etc.)
- * - Three-form pluralization (adapted for Latvian)
- * - Baltic number naming conventions
- * - Compound number formation (divdesmit, trīsdesmit)
- *
- * Inherits from SlavicLanguage for pluralization algorithms.
- */
-export class Latvian extends SlavicLanguage {
-    ones: {
-        1: string;
-        2: string;
-        3: string;
-        4: string;
-        5: string;
-        6: string;
-        7: string;
-        8: string;
-        9: string;
-    };
-    tens: {
-        0: string;
-        1: string;
-        2: string;
-        3: string;
-        4: string;
-        5: string;
-        6: string;
-        7: string;
-        8: string;
-        9: string;
-    };
-    twenties: {
-        2: string;
-        3: string;
-        4: string;
-        5: string;
-        6: string;
-        7: string;
-        8: string;
-        9: string;
-    };
-    hundreds: string[];
-    thousands: {
-        1: string[];
-        2: string[];
-        3: string[];
-        4: string[];
-        5: string[];
-        6: string[];
-        7: string[];
-        8: string[];
-        9: string[];
-        10: string[];
-    };
-    pluralize(n: any, forms: any): any;
-    convertWholePart(number: any): string;
-}
-export type SlavicOptions = {
-    /**
-     * Use feminine forms for numbers.
-     */
-    feminine?: boolean;
-};
-import SlavicLanguage from '../classes/slavic-language.js';

package/typings/languages/mr.d.ts

@@ -1,12 +0,0 @@
-/**
- * Convert a number to Marathi words
- *
- * @param {number|string|bigint} value - The number to convert
- * @param {Object} [options={}] - Conversion options
- * @returns {string} The Marathi word representation
- * @example
- * convertToWords(42) // 'बेचाळीस'
- * convertToWords(1000) // 'एक हजार'
- * convertToWords(100000) // 'एक लाख'
- */
-export default function convertToWords(value: number | string | bigint, options?: any): string;

package/typings/languages/ms.d.ts

@@ -1,37 +0,0 @@
-export default function convertToWords(value: any, options?: {}): string;
-/**
- * Malay (Bahasa Melayu) language converter.
- *
- * Conventions:
- * - Base-10 structure
- * - "Se-" prefix for singular units (seratus, seribu, sejuta, sebilion, setrilion)
- * - Space-separated components (no conjunction like "dan" for tens/ones)
- * - Grouping by thousands (ribu, juta, bilion, trilion)
- */
-export class Malay extends AbstractLanguage {
-    base: {
-        0: any[];
-        1: string[];
-        2: string[];
-        3: string[];
-        4: string[];
-        5: string[];
-        6: string[];
-        7: string[];
-        8: string[];
-        9: string[];
-    };
-    thousands: {
-        3: string;
-        6: string;
-        9: string;
-        12: string;
-    };
-    splitBy3(number: any): any[][];
-    spell(blocks: any): any[];
-    getHundreds(number: any): any[];
-    getTens(number: any): any;
-    join(wordBlocks: any): string;
-    convertWholePart(number: any): string;
-}
-import AbstractLanguage from '../classes/abstract-language.js';

package/typings/languages/nb.d.ts

@@ -1,27 +0,0 @@
-/**
- * Converts a number to Norwegian cardinal (written) form.
- *
- * @param {number|string|bigint} value The number to convert.
- * @param {Object} [options] Conversion options (see Norwegian class options).
- * @returns {string} The number expressed in Norwegian words.
- * @throws {TypeError} If value is NaN or invalid type.
- * @throws {Error} If value is an invalid number string.
- *
- * @example
- * convertToWords(42); // 'førti-to'
- * convertToWords('1.5'); // 'en komma fem'
- */
-export default function convertToWords(value: number | string | bigint, options?: any): string;
-/**
- * Norwegian language converter.
- *
- * GreedyScaleLanguage with inline Norwegian merge rules:
- * - Hyphenation for compound numbers (e.g., "tjueen")
- * - "og" (and) for hundreds combinations
- * - Comma separation for non-magnitude additions
- * - Implicit '1' before tens and magnitudes
- * - Space separators for large numbers
- */
-export class Norwegian extends GreedyScaleLanguage {
-}
-import GreedyScaleLanguage from '../classes/greedy-scale-language.js';

package/typings/languages/nl.d.ts

@@ -1,65 +0,0 @@
-/**
- * Converts a number to Dutch cardinal (written) form.
- *
- * @param {number|string|bigint} value The number to convert.
- * @param {Object} [options] Conversion options (see Dutch class options).
- * @param {boolean} [options.includeOptionalAnd=false] Include optional 'en' (and) separator.
- * @param {boolean} [options.noHundredPairs=false] Don't combine hundreds with tens/units.
- * @param {boolean} [options.accentOne=true] Use accented 'één' for standalone 1.
- * @returns {string} The number expressed in Dutch words.
- * @throws {TypeError} If value is NaN or invalid type.
- * @throws {Error} If value is an invalid number string.
- *
- * @example
- * convertToWords(1); // 'één' (default accent)
- * convertToWords(1, { accentOne: false }); // 'een'
- * convertToWords(21); // 'eenentwintig' (no accent in compounds)
- * convertToWords(42); // 'tweeenveertig'
- * convertToWords('1.5'); // 'één komma vijf'
- */
-export default function convertToWords(value: number | string | bigint, options?: {
-    includeOptionalAnd?: boolean;
-    noHundredPairs?: boolean;
-    accentOne?: boolean;
-}): string;
-/**
- * @typedef {Object} DutchOptions
- * @property {boolean} [includeOptionalAnd=false] Include optional "en" separator.
- * @property {boolean} [noHundredPairs=false] Disable comma before hundreds.
- * @property {boolean} [accentOne=true] Use accented "één" for one.
- */
-/**
- * Dutch language converter.
- *
- * Features:
- * - Optional "en" (and) separator for tens (includeOptionalAnd)
- * - Optional comma before hundreds (noHundredPairs)
- * - Compound word formation without hyphenation
- */
-export class Dutch extends GreedyScaleLanguage {
-    /**
-     * Initializes the Dutch converter with language-specific options.
-     *
-     * @param {DutchOptions} [options={}] Configuration options.
-     */
-    constructor({ includeOptionalAnd, noHundredPairs, accentOne }?: DutchOptions);
-    includeOptionalAnd: boolean;
-    noHundredPairs: boolean;
-    accentOne: boolean;
-    convertWholePart(value: any): string;
-}
-export type DutchOptions = {
-    /**
-     * Include optional "en" separator.
-     */
-    includeOptionalAnd?: boolean;
-    /**
-     * Disable comma before hundreds.
-     */
-    noHundredPairs?: boolean;
-    /**
-     * Use accented "één" for one.
-     */
-    accentOne?: boolean;
-};
-import GreedyScaleLanguage from '../classes/greedy-scale-language.js';

package/typings/languages/pa-Guru.d.ts

@@ -1 +0,0 @@
-export default function convertToWords(value: any, options?: {}): string;

package/typings/languages/pl.d.ts

@@ -1,116 +0,0 @@
-/**
- * Converts a number to Polish cardinal (written) form.
- *
- * @param {number|string|bigint} value The number to convert.
- * @param {SlavicOptions} [options={}] Configuration options.
- * @returns {string} The number expressed in Polish words.
- * @throws {TypeError} If value is NaN or invalid type.
- * @throws {Error} If value is an invalid number string.
- */
-export default function convertToWords(value: number | string | bigint, options?: SlavicOptions): string;
-/**
- * @typedef {Object} SlavicOptions
- * @property {boolean} [feminine=false] Use feminine forms for numbers.
- */
-/**
- * Polish language converter.
- *
- * Implements Polish number words using the Slavic language pattern:
- * - Polish number words (jeden, dwa, trzy, cztery, pięć...)
- * - Complex Slavic three-form pluralization (tysiąc/tysiące/tysięcy)
- * - Polish-specific declension patterns
- * - Distinctive Polish phonology and orthography
- *
- * Key Features:
- * - Three-form pluralization system shared across Slavic languages
- *   * Form 1 (singular): 1 (e.g., "tysiąc")
- *   * Form 2 (few): 2-4, 22-24, 32-34... excluding teens (e.g., "tysiące")
- *   * Form 3 (many): all other numbers (e.g., "tysięcy")
- * - Chunk-based decomposition (splits into groups of 3 digits: ones, thousands, millions, etc.)
- * - Large number handling via thousands[] array with indexed [singular, few, many] forms
- *
- * Features:
- * - Polish diacritical marks (ą, ć, ę, ł, ń, ś, ź, ż)
- * - Gender and case agreement
- * - Polish-specific number word endings
- *
- * Inherits from SlavicLanguage for complex pluralization algorithms.
- */
-export class Polish extends SlavicLanguage {
-    ones: {
-        1: string;
-        2: string;
-        3: string;
-        4: string;
-        5: string;
-        6: string;
-        7: string;
-        8: string;
-        9: string;
-    };
-    tens: {
-        0: string;
-        1: string;
-        2: string;
-        3: string;
-        4: string;
-        5: string;
-        6: string;
-        7: string;
-        8: string;
-        9: string;
-    };
-    twenties: {
-        2: string;
-        3: string;
-        4: string;
-        5: string;
-        6: string;
-        7: string;
-        8: string;
-        9: string;
-    };
-    hundreds: {
-        1: string;
-        2: string;
-        3: string;
-        4: string;
-        5: string;
-        6: string;
-        7: string;
-        8: string;
-        9: string;
-    };
-    thousands: {
-        1: string[];
-        2: string[];
-        3: string[];
-        4: string[];
-        5: string[];
-        6: string[];
-        7: string[];
-        8: string[];
-        9: string[];
-        10: string[];
-    };
-    /**
-     * Implements Polish-specific three-form pluralization rules.
-     *
-     * Polish three-form system:
-     * - Form 1 (singular): exactly n=1 (e.g., "tysiąc")
-     * - Form 2 (few): n ends in 2-4, excluding teens (22-24, 32-34...) (e.g., "tysiące")
-     * - Form 3 (many): all other numbers (e.g., "tysięcy")
-     *
-     * @param {bigint} n The number to classify.
-     * @param {Array<string>} forms Array of [singular, few, many] word forms.
-     * @returns {string} The appropriate form for the number n.
-     */
-    pluralize(n: bigint, forms: Array<string>): string;
-}
-export type SlavicOptions = {
-    /**
-     * Use feminine forms for numbers.
-     */
-    feminine?: boolean;
-};
-import SlavicLanguage from '../classes/slavic-language.js';

package/typings/languages/pt.d.ts

@@ -1,39 +0,0 @@
-/**
- * Converts a number to Portuguese cardinal (written) form.
- *
- * @param {number|string|bigint} value The number to convert.
- * @param {Object} [options] Conversion options (see Portuguese class options).
- * @returns {string} The number expressed in Portuguese words.
- * @throws {TypeError} If value is NaN or invalid type.
- * @throws {Error} If value is an invalid number string.
- *
- * @example
- * convertToWords(42); // 'quarenta e dois'
- * convertToWords('100.5'); // 'cem vírgula cinco'
- */
-export default function convertToWords(value: number | string | bigint, options?: any): string;
-/**
- * (European) Portuguese language converter.
- *
- * Features:
- * - Gender-aware hundreds (hundredos, duzentos, etc.)
- * - Million/Billion pluralization
- * - "e" (and) conjunction for number combinations
- * - Post-processing to normalize word flow
- */
-export class Portuguese extends GreedyScaleLanguage {
-    static POSTCLEAN_REGEX: RegExp;
-    hundreds: {
-        1: string;
-        2: string;
-        3: string;
-        4: string;
-        5: string;
-        6: string;
-        7: string;
-        8: string;
-        9: string;
-    };
-    finalizeWords(words: any): any;
-}
-import GreedyScaleLanguage from '../classes/greedy-scale-language.js';