n2words/src/en-GH.d.ts

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

/**
 * Ghanaian English language converter
 *
 * CLDR: en-GH | English as used in Ghana
 *
 * Exports:
 * - toCardinal(value)            - Cardinal numbers: 42 → "forty-two"
 * - toOrdinal(value)             - Ordinal numbers: 42 → "forty-second"
 * - toCurrency(value, options?)  - Currency: 42.50 → "forty-two cedis and fifty pesewas"
 *
 * Ghanaian 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: Ghanaian Cedi (GHS) - cedi/cedis, pesewa/pesewas
 */
export declare const cardinalMax: bigint;
export declare const ordinalMax: bigint;
export declare const currencyMax: bigint;
/**
 * Converts a numeric value to Ghanaian English words.
 * @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
 */
declare function toCardinal(value: number | string | bigint): string;
/**
 * Converts a numeric value to Ghanaian 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
 */
declare function toOrdinal(value: number | string | bigint): string;
export type CurrencyOptions = {
    /**
     * - Use "and" between cedis and pesewas
     */
    and?: boolean;
};
/**
 * @typedef {object} CurrencyOptions
 * @property {boolean} [and] - Use "and" between cedis and pesewas
 */
/** @type {Required<CurrencyOptions>} */
export declare const currencyDefaults: Required<CurrencyOptions>;
/**
 * Converts a numeric value to Ghanaian English currency words.
 * @param {number | string | bigint} value - The currency amount to convert
 * @param {CurrencyOptions} [options] - Optional configuration
 * @returns {string} The amount in Ghanaian English currency words
 * @throws {TypeError} If value is not a valid numeric type
 * @throws {Error} If value is not a valid number format
 */
declare function toCurrency(value: number | string | bigint, options?: CurrencyOptions): string;
export { toCardinal, toOrdinal, toCurrency };