n2words/src/en-US.d.ts

Convert numbers to words in 70+ languages with zero dependencies. Supports BigInt, decimals, and browser/Node.js environments.

/**
 * American English language converter
 *
 * CLDR: en-US | English as used in the United States
 *
 * Exports:
 * - toCardinal(value, options?)  - Cardinal numbers: 42 → "forty-two"
 * - toOrdinal(value)             - Ordinal numbers: 42 → "forty-second"
 * - toCurrency(value, options?)  - Currency: 42.50 → "forty-two dollars and fifty cents"
 *
 * American English conventions:
 * - No "and" after hundreds: "one hundred twenty-three" (default)
 * - No "and" before final segment: "one million one" (default)
 * - Hyphenated tens-ones: "twenty-one", "forty-two"
 * - Western numbering system (short scale: billion = 10^9)
 * - Optional hundred-pairing: 1500 → "fifteen hundred" (colloquial)
 * - Optional "and" insertion: 101 → "one hundred and one" (informal)
 */
export declare const cardinalMax: bigint;
export declare const ordinalMax: bigint;
export declare const currencyMax: bigint;
export type CardinalOptions = {
    /**
     * - Use hundred-pairing for 1100-9999 (e.g., "fifteen hundred" instead of "one thousand five hundred")
     */
    hundredPairing?: boolean;
    /**
     * - Use "and" after hundreds and before final small numbers (e.g., "one hundred and one" instead of "one hundred one")
     */
    and?: boolean;
};
/**
 * @typedef {object} CardinalOptions
 * @property {boolean} [hundredPairing] - Use hundred-pairing for 1100-9999 (e.g., "fifteen hundred" instead of "one thousand five hundred")
 * @property {boolean} [and] - Use "and" after hundreds and before final small numbers (e.g., "one hundred and one" instead of "one hundred one")
 */
/** @type {Required<CardinalOptions>} */
export declare const cardinalDefaults: Required<CardinalOptions>;
/**
 * Converts a numeric value to American English words.
 *
 * 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
 * @param {CardinalOptions} [options] - Optional configuration
 * @returns {string} The number in American 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(101)                           // 'one hundred one'
 * toCardinal(101, { and: true })            // 'one hundred and one'
 * toCardinal(1500)                          // 'one thousand five hundred'
 * toCardinal(1500, { hundredPairing: true }) // 'fifteen hundred'
 */
declare function toCardinal(value: number | string | bigint, options?: CardinalOptions): string;
/**
 * Converts a numeric value to American 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'
 * toOrdinal(3)    // 'third'
 * toOrdinal(21)   // 'twenty-first'
 * toOrdinal(42)   // 'forty-second'
 * toOrdinal(100)  // 'one hundredth'
 * toOrdinal(101)  // 'one hundred first'
 * toOrdinal(1000) // 'one thousandth'
 */
declare function toOrdinal(value: number | string | bigint): string;
export type CurrencyOptions = {
    /**
     * - Use "and" between dollars and cents (e.g., "one dollar and fifty cents")
     */
    and?: boolean;
};
/**
 * @typedef {object} CurrencyOptions
 * @property {boolean} [and] - Use "and" between dollars and cents (e.g., "one dollar and fifty cents")
 */
/** @type {Required<CurrencyOptions>} */
export declare const currencyDefaults: Required<CurrencyOptions>;
/**
 * Converts a numeric value to American English currency words.
 * @param {number | string | bigint} value - The currency amount to convert
 * @param {CurrencyOptions} [options] - Optional configuration
 * @returns {string} The amount in American 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 dollars and fifty cents'
 * toCurrency(1)                        // 'one dollar'
 * toCurrency(0.99)                     // 'ninety-nine cents'
 * toCurrency(42.50, { and: false })    // 'forty-two dollars fifty cents'
 */
declare function toCurrency(value: number | string | bigint, options?: CurrencyOptions): string;
export { toCardinal, toOrdinal, toCurrency };