n2words/src/pa-IN.d.ts

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

/**
 * Punjabi (India) language converter
 *
 * CLDR: pa-IN | Punjabi (Gurmukhi) as used in India
 *
 * Key features:
 * - Indian numbering system (ਹਜ਼ਾਰ, ਲੱਖ, ਕਰੋੜ)
 * - Gurmukhi script
 * - 3-2-2 grouping pattern (last 3 digits, then groups of 2)
 * - Complete word forms for 0-99
 */
export declare const cardinalMax: bigint;
export declare const ordinalMax: bigint;
export declare const currencyMax: bigint;
/**
 * Converts a numeric value to Punjabi words.
 * @param {number | string | bigint} value - The numeric value to convert
 * @returns {string} The number in Punjabi words
 */
declare function toCardinal(value: number | string | bigint): string;
/**
 * Converts a numeric value to Punjabi 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(3)    // 'ਤੀਜਾ'
 * toOrdinal(10)   // 'ਦੱਸਵਾਂ'
 */
declare function toOrdinal(value: number | string | bigint): string;
/**
 * Converts a numeric value to Punjabi currency words (Indian Rupee).
 * @param {number | string | bigint} value - The currency amount to convert
 * @returns {string} The amount in Punjabi 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)  // 'ਬਿਆਲੀ ਰੁਪਏ ਪੰਜਾਹ ਪੈਸੇ'
 * toCurrency(1)      // 'ਇੱਕ ਰੁਪਇਆ'
 * toCurrency(0.01)   // 'ਇੱਕ ਪੈਸਾ'
 */
declare function toCurrency(value: number | string | bigint): string;
export { toCardinal, toOrdinal, toCurrency };