n2words 1.24.0 → 2.0.0

package/typings/languages/uk.d.ts

@@ -1,117 +0,0 @@
-/**
- * Converts a number to Ukrainian 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 Ukrainian 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.
- */
-/**
- * Ukrainian language converter.
- *
- * Implements Ukrainian number words using the Slavic language pattern:
- * - Ukrainian number words (один/одна, два/дві, три, чотири...)
- * - Gender-aware forms (masculine/feminine)
- * - Slavic three-form pluralization (тисяча/тисячі/тисяч)
- * - Ukrainian orthography and phonology
- *
- * Key Features:
- * - Three-form pluralization system shared across Slavic languages
- *   * Form 1 (singular): 1 (e.g., "тисяча")
- *   * Form 2 (few): 2-4, 22-24, 32-34... excluding teens (e.g., "тисячі")
- *   * Form 3 (many): all other numbers (e.g., "тисяч")
- * - 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:
- * - Ukrainian-specific letters (і, ї, ґ, є)
- * - Apostrophe usage (п'ять, дев'ять)
- * - Close structural similarity to Russian with distinct vocabulary
- *
- * Inherits from SlavicLanguage for complex pluralization algorithms.
- */
-export class Ukrainian 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/ur.d.ts

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

package/typings/languages/vi.d.ts

@@ -1,116 +0,0 @@
-/**
- * Converts a number to Vietnamese cardinal (written) form.
- *
- * @param {number|string|bigint} value The number to convert.
- * @param {Object} [options={}] Configuration options.
- * @returns {string} The number expressed in Vietnamese 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;
-/**
- * Vietnamese language converter.
- *
- * Converts numbers to Vietnamese words following Vietnamese number naming:
- * - Base-10 grouping system (trăm = hundred, nghìn = thousand, triệu = million, tỷ = billion)
- * - Special pronunciation rules for 5 and 15 (lăm instead of năm)
- * - Special pronunciation for final 1 in compound numbers (mốt instead of một)
- * - "Lẻ" (odd/extra) used when tens place is zero but units exist
- *
- * Key Features:
- * - Base number mapping for 0-19 (with special forms)
- * - Tens mapping (hai mươi, ba mươi, etc.)
- * - Group-based algorithm:
- *   1. Split number into groups of 3 digits
- *   2. For each group, build words using special pronunciation rules:
- *      - "Mốt" instead of "một" for final 1 (e.g., 21 → hai mươi mốt)
- *      - "Lăm" instead of "năm" for 15 and mid-group 5 (e.g., 15, 105)
- *      - "Lẻ" prefix when tens=0 but units>0 (e.g., 101 → một trăm lẻ một)
- *   3. Append magnitude word (nghìn/triệu/tỷ)
- *   4. Join all groups with spaces
- * - Support for large numbers up to vigintillions
- *
- * Features:
- * - Natural Vietnamese number flow
- * - Proper handling of special cases (mốt, lăm)
- * - Contextual pronunciation adjustments
- */
-export class Vietnamese extends AbstractLanguage {
-    base: {
-        0: string;
-        1: string;
-        2: string;
-        3: string;
-        4: string;
-        5: string;
-        6: string;
-        7: string;
-        8: string;
-        9: string;
-        10: string;
-        11: string;
-        12: string;
-        13: string;
-        14: string;
-        15: string;
-        16: string;
-        17: string;
-        18: string;
-        19: string;
-    };
-    tens: {
-        20: string;
-        30: string;
-        40: string;
-        50: string;
-        60: string;
-        70: string;
-        80: string;
-        90: string;
-    };
-    thousands: {
-        1: string;
-        2: string;
-        3: string;
-        4: string;
-        5: string;
-        6: string;
-        7: string;
-        8: string;
-        9: string;
-        10: string;
-        11: string;
-        12: string;
-        13: string;
-        14: string;
-        15: string;
-        16: string;
-        17: string;
-        18: string;
-        19: string;
-        20: string;
-    };
-    /**
-     * Convert numbers less than 100 to Vietnamese words.
-     *
-     * @param {number} number The number to convert (0-99).
-     * @returns {string} The Vietnamese representation.
-     */
-    convertLess100(number: number): string;
-    /**
-     * Convert numbers less than 1000 to Vietnamese words.
-     *
-     * @param {number} number The number to convert (0-999).
-     * @returns {string} The Vietnamese representation.
-     */
-    convertLess1000(number: number): string;
-    /**
-     * Convert numbers greater than 1000 to Vietnamese words.
-     *
-     * @param {bigint} number The number to convert (>= 1000).
-     * @returns {string} The Vietnamese representation.
-     */
-    convertMore1000(number: bigint): string;
-    convertWholePart(number: any): any;
-}
-import AbstractLanguage from '../classes/abstract-language.js';

