n2words/src/ko-KR.d.ts

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

/**
 * Korean (South Korea) language converter
 *
 * CLDR: ko-KR | Korean as used in South Korea
 *
 * Key features:
 * - Myriad-based (만) grouping - 4 digits
 * - Implicit '일' (one) omission before scale words
 * - Space separation after 만+ scales
 * - Hangul numerals
 */
export declare const cardinalMax: bigint;
export declare const ordinalMax: bigint;
export declare const currencyMax: bigint;
/**
 * Converts a numeric value to Korean words.
 * @param {number | string | bigint} value - The numeric value to convert
 * @returns {string} The number in Korean words
 * @throws {TypeError} If value is not a valid numeric type
 * @throws {Error} If value is not a valid number format
 * @example
 * toCardinal(21)         // '이십일'
 * toCardinal(10000)      // '만'
 * toCardinal(1000000)    // '백만'
 */
declare function toCardinal(value: number | string | bigint): string;
/**
 * Converts a numeric value to Korean 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;
/**
 * Converts a numeric value to Korean currency words (Won).
 *
 * Korean Won has no subunit (jeon are historical).
 * Amounts are rounded to whole won.
 * @param {number | string | bigint} value - The currency amount to convert
 * @returns {string} The amount in Korean 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)     // '사십이원'
 * toCurrency(1000)   // '천원'
 * toCurrency(-5)     // '마이너스 오원'
 */
declare function toCurrency(value: number | string | bigint): string;
export { toCardinal, toOrdinal, toCurrency };