n2words 5.1.1 → 5.1.2

package/src/ru-RU.d.ts

@@ -1,33 +1,32 @@
-export const cardinalMax: bigint;
-export const ordinalMax: bigint;
-export const currencyMax: bigint;
 /**
- * @typedef {object} CardinalOptions
- * @property {('masculine'|'feminine')} [gender] - Grammatical gender
+ * 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
  */
-/** @type {Required<CardinalOptions>} */
-export const cardinalDefaults: Required<CardinalOptions>;
-/** @type {{ gender: ReadonlyArray<Required<CardinalOptions>['gender']> }} */
-export const cardinalValues: {
-    gender: ReadonlyArray<Required<CardinalOptions>["gender"]>;
-};
-/**
- * @typedef {object} CurrencyOptions
- * @property {boolean} [and] - Use "и" between rubles and kopecks
- */
-/** @type {Required<CurrencyOptions>} */
-export const currencyDefaults: Required<CurrencyOptions>;
+export declare const cardinalMax: bigint;
+export declare const ordinalMax: bigint;
+export declare const currencyMax: bigint;
 export type CardinalOptions = {
     /**
      * - Grammatical gender
      */
-    gender?: "feminine" | "masculine" | undefined;
+    gender?: ('masculine' | 'feminine');
 };
