2
0
mirror of https://github.com/tenrok/numeralize-ru.git synced 2026-06-02 16:04:11 +03:00
Files
numeralize-ru/README.md
T
Ivan Demidov 32304552e5 fix: typo
2019-10-02 15:31:10 +03:00

109 lines
6.3 KiB
Markdown

# numeralize-ru
Написание числительных на русском языке с учётом пола и падежа.
# Установка
```
npm install --save numeralize-ru
```
# API
### `numeralize(number, [gender, [kase, [animate]]])`
Возвращает числительное, соответствующее числу
+ `number` — число, для которого надо записать числительное;
+ `gender` — пол:
+ `numeralize.GENDER_MASCULINE` — мужской (по умолчанию);
+ `numeralize.GENDER_FEMININE` — женский;
+ `numeralize.GENDER_NEUTER` — средний;
+ `kase` — падеж (`case` является ключевым словом, поэтому не может быть использован в качестве имени переменной):
+ `numeralize.CASE_NOMINATIVE` — именительный (по умолчанию);
+ `numeralize.CASE_GENITIVE` — родительный;
+ `numeralize.CASE_DATIVE` — дательный;
+ `numeralize.CASE_ACCUSATIVE` — винительный;
+ `numeralize.CASE_INSTRUMENTAL` — творительный;
+ `numeralize.CASE_PREPOSITIONAL` — предложный;
+ `animate` — являются ли перечисляемые предметы одушевлёнными (влияет на форму винительного падежа некоторых числительных)
```javascript
const numeralize = require('numeralize-ru');
numeralize(5122981121);
// мужской род, 'пять миллиардов сто двадцать два миллиона девятьсот восемьдесят одна тысяча сто двадцать один'
numeralize(5122981121, numeralize.GENDER_FEMININE);
// женский род, 'пять миллиардов сто двадцать два миллиона девятьсот восемьдесят одна тысяча сто двадцать одна'
numeralize(5122981121, numeralize.GENDER_NEUTER);
// средний род, 'пять миллиардов сто двадцать два миллиона девятьсот восемьдесят одна тысяча сто двадцать одно'
numeralize(5122981121, numeralize.GENDER_MASCULINE, numeralize.CASE_NOMINATIVE);
// мужской род, именительный падеж, 'пять миллиардов сто двадцать два миллиона девятьсот восемьдесят одна тысяча сто двадцать один'
numeralize(5122981121, numeralize.GENDER_MASCULINE, numeralize.CASE_GENITIVE);
// мужской род, родительный падеж, 'пяти миллиардов ста двадцати двух миллионов девятисот восьмидесяти одной тысячи ста двадцати одного'
numeralize(5122981121, numeralize.GENDER_MASCULINE, numeralize.CASE_DATIVE);
// мужской род, дательный падеж, 'пяти миллиардам ста двадцати двум миллионам девятистам восьмидесяти одной тысяче ста двадцати одному'
numeralize(5122981121, numeralize.GENDER_MASCULINE, numeralize.CASE_ACCUSATIVE);
// мужской род, винительный падеж, 'пять миллиардов сто двадцать два миллиона девятьсот восемьдесят одну тысячу сто двадцать один'
numeralize(5122981121, numeralize.GENDER_MASCULINE, numeralize.CASE_ACCUSATIVE, true);
// мужской род, винительный падеж, одушевлённые предметы, 'пять миллиардов сто двадцать два миллиона девятьсот восемьдесят одну тысячу сто двадцать одного'
numeralize(5122981121, numeralize.GENDER_MASCULINE, numeralize.CASE_INSTRUMENTAL);
// мужской род, творительный падеж, 'пятью миллиардами ста двадцатью двумя миллионами девятьюстами восемьюдесятью одной тысячей ста двадцатью одним'
numeralize(5122981121, numeralize.GENDER_MASCULINE, numeralize.CASE_PREPOSITIONAL);
// мужской род, творительный падеж, 'пяти миллиардах ста двадцати двух миллионах девятистах восьмидесяти одной тысяче ста двадцати одном'
```
### `numeralize.pluralize(count, one, two, five)`
Выбирает нужную форму существительного в зависимости от количества.
+ `count` — количество
+ `one` — форма существительного для одного предмета, например, _рубль_;
+ `two` — форма существительного для двух предметов, например, _рубля_;
+ `five` — форма существительного для пяти предметов, например, _рублей_;
```javascript
const pluralize = require('numeralize-ru').pluralize;
pluralize(0, 'рубль', 'рубля', 'рублей');
// 'рублей'
pluralize(1, 'рубль', 'рубля', 'рублей');
// 'рубль'
pluralize(2, 'рубль', 'рубля', 'рублей');
// 'рубля'
pluralize(5, 'рубль', 'рубля', 'рублей');
// 'рублей'
pluralize(11, 'рубль', 'рубля', 'рублей');
// 'рублей'
pluralize(21, 'рубль', 'рубля', 'рублей');
// 'рубль'
pluralize(22, 'рубль', 'рубля', 'рублей');
// 'рубля'
```
# Roadmap
+ Порядковые числительные (ordinal numerals): _первый_, _вторым_, _третьими_ и т.д.
+ Собирательные числительные (collective numerals): _трое_, _четверых_, _пятерыми_ и т.д.
+ Особые формы единственного и множественного числа: _одни сутки_, _два дня_, _пять суток_ и т.д.
# См.также
+ Подробно о склонении числительных в русском языке с примерами: http://numeralonline.ru/