package/typings/languages/zh-Hans.d.ts

@@ -1,57 +0,0 @@
-/**
- * Converts a number to Chinese cardinal (written) form.
- *
- * @param {number|string|bigint} value The number to convert.
- * @param {ChineseOptions} [options] Conversion options.
- * @returns {string} The number expressed in Chinese words.
- * @throws {TypeError} If value is NaN or invalid type.
- * @throws {Error} If value is an invalid number string.
- *
- * @example
- * convertToWords(42); // '肆拾贰' (formal style)
- * convertToWords(42, { formal: false }); // '四十二' (common style)
- */
-export default function convertToWords(value: number | string | bigint, options?: ChineseOptions): string;
-/**
- * @typedef {Object} ChineseOptions
- * @property {boolean} [formal=true] Use formal/financial numerals (壹贰叁) vs. common numerals (一二三).
- */
-/**
- * Chinese language converter.
- *
- * Features:
- * - Concatenated number-word format (no spaces)
- * - Implicit zero insertion for positional values
- * - Decimal digits pronounced individually
- * - Supports both formal (financial) and common (everyday) styles
- */
-export class Chinese extends GreedyScaleLanguage {
-    /**
-     * Initializes the Chinese converter.
-     *
-     * @param {ChineseOptions} [options={}] Configuration options.
-     */
-    constructor({ formal }?: ChineseOptions);
-    formal: boolean;
-    /**
-     * Get the number of digits in a number.
-     *
-     * @param {bigint|number} number_ The number to count digits for.
-     * @returns {number} The count of digits.
-     */
-    digit(number_: bigint | number): number;
-    /**
-     * Count the number of zeros in a number.
-     *
-     * @param {bigint|number} number_ The number to count zeros in.
-     * @returns {number} The count of zero digits.
-     */
-    zeroDigit(number_: bigint | number): number;
-}
-export type ChineseOptions = {
-    /**
-     * Use formal/financial numerals (壹贰叁) vs. common numerals (一二三).
-     */
-    formal?: boolean;
-};
-import GreedyScaleLanguage from '../classes/greedy-scale-language.js';

package/typings/n2words.d.ts

