n2words
Version:
Convert numbers to words in 70+ languages with zero dependencies. Supports BigInt, decimals, and browser/Node.js environments.
83 lines (82 loc) • 3.44 kB
TypeScript
/**
* Russian (Russia) language converter
*
* CLDR: ru-RU | Russian as used in Russia
*
* Key features:
* - Three-form pluralization (one/few/many)
* - Gender: thousands are feminine, millions+ are masculine
* - Irregular hundreds (двести, триста, etc.)
* - Long scale naming
*/
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 Russian words.
* @param {number | string | bigint} value - The numeric value to convert
* @param {CardinalOptions} [options] - Optional configuration
* @returns {string} The number in Russian words
*/
declare function toCardinal(value: number | string | bigint, options?: CardinalOptions): string;
/**
* Converts a numeric value to Russian 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 (e.g., "первый", "сорок второй")
* @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(21) // 'двадцать первый'
* toOrdinal(42) // 'сорок второй'
* toOrdinal(100) // 'сотый'
* toOrdinal(101) // 'сто первый'
* toOrdinal(1000) // 'тысячный'
*/
declare function toOrdinal(value: number | string | bigint): string;
export type CurrencyOptions = {
/**
* - Use "и" between rubles and kopecks
*/
and?: boolean;
};
/**
* @typedef {object} CurrencyOptions
* @property {boolean} [and] - Use "и" between rubles and kopecks
*/
/** @type {Required<CurrencyOptions>} */
export declare const currencyDefaults: Required<CurrencyOptions>;
/**
* Converts a numeric value to Russian currency words (Russian Ruble).
* @param {number | string | bigint} value - The currency amount to convert
* @param {CurrencyOptions} [options] - Optional configuration
* @returns {string} The amount in Russian 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.99) // 'девяносто девять копеек'
* toCurrency(0.01) // 'одна копейка'
* toCurrency(42.50, { and: false }) // 'сорок два рубля пятьдесят копеек'
*/
declare function toCurrency(value: number | string | bigint, options?: CurrencyOptions): string;
export { toCardinal, toOrdinal, toCurrency };