mirrors/numeralize-ru
2
0
Fork 0
mirror of https://github.com/tenrok/numeralize-ru.git synced 2026-06-20 20:00:41 +03:00
Code Activity

Fix README

Browse Source
This commit is contained in:
anotherpit
2016-03-31 04:09:02 +03:00
parent 5caa661b09
commit fbc67f495d
1 changed files with 21 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+21 -15
View File
@@ -10,20 +10,23 @@ npm install --save numeralize-ru
# API # API
`numeralize(number, [gender, [kase, [animate]]])` — возвращает числительное, соответствующее числу ### `numeralize(number, [gender, [kase, [animate]]])`
Возвращает числительное, соответствующее числу
+ `number` — число, для которого надо записать числительное; + `number` — число, для которого надо записать числительное;
+ `gender` - пол: + `gender` — пол:
+ `numeralize.GENDER_MASCULINE` - мужской (по умолчанию); + `numeralize.GENDER_MASCULINE` — мужской (по умолчанию);
+ `numeralize.GENDER_FEMININE` - женский; + `numeralize.GENDER_FEMININE` — женский;
+ `numeralize.GENDER_NEUTER` - средний; + `numeralize.GENDER_NEUTER` — средний;
+ `kase` - падеж (`case` является ключевым словом, поэтому не может быть использован в качестве имени переменной): + `kase` — падеж (`case` является ключевым словом, поэтому не может быть использован в качестве имени переменной):
+ `numeralize.CASE_NOMINATIVE` - именительный (по умолчанию); + `numeralize.CASE_NOMINATIVE` — именительный (по умолчанию);
+ `numeralize.CASE_GENITIVE` - родительный; + `numeralize.CASE_GENITIVE` — родительный;
+ `numeralize.CASE_DATIVE` - дательный; + `numeralize.CASE_DATIVE` — дательный;
+ `numeralize.CASE_ACCUSATIVE` - винительный; + `numeralize.CASE_ACCUSATIVE` — винительный;
+ `numeralize.CASE_INSTRUMENTAL` - творительный; + `numeralize.CASE_INSTRUMENTAL` — творительный;
+ `numeralize.CASE_PREPOSITIONAL` - предложный; + `numeralize.CASE_PREPOSITIONAL` — предложный;
+ `animate` - являются ли перечисляемые предметы одушевлёнными (влияет на форму винительного падежа некоторых числительных) + `animate` — являются ли перечисляемые предметы одушевлёнными (влияет на форму винительного падежа некоторых числительных)
```javascript ```javascript
const numeralize = require('numeralize'); const numeralize = require('numeralize');
@@ -59,8 +62,11 @@ numeralize(5122981121, numeralize.GENDER_MASCULINE, numeralize.CASE_PREPOSITIONA
// мужской род, творительный падеж, 'пяти миллиардах ста двадцати двух миллионах девятистах восьмидесяти одной тысяче ста двадцати одном' // мужской род, творительный падеж, 'пяти миллиардах ста двадцати двух миллионах девятистах восьмидесяти одной тысяче ста двадцати одном'
``` ```
`numeralize.pluralize(number, one, two, five)` — выбирает нужную форму существительного в зависимости от количества ### `numeralize.pluralize(count, one, two, five)`
+ `number` – количество
Выбирает нужную форму существительного в зависимости от количества.
+ `count` — количество
+ `one` — форма существительного для одного предмета, например, _рубль_; + `one` — форма существительного для одного предмета, например, _рубль_;
+ `two` — форма существительного для двух предметов, например, _рубля_; + `two` — форма существительного для двух предметов, например, _рубля_;
+ `five` — форма существительного для пяти предметов, например, _рублей_; + `five` — форма существительного для пяти предметов, например, _рублей_;