n2words 1.24.0 → 2.0.0

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';

package/typings/languages/ro.d.ts

@@ -1,229 +0,0 @@
-/**
- * Converts a number to Romanian 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 Romanian 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} RomanianOptions
- * @property {boolean} [feminine=false] Use feminine forms for numbers.
- */
-/**
- * Romanian language converter.
- *
- * Converts numbers to Romanian words with full grammatical support:
- * - Gender agreement (masculine/feminine forms)
- * - Complex pluralization (singular/plural forms)
- * - "De" preposition insertion for groups >= 20
- * - Special feminine handling for thousands
- * - Proper case and agreement patterns
- *
- * Key Features:
- * - Gender-aware number forms (unu/una, doi/două, doisprezece/douăsprezece)
- * - Group-based algorithm:
- *   1. Split number into groups of 3 digits
- *   2. Convert each group using gender rules and special forms
- *   3. Insert "de" preposition for groups >= 20 (e.g., "douăzeci de mii")
- *   4. Append magnitude word with proper singular/plural form (mie/mii, milion/milioane)
- *   5. Join with spaces
- * - Special feminine units for thousands group
- * - Automatic "de" insertion rules (nouăsprezece mii vs douăzeci de mii)
- * - Proper singular/plural forms (mie/mii, milion/milioane)
- * - Support for very large numbers (up to decillions)
- *
- * Features:
- * - Feminine units for thousands group
- * - Support for very large numbers (up to decillions)
- */
-export class Romanian extends AbstractLanguage {
-    /**
-     * Initializes the Romanian converter with language-specific options.
-     *
-     * @param {RomanianOptions} [options={}] Configuration options.
-     */
-    constructor({ feminine }?: RomanianOptions);
-    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;
-    };
-    tensMasculine: {
-        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;
-    };
-    /**
-     * Romanian big units.
-     * For each power group we keep: singular, plural, feminineUnits?, needsDe?
-     * - 10^3: mie/mii (feminine units in chunk; "de" for chunk >= 20)
-     * - 10^6: milion/milioane ("de" for chunk >= 20)
-     * - 10^9: miliard/miliarde ("de" for chunk >= 20)
-     */
-    thousands: {
-        1: {
-            singular: string;
-            plural: string;
-            feminine: boolean;
-            needsDe: boolean;
-        };
-        2: {
-            singular: string;
-            plural: string;
-            feminine: boolean;
-            needsDe: boolean;
-        };
-        3: {
-            singular: string;
-            plural: string;
-            feminine: boolean;
-            needsDe: boolean;
-        };
-        4: {
-            singular: string;
-            plural: string;
-            feminine: boolean;
-            needsDe: boolean;
-        };
-        5: {
-            singular: string;
-            plural: string;
-            feminine: boolean;
-            needsDe: boolean;
-        };
-        6: {
-            singular: string;
-            plural: string;
-            feminine: boolean;
-            needsDe: boolean;
-        };
-        7: {
-            singular: string;
-            plural: string;
-            feminine: boolean;
-            needsDe: boolean;
-        };
-        8: {
-            singular: string;
-            plural: string;
-            feminine: boolean;
-            needsDe: boolean;
-        };
-        9: {
-            singular: string;
-            plural: string;
-            feminine: boolean;
-            needsDe: boolean;
-        };
-        10: {
-            singular: string;
-            plural: string;
-            feminine: boolean;
-            needsDe: boolean;
-        };
-    };
-    feminine: boolean;
-    /**
-     * Split numeric string into BigInt groups of size x from left to right.
-     * @param {string} n - The numeric string to split
-     * @param {number} x - The size of each group
-     * @returns {bigint[]} Array of BigInt groups
-     */
-    splitByX(n: string, x: number): bigint[];
-    getDigits(value: any): bigint[];
-    /**
-     * Romanian pluralization & "de" rule for big units.
-     * - 1 → singular with article ("o mie", "un milion", "un miliard", …)
-     * - otherwise → spell chunk + (optional "de") + plural
-     * "de" is inserted when chunk >= 20 (e.g., "douăzeci de mii/milioane/miliarde").
-     * @param {bigint} chunk - The chunk value
-     * @param {object} form - The form object with singular, plural, feminine, needsDe properties
-     * @returns {string} The pluralized form
-     */
-    romanianPluralize(chunk: bigint, form: object): string;
-    spellUnder100(n: any, feminineUnits?: boolean): any;
-    spellUnder1000(n: any, feminineUnits?: boolean): any;
-    /**
-     * Override decimalDigitsToWords to use masculine forms for decimal places
-     * @param {string} decimal Decimal string to convert
-     * @returns {string} Value in written format
-     */
-    decimalDigitsToWords(decimal: string): string;
-    /**
-     * Convert number to cardinal form using masculine units
-     * @param {bigint} number Number to convert
-     * @returns {string} Value in written format
-     */
-    toCardinalWithMasculine(number: bigint): string;
-    convertWholePart(number: any): string;
-}
-export type RomanianOptions = {
-    /**
-     * Use feminine forms for numbers.
-     */
-    feminine?: boolean;
-};
-import AbstractLanguage from '../classes/abstract-language.js';

package/typings/languages/ru.d.ts

