/** * South African English language converter * * CLDR: en-ZA | English as used in South Africa * * Exports: * - toCardinal(value) - Cardinal numbers: 42 → "forty-two" * - toOrdinal(value) - Ordinal numbers: 42 → "forty-second" * - toCurrency(value, options?) - Currency: 42.50 → "forty-two rand and fifty cents" * * South African English conventions: * - Follows British English style * - "and" after hundreds: "one hundred and twenty-three" * - "and" before final segment: "one million and one" * - Hyphenated tens-ones: "twenty-one", "forty-two" * - Western numbering system (short scale: billion = 10^9) * - Currency: South African Rand (ZAR) - rand (singular/plural), cent/cents * * Note: "Rand" is invariable (same for singular and plural). */ export declare const cardinalMax: bigint; export declare const ordinalMax: bigint; export declare const currencyMax: bigint; /** * Converts a numeric value to South African 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 * @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' */ declare function toCardinal(value: number | string | bigint): string; /** * Converts a numeric value to South African 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 rand and cents (e.g., "one rand and fifty cents") */ and?: boolean; }; /** * @typedef {object} CurrencyOptions * @property {boolean} [and] - Use "and" between rand and cents (e.g., "one rand and fifty cents") */ /** @type {Required} */ export declare const currencyDefaults: Required; /** * Converts a numeric value to South African English currency words. * @param {number | string | bigint} value - The currency amount to convert * @param {CurrencyOptions} [options] - Optional configuration * @returns {string} The amount in South African 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 rand and fifty cents' * toCurrency(1) // 'one rand' * toCurrency(0.99) // 'ninety-nine cents' * toCurrency(0.01) // 'one cent' * toCurrency(42.50, { and: false }) // 'forty-two rand fifty cents' */ declare function toCurrency(value: number | string | bigint, options?: CurrencyOptions): string; export { toCardinal, toOrdinal, toCurrency };