Rewrote how the lib is being built

src/index.spec.ts

@@ -1,4 +1,4 @@
-import {Case, Gender, numeralize} from "./index";
+import {numeralize, Gender, Case} from "./index";
 import * as assert from "assert";
 
 describe(numeralize.name, () => {

src/index.ts

@@ -112,24 +112,6 @@ const LARGES = [
   )
 ] as const;
 
-/**
- * Pluralize noun according to count, e.g. `pluralize(42, 'рубль', 'рубля', 'рублей')`
- */
-export function pluralize(count: number, one: string, two: string, five: string): string {
-  count = Math.floor(Math.abs(count)) % 100;
-  if (count > 10 && count < 20) {
-    return five;
-  }
-  count = count % 10;
-  if (1 === count) {
-    return one;
-  }
-  if (count >= 2 && count <= 4) {
-    return two;
-  }
-  return five;
-}
-
 function small(number: number, gender: Gender, kase: Case, animate: boolean): string {
   // Zero
   if (0 === number) {
@@ -172,7 +154,117 @@ function small(number: number, gender: Gender, kase: Case, animate: boolean): st
 }
 
 /**
- * Numeralize number
+ * Выбирает нужную форму существительного в зависимости от количества.
+ *
+ * @param {number} count Количество
+ * @param {string} one Форма существительного для одного предмета, например, «рубль»;
+ * @param {string} two Форма существительного для двух предметов, например, «рубля»;
+ * @param {string} five Форма существительного для пяти предмета, например, «рублей»;
+ *
+ * @example
+ * // 'рублей'
+ * pluralize(0, 'рубль', 'рубля', 'рублей');
+ *
+ * @example
+ * // 'рубль'
+ * pluralize(1, 'рубль', 'рубля', 'рублей');
+ *
+ * @example
+ * // 'рубля'
+ * pluralize(2, 'рубль', 'рубля', 'рублей');
+ *
+ * @example
+ * // 'рублей'
+ * pluralize(5, 'рубль', 'рубля', 'рублей');
+ *
+ * @example
+ * // 'рублей'
+ * pluralize(11, 'рубль', 'рубля', 'рублей');
+ *
+ * @example
+ * // 'рубль'
+ * pluralize(21, 'рубль', 'рубля', 'рублей');
+ *
+ * @example
+ * // 'рубля'
+ * pluralize(22, 'рубль', 'рубля', 'рублей');
+ */
+export function pluralize(count: number, one: string, two: string, five: string): string {
+  count = Math.floor(Math.abs(count)) % 100;
+  if (count > 10 && count < 20) {
+    return five;
+  }
+  count = count % 10;
+  if (1 === count) {
+    return one;
+  }
+  if (count >= 2 && count <= 4) {
+    return two;
+  }
+  return five;
+}
+
+/**
+ * Возвращает числительное, соответствующее числу
+ *
+ * @param {number} number Целое число, для которого надо записать числительное
+ *
+ * @param {Gender} [gender=Gender.Masculine] Пол:
+ *  - {@link Gender.Masculine} – мужской (по умолчанию);
+ *  - {@link Gender.Feminine} – женский;
+ *  - {@link Gender.Neuter} – средний.
+ *
+ * @param {Case} [kase=Case.Nominative] Падеж
+ *  (`case` является ключевым словом, поэтому не может быть использован в качестве имени переменной):
+ *  - {@link Case.Nominative} — именительный (по умолчанию);
+ *  - {@link Case.Genitive} — родительный;
+ *  - {@link Case.Dative} — дательный;
+ *  - {@link Case.Accusative} — винительный;
+ *  - {@link Case.Instrumental} — творительный;
+ *  - {@link Case.Prepositional} — предложный.
+ *
+ * @param {boolean} [animate=false] Являются ли перечисляемые предметы одушевлёнными
+ *  (влияет на форму винительного падежа некоторых числительных)
+ *
+ * @example
+ * // мужской род, 'пять миллиардов сто двадцать два миллиона девятьсот восемьдесят одна тысяча сто двадцать один'
+ * numeralize(5122981121);
+ *
+ * @example
+ * // женский род, 'пять миллиардов сто двадцать два миллиона девятьсот восемьдесят одна тысяча сто двадцать одна'
+ * numeralize(5122981121, Gender.Feminine);
+ *
+ * @example
+ * // средний род, 'пять миллиардов сто двадцать два миллиона девятьсот восемьдесят одна тысяча сто двадцать одно'
+ * numeralize(5122981121, Gender.Neuter);
+ *
+ * @example
+ * // мужской род, именительный падеж, 'пять миллиардов сто двадцать два миллиона девятьсот восемьдесят одна тысяча сто двадцать один'
+ * numeralize(5122981121, Gender.Masculine, Case.Nominative);
+ *
+ * @example
+ * // мужской род, родительный падеж, 'пяти миллиардов ста двадцати двух миллионов девятисот восьмидесяти одной тысячи ста двадцати одного'
+ * numeralize(5122981121, Gender.Masculine, Case.Genitive);
+ *
+ * @example
+ * // мужской род, дательный падеж, 'пяти миллиардам ста двадцати двум миллионам девятистам восьмидесяти одной тысяче ста двадцати одному'
+ * numeralize(5122981121, Gender.Masculine, Case.Dative);
+ *
+ * @example
+ * // мужской род, винительный падеж, 'пять миллиардов сто двадцать два миллиона девятьсот восемьдесят одну тысячу сто двадцать один'
+ * numeralize(5122981121, Gender.Masculine, Case.Accusative);
+ *
+ * @example
+ * // мужской род, винительный падеж, одушевлённые предметы, 'пять миллиардов сто двадцать два миллиона девятьсот восемьдесят одну тысячу сто двадцать одного'
+ * numeralize(5122981121, Gender.Masculine, Case.Accusative, true);
+ *
+ * @example
+ * // мужской род, творительный падеж, 'пятью миллиардами ста двадцатью двумя миллионами девятьюстами восемьюдесятью одной тысячей ста двадцатью одним'
+ * numeralize(5122981121, Gender.Masculine, Case.Instrumental);
+ *
+ * @example
+ * // мужской род, творительный падеж, 'пяти миллиардах ста двадцати двух миллионах девятистах восьмидесяти одной тысяче ста двадцати одном'
+ * numeralize(5122981121, Gender.Masculine, Case.Prepositional);
  */
 export function numeralize(
   number: number,
@@ -214,3 +306,4 @@ export function numeralize(
   // Return
   return result.join(' ');
 }
+