summaryrefslogtreecommitdiff
path: root/README.md
blob: ee17937639187bd65e5f537d0ca54aff69229bad (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# node-vk-flex

Нативный модуль для Node.js для склонения имен. Использует vkext/flex из [KittenPHP](https://github.com/vk-com/kphp-kdb).
Включена поддержка русского и украинского.

### Установка

```
npm install vk-flex
```

### API

`vkflex.setLang(lang)` - настройка языка.
- `lang` - строка, может быть `ru` или `uk`.

`vkflex.name(name, sex, nameCase)` или `vkflex.surname(surname, sex, nameCase)` - склоняет  имя или фамилию.
- `name` или `surname` - строка;
- `sex` - число, `0` - мужской, `1` - женский;
- `nameCase` - падеж: `Gen`, `Dat`, `Acc`, `Ins` или `Abl`.