-export type CurrencyOptions = {
-    /**
-     * - Use "и" between rubles and kopecks
-     */
-    and?: boolean | undefined;
+/**
+ * @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.
@@ -35,7 +34,7 @@ export type CurrencyOptions = {
  * @param {CardinalOptions} [options] - Optional configuration
  * @returns {string} The number in Russian words
  */
-export function toCardinal(value: number | string | bigint, options?: CardinalOptions): string;
+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)
@@ -52,7 +51,19 @@ export function toCardinal(value: number | string | bigint, options?: CardinalOp
  * toOrdinal(101)  // 'сто первый'
  * toOrdinal(1000) // 'тысячный'
  */
-export function toOrdinal(value: number | string | bigint): string;
+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
@@ -67,4 +78,5 @@ export function toOrdinal(value: number | string | bigint): string;
  * toCurrency(0.01)                     // 'одна копейка'
  * toCurrency(42.50, { and: false })    // 'сорок два рубля пятьдесят копеек'
  */
-export function toCurrency(value: number | string | bigint, options?: CurrencyOptions): string;
+declare function toCurrency(value: number | string | bigint, options?: CurrencyOptions): string;
+export { toCardinal, toOrdinal, toCurrency };

package/src/sr-Cyrl-RS.d.ts

@@ -1,33 +1,34 @@
-export const cardinalMax: bigint;
-export const ordinalMax: bigint;
-export const currencyMax: bigint;
 /**
- * @typedef {object} CardinalOptions
- * @property {('masculine'|'feminine')} [gender] - Grammatical gender
+ * Serbian (Serbia, Cyrillic script) language converter
+ *
+ * CLDR: sr-Cyrl-RS | Serbian as used in Serbia (Cyrillic script)
+ *
+ * Key features:
+ * - Three-form pluralization (one/few/many)
+ * - Gender by scale word: the -arda forms (hiljada, milijarda, bilijarda, ...)
+ *   are feminine; the -ion forms (milion, bilion, ...) are masculine
+ * - Irregular hundreds
+ * - Long scale naming with -ard forms
+ * - Cyrillic script
  */
-/** @type {Required<CardinalOptions>} */
-export const cardinalDefaults: Required<CardinalOptions>;
-/** @type {{ gender: ReadonlyArray<Required<CardinalOptions>['gender']> }} */
-export const cardinalValues: {
-    gender: ReadonlyArray<Required<CardinalOptions>["gender"]>;
-};
-/**
- * @typedef {object} CurrencyOptions
- * @property {boolean} [and] - Use "и" between dinars and para
- */
-/** @type {Required<CurrencyOptions>} */
-export const currencyDefaults: Required<CurrencyOptions>;
+export declare const cardinalMax: bigint;
+export declare const ordinalMax: bigint;
+export declare const currencyMax: bigint;
 export type CardinalOptions = {
     /**
      * - Grammatical gender
      */
-    gender?: "feminine" | "masculine" | undefined;
+    gender?: ('masculine' | 'feminine');
 };
-export type CurrencyOptions = {
-    /**
-     * - Use "и" between dinars and para
-     */
-    and?: boolean | undefined;
+/**
+ * @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 Serbian (Cyrillic) words.
@@ -35,7 +36,7 @@ export type CurrencyOptions = {
  * @param {CardinalOptions} [options] - Optional configuration
  * @returns {string} The number in Serbian Cyrillic words
  */
-export function toCardinal(value: number | string | bigint, options?: CardinalOptions): string;
+declare function toCardinal(value: number | string | bigint, options?: CardinalOptions): string;
 /**
  * Converts a numeric value to Serbian ordinal words (masculine nominative).
  * @param {number | string | bigint} value - The numeric value to convert (must be a positive integer)
@@ -51,7 +52,19 @@ export function toCardinal(value: number | string | bigint, options?: CardinalOp
  * toOrdinal(100)  // 'стоти'
  * toOrdinal(1000) // 'хиљадити'
  */
-export function toOrdinal(value: number | string | bigint): string;
+declare function toOrdinal(value: number | string | bigint): string;
+export type CurrencyOptions = {
+    /**
+     * - Use "и" between dinars and para
+     */
+    and?: boolean;
+};
+/**
+ * @typedef {object} CurrencyOptions
+ * @property {boolean} [and] - Use "и" between dinars and para
+ */
+/** @type {Required<CurrencyOptions>} */
+export declare const currencyDefaults: Required<CurrencyOptions>;
 /**
  * Converts a numeric value to Serbian currency words (Serbian Dinar).
  * @param {number | string | bigint} value - The currency amount to convert
@@ -66,4 +79,5 @@ export function toOrdinal(value: number | string | bigint): string;
  * toCurrency(0.01)                     // 'једна пара'
  * toCurrency(42.50, { and: false })    // 'четрдесет два динара педесет пара'
  */
-export function toCurrency(value: number | string | bigint, options?: CurrencyOptions): string;
+declare function toCurrency(value: number | string | bigint, options?: CurrencyOptions): string;
+export { toCardinal, toOrdinal, toCurrency };

package/src/sr-Latn-RS.d.ts

@@ -1,33 +1,34 @@
-export const cardinalMax: bigint;
-export const ordinalMax: bigint;
-export const currencyMax: bigint;
 /**
- * @typedef {object} CardinalOptions
- * @property {('masculine'|'feminine')} [gender] - Grammatical gender
+ * Serbian (Serbia, Latin script) language converter
+ *
+ * CLDR: sr-Latn-RS | Serbian as used in Serbia (Latin script)
+ *
+ * Key features:
+ * - Three-form pluralization (one/few/many)
+ * - Gender by scale word: the -arda forms (hiljada, milijarda, bilijarda, ...)
+ *   are feminine; the -ion forms (milion, bilion, ...) are masculine
+ * - Irregular hundreds (dvesta, trista, etc.)
+ * - Long scale naming with -ard forms
+ * - Latin script
  */
-/** @type {Required<CardinalOptions>} */
-export const cardinalDefaults: Required<CardinalOptions>;
-/** @type {{ gender: ReadonlyArray<Required<CardinalOptions>['gender']> }} */
-export const cardinalValues: {
-    gender: ReadonlyArray<Required<CardinalOptions>["gender"]>;
-};
-/**
- * @typedef {object} CurrencyOptions
- * @property {boolean} [and] - Use "i" between dinars and para
- */
-/** @type {Required<CurrencyOptions>} */
-export const currencyDefaults: Required<CurrencyOptions>;
+export declare const cardinalMax: bigint;
+export declare const ordinalMax: bigint;
+export declare const currencyMax: bigint;
 export type CardinalOptions = {
     /**
      * - Grammatical gender
      */
-    gender?: "feminine" | "masculine" | undefined;
+    gender?: ('masculine' | 'feminine');
 };
-export type CurrencyOptions = {
-    /**
-     * - Use "i" between dinars and para
-     */
-    and?: boolean | undefined;
+/**
+ * @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 Serbian (Latin) words.
@@ -35,7 +36,7 @@ export type CurrencyOptions = {
  * @param {CardinalOptions} [options] - Optional configuration
  * @returns {string} The number in Serbian Latin words
  */
-export function toCardinal(value: number | string | bigint, options?: CardinalOptions): string;
+declare function toCardinal(value: number | string | bigint, options?: CardinalOptions): string;
 /**
  * Converts a numeric value to Serbian ordinal words (masculine nominative).
  * @param {number | string | bigint} value - The numeric value to convert (must be a positive integer)
@@ -51,7 +52,19 @@ export function toCardinal(value: number | string | bigint, options?: CardinalOp
  * toOrdinal(100)  // 'stoti'
  * toOrdinal(1000) // 'hiljaditi'
  */
-export function toOrdinal(value: number | string | bigint): string;
+declare function toOrdinal(value: number | string | bigint): string;
+export type CurrencyOptions = {
+    /**
+     * - Use "i" between dinars and para
+     */
+    and?: boolean;
+};
+/**
+ * @typedef {object} CurrencyOptions
+ * @property {boolean} [and] - Use "i" between dinars and para
+ */
+/** @type {Required<CurrencyOptions>} */
+export declare const currencyDefaults: Required<CurrencyOptions>;
 /**
  * Converts a numeric value to Serbian currency words (Serbian Dinar).
  * @param {number | string | bigint} value - The currency amount to convert
@@ -66,4 +79,5 @@ export function toOrdinal(value: number | string | bigint): string;
  * toCurrency(0.01)                     // 'jedna para'
  * toCurrency(42.50, { and: false })    // 'četrdeset dva dinara pedeset para'
  */
-export function toCurrency(value: number | string | bigint, options?: CurrencyOptions): string;
+declare function toCurrency(value: number | string | bigint, options?: CurrencyOptions): string;
+export { toCardinal, toOrdinal, toCurrency };

package/src/sv-SE.d.ts

@@ -1,6 +1,18 @@
-export const cardinalMax: bigint;
-export const ordinalMax: bigint;
-export const currencyMax: bigint;
+/**
+ * Swedish (Sweden) language converter
+ *
+ * CLDR: sv-SE | Swedish as used in Sweden
+ *
+ * Key features:
+ * - Hyphenation for tens-ones (tjugo-ett)
+ * - "och" after hundreds before small numbers
+ * - Omit "ett" before hundra and tusen
+ * - Use "en" (not "ett") before million+ scales
+ * - Long scale naming with -ard forms
+ */
+export declare const cardinalMax: bigint;
+export declare const ordinalMax: bigint;
+export declare const currencyMax: bigint;
 /**
  * Converts a numeric value to Swedish words.
  * @param {number | string | bigint} value - The numeric value to convert
@@ -12,7 +24,7 @@ export const currencyMax: bigint;
  * toCardinal(101)      // 'hundra och ett'
  * toCardinal(1000000)  // 'en miljon'
  */
-export function toCardinal(value: number | string | bigint): string;
+declare function toCardinal(value: number | string | bigint): string;
 /**
  * Converts a numeric value to Swedish ordinal words.
  * @param {number | string | bigint} value - The numeric value to convert (positive integer)
@@ -24,7 +36,7 @@ export function toCardinal(value: number | string | bigint): string;
  * toOrdinal(2)    // 'andra'
  * toOrdinal(21)   // 'tjugo-ettde'
  */
-export function toOrdinal(value: number | string | bigint): string;
+declare function toOrdinal(value: number | string | bigint): string;
 /**
  * Converts a numeric value to Swedish currency words (Swedish Krona).
  *
@@ -38,4 +50,5 @@ export function toOrdinal(value: number | string | bigint): string;
  * toCurrency(42)     // 'fyrtio-två kronor'
  * toCurrency(1.50)   // 'en krona och femtio öre'
  */
-export function toCurrency(value: number | string | bigint): string;
+declare function toCurrency(value: number | string | bigint): string;
+export { toCardinal, toOrdinal, toCurrency };

package/src/sw-KE.d.ts

@@ -1,12 +1,22 @@
-export const cardinalMax: bigint;
-export const ordinalMax: bigint;
-export const currencyMax: bigint;
+/**
+ * Swahili (Kenya) language converter
+ *
+ * CLDR: sw-KE | Swahili as used in Kenya
+ *
+ * Key features:
+ * - "na" connector for compound numbers
+ * - Reversed hundreds: "mia moja" (one hundred)
+ * - Scale words: elfu, milioni, bilioni
+ */
+export declare const cardinalMax: bigint;
+export declare const ordinalMax: bigint;
+export declare const currencyMax: bigint;
 /**
  * Converts a numeric value to Swahili words.
  * @param {number | string | bigint} value - The numeric value to convert
  * @returns {string} The number in Swahili words
  */
-export function toCardinal(value: number | string | bigint): string;
+declare function toCardinal(value: number | string | bigint): string;
 /**
  * Converts a numeric value to Swahili ordinal words.
  * @param {number | string | bigint} value - The numeric value to convert (positive integer)
@@ -18,7 +28,7 @@ export function toCardinal(value: number | string | bigint): string;
  * toOrdinal(2)    // 'wa pili'
  * toOrdinal(10)   // 'wa kumi'
  */
-export function toOrdinal(value: number | string | bigint): string;
+declare function toOrdinal(value: number | string | bigint): string;
 /**
  * Converts a numeric value to Swahili currency words (Kenyan Shilling).
  *
@@ -32,4 +42,5 @@ export function toOrdinal(value: number | string | bigint): string;
  * toCurrency(1.50)   // 'shilingi moja na senti hamsini'
  * toCurrency(-5)     // 'minus shilingi tano'
  */
-export function toCurrency(value: number | string | bigint): string;
+declare function toCurrency(value: number | string | bigint): string;
+export { toCardinal, toOrdinal, toCurrency };

package/src/ta-IN.d.ts

@@ -1,12 +1,26 @@
-export const cardinalMax: bigint;
-export const ordinalMax: bigint;
-export const currencyMax: bigint;
+/**
+ * Tamil (India) language converter
+ *
+ * CLDR: ta-IN | Tamil as used in India
+ *
+ * Key features:
+ * - Indian numbering system (ஆயிரம், லட்சம், கோடி)
+ * - Tamil script
+ * - 3-2-2 grouping pattern
+ * - Complete word forms for 0-99
+ * - Special hundred word transformations (connected vs standalone)
+ * - Per-digit decimal reading
+ * - BigInt modulo for efficient segment extraction
+ */
+export declare const cardinalMax: bigint;
+export declare const ordinalMax: bigint;
+export declare const currencyMax: bigint;
 /**
  * Converts a numeric value to Tamil words.
  * @param {number | string | bigint} value - The numeric value to convert
  * @returns {string} The number in Tamil words
  */
-export function toCardinal(value: number | string | bigint): string;
+declare function toCardinal(value: number | string | bigint): string;
 /**
  * Converts a numeric value to Tamil ordinal words.
  * @param {number | string | bigint} value - The numeric value to convert (positive integer)
@@ -18,7 +32,7 @@ export function toCardinal(value: number | string | bigint): string;
  * toOrdinal(2)    // 'இரண்டாவது'
  * toOrdinal(10)   // 'பத்துஆவது'
  */
-export function toOrdinal(value: number | string | bigint): string;
+declare function toOrdinal(value: number | string | bigint): string;
 /**
  * Converts a numeric value to Tamil currency words (Indian Rupee).
  * @param {number | string | bigint} value - The currency amount to convert
@@ -30,4 +44,5 @@ export function toOrdinal(value: number | string | bigint): string;
  * toCurrency(1)      // 'ஒன்று ரூபாய்'
  * toCurrency(0.01)   // 'ஒன்று பைசா'
  */
-export function toCurrency(value: number | string | bigint): string;
+declare function toCurrency(value: number | string | bigint): string;
+export { toCardinal, toOrdinal, toCurrency };

package/src/te-IN.d.ts

@@ -1,12 +1,24 @@
-export const cardinalMax: bigint;
-export const ordinalMax: bigint;
-export const currencyMax: bigint;
+/**
+ * Telugu (India) language converter
+ *
+ * CLDR: te-IN | Telugu as used in India
+ *
+ * Key features:
+ * - Indian numbering system (వెయ్యి, లక్ష, కోటి)
+ * - Telugu script
+ * - 3-2-2 grouping pattern
+ * - Complete word forms for 0-99
+ * - Per-digit decimal reading
+ */
+export declare const cardinalMax: bigint;
+export declare const ordinalMax: bigint;
+export declare const currencyMax: bigint;
 /**
  * Converts a numeric value to Telugu words.
  * @param {number | string | bigint} value - The numeric value to convert
  * @returns {string} The number in Telugu words
  */
-export function toCardinal(value: number | string | bigint): string;
+declare function toCardinal(value: number | string | bigint): string;
 /**
  * Converts a numeric value to Telugu ordinal words.
  * @param {number | string | bigint} value - The numeric value to convert (positive integer)
@@ -18,7 +30,7 @@ export function toCardinal(value: number | string | bigint): string;
  * toOrdinal(2)    // 'రెండవ'
  * toOrdinal(10)   // 'పదివ'
  */
-export function toOrdinal(value: number | string | bigint): string;
+declare function toOrdinal(value: number | string | bigint): string;
 /**
  * Converts a numeric value to Telugu currency words (Indian Rupee).
  * @param {number | string | bigint} value - The currency amount to convert
@@ -30,4 +42,5 @@ export function toOrdinal(value: number | string | bigint): string;
  * toCurrency(1)      // 'ఒకటి రూపాయి'
  * toCurrency(0.01)   // 'ఒకటి పైసా'
  */
-export function toCurrency(value: number | string | bigint): string;
+declare function toCurrency(value: number | string | bigint): string;
+export { toCardinal, toOrdinal, toCurrency };

package/src/th-TH.d.ts

@@ -1,12 +1,24 @@
-export const cardinalMax: null;
-export const ordinalMax: null;
-export const currencyMax: null;
+/**
+ * Thai (Thailand) language converter
+ *
+ * CLDR: th-TH | Thai as used in Thailand
+ *
+ * Key features:
+ * - No word separators (continuous Thai script)
+ * - Million-based grouping (ล้าน)
+ * - Special handling for 1 as "เอ็ด" in compounds
+ * - 20 is "ยี่สิบ" (not "สองสิบ")
+ * - Per-digit decimal reading
+ */
+export declare const cardinalMax: null;
+export declare const ordinalMax: null;
+export declare const currencyMax: null;
 /**
  * Converts a numeric value to Thai words.
  * @param {number | string | bigint} value - The numeric value to convert
  * @returns {string} The number in Thai words
  */
-export function toCardinal(value: number | string | bigint): string;
+declare function toCardinal(value: number | string | bigint): string;
 /**
  * Converts a numeric value to Thai ordinal words.
  * @param {number | string | bigint} value - The numeric value to convert (positive integer)
@@ -18,7 +30,7 @@ export function toCardinal(value: number | string | bigint): string;
  * toOrdinal(2)    // 'ที่สอง'
  * toOrdinal(10)   // 'ที่สิบ'
  */
-export function toOrdinal(value: number | string | bigint): string;
+declare function toOrdinal(value: number | string | bigint): string;
 /**
  * Converts a numeric value to Thai currency words (Baht).
  *
@@ -33,4 +45,5 @@ export function toOrdinal(value: number | string | bigint): string;
  * toCurrency(1.50)   // 'หนึ่งบาทห้าสิบสตางค์'
  * toCurrency(-5)     // 'ลบห้าบาทถ้วน'
  */
-export function toCurrency(value: number | string | bigint): string;
+declare function toCurrency(value: number | string | bigint): string;
+export { toCardinal, toOrdinal, toCurrency };

package/src/tr-TR.d.ts

@@ -1,18 +1,28 @@
-export const cardinalMax: bigint;
-export const ordinalMax: bigint;
-export const currencyMax: bigint;
 /**
- * @typedef {object} CardinalOptions
- * @property {boolean} [dropSpaces] - Remove spaces for compound form
+ * Turkish (Turkey) language converter
+ *
+ * CLDR: tr-TR | Turkish as used in Turkey
+ *
+ * Key features:
+ * - Omits 'bir' (one) before hundreds and thousands
+ * - Optional dropSpaces for compound form
+ * - Short scale naming
  */
-/** @type {Required<CardinalOptions>} */
-export const cardinalDefaults: Required<CardinalOptions>;
+export declare const cardinalMax: bigint;
+export declare const ordinalMax: bigint;
+export declare const currencyMax: bigint;
 export type CardinalOptions = {
     /**
      * - Remove spaces for compound form
      */
-    dropSpaces?: boolean | undefined;
+    dropSpaces?: boolean;
 };
+/**
+ * @typedef {object} CardinalOptions
+ * @property {boolean} [dropSpaces] - Remove spaces for compound form
+ */
+/** @type {Required<CardinalOptions>} */
+export declare const cardinalDefaults: Required<CardinalOptions>;
 /**
  * Converts a numeric value to Turkish words.
  * @param {number | string | bigint} value - The numeric value to convert
@@ -25,7 +35,7 @@ export type CardinalOptions = {
  * toCardinal(21, { dropSpaces: true })  // 'yirmibir'
  * toCardinal(1000)                      // 'bin'
  */
-export function toCardinal(value: number | string | bigint, options?: CardinalOptions): string;
+declare function toCardinal(value: number | string | bigint, options?: CardinalOptions): string;
 /**
  * Converts a numeric value to Turkish ordinal words.
  * @param {number | string | bigint} value - The numeric value to convert (positive integer)
@@ -37,7 +47,7 @@ export function toCardinal(value: number | string | bigint, options?: CardinalOp
  * toOrdinal(2)    // 'ikinci'
  * toOrdinal(21)   // 'yirmibirinci'
  */
-export function toOrdinal(value: number | string | bigint): string;
+declare function toOrdinal(value: number | string | bigint): string;
 /**
  * Converts a numeric value to Turkish currency words (Turkish Lira).
  *
@@ -51,4 +61,5 @@ export function toOrdinal(value: number | string | bigint): string;
  * toCurrency(1.50)   // 'bir lira elli kuruş'
  * toCurrency(-5)     // 'eksi beş lira'
  */
-export function toCurrency(value: number | string | bigint): string;
+declare function toCurrency(value: number | string | bigint): string;
+export { toCardinal, toOrdinal, toCurrency };

package/src/uk-UA.d.ts

@@ -1,21 +1,32 @@
-export const cardinalMax: bigint;
-export const ordinalMax: bigint;
-export const currencyMax: bigint;
 /**
- * @typedef {object} CardinalOptions
- * @property {('masculine'|'feminine')} [gender] - Grammatical gender
+ * Ukrainian (Ukraine) language converter
+ *
+ * CLDR: uk-UA | Ukrainian as used in Ukraine
+ *
+ * Key features:
+ * - Three-form pluralization (one/few/many)
+ * - Gender: thousands are feminine, millions+ are masculine
+ * - Irregular hundreds
+ * - Long scale naming
  */
-/** @type {Required<CardinalOptions>} */
-export const cardinalDefaults: Required<CardinalOptions>;
-/** @type {{ gender: ReadonlyArray<Required<CardinalOptions>['gender']> }} */
-export const cardinalValues: {
-    gender: ReadonlyArray<Required<CardinalOptions>["gender"]>;
-};
+export declare const cardinalMax: bigint;
+export declare const ordinalMax: bigint;
+export declare const currencyMax: bigint;
 export type CardinalOptions = {
     /**
      * - Grammatical gender
      */
-    gender?: "feminine" | "masculine" | undefined;
+    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 Ukrainian words.
@@ -23,7 +34,7 @@ export type CardinalOptions = {
  * @param {CardinalOptions} [options] - Optional configuration
  * @returns {string} The number in Ukrainian words
  */
-export function toCardinal(value: number | string | bigint, options?: CardinalOptions): string;
+declare function toCardinal(value: number | string | bigint, options?: CardinalOptions): string;
 /**
  * Converts a numeric value to Ukrainian ordinal words (masculine nominative).
  * @param {number | string | bigint} value - The numeric value to convert (must be a positive integer)
@@ -37,7 +48,7 @@ export function toCardinal(value: number | string | bigint, options?: CardinalOp
  * toOrdinal(100)  // 'сотий'
  * toOrdinal(1000) // 'тисячний'
  */
-export function toOrdinal(value: number | string | bigint): string;
+declare function toOrdinal(value: number | string | bigint): string;
 /**
  * Converts a numeric value to Ukrainian currency words (Hryvnia).
  * @param {number | string | bigint} value - The currency amount to convert
@@ -50,4 +61,5 @@ export function toOrdinal(value: number | string | bigint): string;
  * toCurrency(1.50)   // 'одна гривня п\'ятдесят копiйок'
  * toCurrency(-5)     // 'мiнус п\'ять гривень'
  */
-export function toCurrency(value: number | string | bigint): string;
+declare function toCurrency(value: number | string | bigint): string;
+export { toCardinal, toOrdinal, toCurrency };