/** * Persian (Iran) language converter * * CLDR: fa-IR | Persian as used in Iran * * Key features: * - "و" (and) conjunction for compound numbers * - Omit "یک" (one) before thousand * - Pre-composed hundreds (دویست, سيصد, etc.) */ export declare const cardinalMax: null; export declare const ordinalMax: null; export declare const currencyMax: null; /** * Converts a numeric value to Persian words. * @param {number | string | bigint} value - The numeric value to convert * @returns {string} The number in Persian words */ declare function toCardinal(value: number | string | bigint): string; /** * Converts a numeric value to Persian ordinal words. * @param {number | string | bigint} value - The numeric value to convert (positive integer) * @returns {string} The number as ordinal words * @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) // 'اول' * toOrdinal(2) // 'دوم' * toOrdinal(10) // 'دهم' */ declare function toOrdinal(value: number | string | bigint): string; export type CurrencyOptions = { /** * - ISO 4217 currency code to name the amount in */ currency?: import('./utils/currency-vocab.js').FaCurrency; }; /** * @typedef {object} CurrencyOptions * @property {import('./utils/currency-vocab.js').FaCurrency} [currency] - ISO 4217 currency code to name the amount in */ /** @type {Required} */ export declare const currencyDefaults: Required; /** @type {{ currency: ReadonlyArray['currency']> }} */ export declare const currencyValues: { currency: ReadonlyArray['currency']>; }; /** * Converts a numeric value to Persian currency words (Rial). * * Iranian Rial has no everyday minor unit (historically dinar was 1/100 * rial, but not used today) — a fractional amount throws RangeError * rather than being silently dropped. * @param {number | string | bigint} value - The currency amount to convert * @param {CurrencyOptions} [options] - Optional configuration * @returns {string} The amount in Persian currency words * @throws {TypeError} If value is not a valid numeric type * @throws {RangeError} If value is not a valid number format, or has a fractional part * @example * toCurrency(42) // 'چهل و دو ریال' * toCurrency(1000) // 'هزار ریال' * toCurrency(-5) // 'منفى پنج ریال' */ declare function toCurrency(value: number | string | bigint, options?: CurrencyOptions): string; export { toCardinal, toOrdinal, toCurrency };