n2words/src/hr-HR.d.ts

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

/**
 * Croatian (Croatia) language converter
 *
 * CLDR: hr-HR | Croatian as used in Croatia
 *
 * Key features:
 * - Three-form pluralization (one/few/many)
 * - Gender by scale word: tisuća and the -arda forms (milijarda, bilijarda, ...)
 *   are feminine; the -un forms (milijun, bilijun, ...) are masculine
 * - Irregular hundreds (dvjesto, tristo, etc.)
 * - Long scale naming with -ard forms
 */
export declare const cardinalMax: bigint;
export declare const ordinalMax: bigint;
export declare const currencyMax: bigint;
export type CardinalOptions = {
    /**
     * - Grammatical gender
     */
    gender?: ('masculine' | 'feminine');
};
/**
 * @typedef {object} CardinalOptions
 * @property {('masculine'|'feminine')} [gender] - Grammatical gender
 */
/** @type {Required<CardinalOptions>} */
export declare const cardinalDefaults: Required<CardinalOptions>;
/** @type {{ gender: ReadonlyArray<Required<CardinalOptions>['gender']> }} */
export declare const cardinalValues: {
    gender: ReadonlyArray<Required<CardinalOptions>['gender']>;
};
/**
 * Converts a numeric value to Croatian words.
 * @param {number | string | bigint} value - The numeric value to convert
 * @param {CardinalOptions} [options] - Optional configuration
 * @returns {string} The number in Croatian words
 */
declare function toCardinal(value: number | string | bigint, options?: CardinalOptions): string;
/**
 * Converts a numeric value to Croatian ordinal words (masculine nominative).
 * @param {number | string | bigint} value - The numeric value to convert (must be a 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)    // 'prvi'
 * toOrdinal(2)    // 'drugi'
 * toOrdinal(21)   // 'dvadeset prvi'
 * toOrdinal(100)  // 'stoti'
 * toOrdinal(1000) // 'tisućiti'
 */
declare function toOrdinal(value: number | string | bigint): string;
/**
 * Converts a numeric value to Croatian currency words (Euro).
 * @param {number | string | bigint} value - The currency amount to convert
 * @returns {string} The amount in Croatian 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)     // 'četrdeset dva eura'
 * toCurrency(1)      // 'jedan euro'
 * toCurrency(1.50)   // 'jedan euro pedeset centi'
 * toCurrency(-5)     // 'minus pet eura'
 */
declare function toCurrency(value: number | string | bigint): string;
export { toCardinal, toOrdinal, toCurrency };