@@ -1,108 +0,0 @@
-/**
- * Converts a number to Russian cardinal (written) form.
- *
- * @param {number|string|bigint} value The number to convert.
- * @param {SlavicOptions} [options={}] Configuration options.
- * @returns {string} The number expressed in Russian 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.
- */
-/**
- * Russian language converter.
- *
- * Converts numbers to Russian words with full grammatical support:
- * - Gender agreement (masculine/feminine forms)
- * - Complex pluralization rules (one/few/many forms)
- * - Declension patterns for thousands, millions, billions, etc.
- * - Proper case endings for number words
- *
- * Features:
- * - Gender-aware forms (один/одна, два/две)
- * - Three-form pluralization (тысяча/тысячи/тысяч)
- * - Support for very large numbers (up to nonillions)
- * - Proper spacing and conjunction rules
- *
- * This class extends SlavicLanguage, which provides the conversion algorithm
- * shared by Czech, Polish, Ukrainian, Serbian, Croatian, Hebrew, Lithuanian, Latvian.
- */
-export class Russian 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: {
-        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[];
-    };
-}
-export type SlavicOptions = {
-    /**
-     * Use feminine forms for numbers.
-     */
-    feminine?: boolean;
-};
-import SlavicLanguage from '../classes/slavic-language.js';

package/typings/languages/sr-Latn.d.ts

@@ -1,98 +0,0 @@
-/**
- * Converts a number to Serbian 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 Serbian 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.
- */
-/**
- * Serbian language converter.
- *
- * Implements Serbian number words using the Slavic language pattern:
- * - Serbian number words (jedan/jedna, dva/dve, tri, četiri...)
- * - Gender-aware forms (masculine/feminine)
- * - Slavic three-form pluralization (hiljada/hiljade/hiljada)
- * - Latin script representation
- *
- * Key Features:
- * - Three-form pluralization system shared across Slavic languages
- *   * Form 1 (singular): 1 (e.g., "hiljada")
- *   * Form 2 (few): 2-4, 22-24, 32-34... excluding teens (e.g., "hiljade")
- *   * Form 3 (many): all other numbers (e.g., "hiljada")
- * - Chunk-based decomposition (splits into groups of 3 digits: ones, thousands, millions, etc.)
- * - Large number handling via SCALE[] array with indexed [singular, few, many] forms
- * - Gender-specific number forms for 1 and 2 (masculine/feminine dual forms)
- *
- * Features:
- * - Dual gender forms for 1 and 2 (jedan/jedna, dva/dve)
- * - Similar structure to Croatian with different orthography
- * - Latin script (Serbian can use both Latin and Cyrillic)
- *
- * Inherits from SlavicLanguage for complex pluralization algorithms.
- */
-export class Serbian 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;
-    };
-    SCALE: (string | boolean)[][];
-    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/sv.d.ts

@@ -1,30 +0,0 @@
-/**
- * Converts a number to Swedish cardinal (written) form.
- *
- * @param {number|string|bigint} value The number to convert.
- * @param {Object} [options] Conversion options (see Swedish class options).
- * @returns {string} The number expressed in Swedish words.
- * @throws {TypeError} If value is NaN or invalid type.
- * @throws {Error} If value is an invalid number string.
- *
- * @example
- * convertToWords(42); // 'fyrtio-två'
- * convertToWords('1.5'); // 'ett komma fem'
- */
-export default function convertToWords(value: number | string | bigint, options?: any): string;
-/**
- * Swedish language converter.
- *
- * Converts numbers to Swedish words, supporting:
- * - Negative numbers (prepended with "minus")
- * - Decimal numbers (word "komma" between whole and fractional parts)
- * - Numbers up to quadrillions
- *
- * Merge rules:
- * - Hyphenated for compound tens (e.g., "tjugo-tre")
- * - "och" (and) after hundreds (e.g., "hundra och ett")
- * - Space-separated for larger composites (e.g., "en miljon")
- */
-export class Swedish extends GreedyScaleLanguage {
-}
-import GreedyScaleLanguage from '../classes/greedy-scale-language.js';

package/typings/languages/sw.d.ts

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

package/typings/languages/ta.d.ts

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

package/typings/languages/te.d.ts

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

package/typings/languages/th.d.ts

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

package/typings/languages/tr.d.ts

@@ -1,46 +0,0 @@
-/**
- * Converts a number to Turkish cardinal (written) form.
- *
- * @param {number|string|bigint} value The number to convert.
- * @param {Object} [options] Conversion options (see TR class).
- * @param {boolean} [options.dropSpaces=false] Remove spaces between words if true.
- * @returns {string} The number expressed in Turkish words.
- * @throws {TypeError} If value is NaN or invalid type.
- * @throws {Error} If value is an invalid number string.
- *
- * @example
- * convertToWords(42, { lang: 'tr' }); // 'kırk iki'
- * convertToWords(42, { lang: 'tr', dropSpaces: true }); // 'kırkiki'
- */
-export default function convertToWords(value: number | string | bigint, options?: {
-    dropSpaces?: boolean;
-}): string;
-/**
- * @typedef {Object} TurkishOptions
- * @property {boolean} [dropSpaces=false] Remove spaces between words if true.
- */
-/**
- * Turkish language converter.
- *
- * Inherits from TurkicLanguage shared patterns:
- * - Space-separated number combinations
- * - Omits '1' before hundreds and thousands
- * - Optional word spacing (dropSpaces option)
- * - Supports 'ş', 'ç', 'ğ', 'ı', 'ü', 'ö' characters
- */
-export class Turkish extends TurkicLanguage {
-    /**
-     * Initializes the Turkish converter with language-specific options.
-     *
-     * @param {TurkishOptions} [options={}] Configuration options.
-     */
-    constructor({ dropSpaces }?: TurkishOptions);
-    dropSpaces: boolean;
-}
-export type TurkishOptions = {
-    /**
-     * Remove spaces between words if true.
-     */
-    dropSpaces?: boolean;
-};
-import TurkicLanguage from '../classes/turkic-language.js';