@@ -1,177 +0,0 @@
-/**
- * Convert a numeric value to its cardinal (written) form in the requested language.
- *
- * This is the main entry point. The library dispatches synchronously to the appropriate
- * per-language converter based on the `lang` option. For browser builds, language converters
- * are statically imported so bundlers (webpack/rollup) can include them in output; Node.js
- * maintains identical behavior via the same static imports.
- *
- * @param {number|string|bigint} value The number to convert. Accepts:
- *   - `number` (integer or floating-point),
- *   - `string` (numeric string, possibly with decimal point),
- *   - `bigint` for very large integers.
- *   Decimal numbers as strings preserve precision that `number` type cannot.
- * @param {N2WordsOptions} [options={}] Optional configuration object.
- *
- * @returns {string} A human-readable cardinal representation of `value` in the
- *   requested language.
- *
- * @throws {TypeError} If `options` is provided but is not an object.
- * @throws {Error} If the requested language is unsupported (no match after fallback).
- *
- * @example
- * // Basic usage
- * convertToWords(1, { lang: 'en' }) // => 'one'
- * convertToWords('45.67', { lang: 'en' }) // => 'forty-five point six seven'
- * convertToWords(123n, { lang: 'fr' }) // => 'cent vingt-trois'
- *
- * @example
- * // Language-specific options (see individual language implementations)
- * convertToWords(1, { lang: 'zh-Hans', formal: true }) // Chinese formal style
- * convertToWords(1, { lang: 'cs', feminine: true }) // Czech feminine form
- */
-export default function _default(value: number | string | bigint, options?: N2WordsOptions): string;
-export type LanguageCode = "ar" | "az" | "bn" | "cs" | "de" | "da" | "el" | "en" | "es" | "fa" | "fr" | "fr-BE" | "gu" | "he" | "hi" | "hr" | "hu" | "id" | "it" | "ja" | "kn" | "ko" | "lt" | "lv" | "mr" | "ms" | "nl" | "nb" | "pa-Guru" | "pl" | "pt" | "ro" | "ru" | "sr-Latn" | "sv" | "sw" | "ta" | "te" | "th" | "fil" | "tr" | "uk" | "ur" | "vi" | "zh-Hans";
-export type ArabicOptions = {
-    /**
-     * - Word for negative numbers (minus).
-     */
-    negativeWord?: string;
-    /**
-     * - Use feminine forms for numbers.
-     */
-    feminine?: boolean;
-};
-export type ChineseOptions = {
-    /**
-     * - Use formal/financial numerals (壹贰叁) vs. common numerals (一二三).
-     */
-    formal?: boolean;
-};
-export type HebrewOptions = {
-    /**
-     * - Conjunction character (typically 'ו' for and).
-     */
-    and?: string;
-    /**
-     * - Use biblical scale words instead of modern ones.
-     */
-    biblical?: boolean;
-    /**
-     * - Use feminine forms for numbers.
-     */
-    feminine?: boolean;
-};
-export type SpanishOptions = {
-    /**
-     * - Masculine 'o' or feminine 'a' ending.
-     */
-    genderStem?: ("o" | "a" | string);
-};
-export type DutchOptions = {
-    /**
-     * - Include optional "en" separator.
-     */
-    includeOptionalAnd?: boolean;
-    /**
-     * - Disable comma before hundreds.
-     */
-    noHundredPairs?: boolean;
-    /**
-     * - Use accented "één" for one.
-     */
-    accentOne?: boolean;
-};
-export type FrenchOptions = {
-    /**
-     * - Use hyphens (true) instead of spaces (false) in compounds.
-     */
-    withHyphenSeparator?: boolean;
-};
-export type TurkishOptions = {
-    /**
-     * - Remove spaces between words if true.
-     */
-    dropSpaces?: boolean;
-};
-export type RomanianOptions = {
-    /**
-     * - Use feminine forms for numbers.
-     */
-    feminine?: boolean;
-};
-export type DanishOptions = {
-    /**
-     * - Enable ordinal number conversion.
-     */
-    ordFlag?: boolean;
-};
-export type SlavicOptions = {
-    /**
-     * - Use feminine forms for numbers.
-     */
-    feminine?: boolean;
-};
-/**
- * Configuration object for number-to-words conversion with comprehensive language support.
- */
-export type N2WordsOptions = {
-    /**
-     * - Target language code with full autocomplete support.
-     * Supports many languages with regional variants (e.g., 'fr-BE').
-     * Falls back progressively from most-specific to least-specific (e.g., 'fr-BE' -> 'fr').
-     * Throws an error if no match is found after fallback attempts.
-     */
-    lang?: LanguageCode;
-    /**
-     * - (Arabic only) Word for negative numbers.
-     */
-    negativeWord?: string;
-    /**
-     * - (Arabic, Hebrew, Romanian, Slavic languages) Use feminine forms.
-     */
-    feminine?: boolean;
-    /**
-     * - (Chinese only) Use formal/financial numerals.
-     */
-    formal?: boolean;
-    /**
-     * - (Hebrew only) Conjunction character.
-     */
-    and?: string;
-    /**
-     * - (Hebrew only) Use biblical scale words.
-     */
-    biblical?: boolean;
-    /**
-     * - (Spanish only) Gender ending.
-     */
-    genderStem?: ("o" | "a" | string);
-    /**
-     * - (Dutch only) Include optional "en".
-     */
-    includeOptionalAnd?: boolean;
-    /**
-     * - (Dutch only) Disable comma before hundreds.
-     */
-    noHundredPairs?: boolean;
-    /**
-     * - (Dutch only) Use accented "één".
-     */
-    accentOne?: boolean;
-    /**
-     * - (French, Belgian French) Use hyphens.
-     */
-    withHyphenSeparator?: boolean;
-    /**
-     * - (Turkish, Azerbaijani) Remove spaces.
-     */
-    dropSpaces?: boolean;
-    /**
-     * - (Danish only) Enable ordinal conversion.
-     *
-     * Language-specific options are automatically validated and forwarded to converters.
-     * See individual language implementations for detailed option descriptions.
-     */
-    ordFlag?: boolean;
-};