blob: 40103d81a827009d0217331d39cfa22bb67afeed (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
# plur [](https://travis-ci.org/sindresorhus/plur)
> Pluralize a word
## Install
```
$ npm install --save plur
```
## Usage
```js
const plur = require('plur');
plur('unicorn', 4);
//=> 'unicorns'
plur('puppy', 2);
//=> 'puppies'
plur('box', 2);
//=> 'boxes'
plur('cactus', 2);
//=> 'cacti'
```
## API
### plur(word, [plural], count)
#### word
Type: `string`
Word to pluralize.
#### plural
Type: `string`
Default:
- Irregular nouns will use this [list](https://github.com/sindresorhus/irregular-plurals/blob/master/irregular-plurals.json).
- Words ending in *s*, *x*, *z*, *ch*, *sh* will be pluralized with *-es* (eg. *foxes*).
- Words ending in *y* that are preceded by a consonant will be pluralized by replacing *y* with *-ies* (eg. *puppies*).
- All other words will have "s" added to the end (eg. *days*).
Pluralized word.
The plural suffix will match the case of the last letter in the word.
This option is only for extreme edge-cases. You probably won't need it.
#### count
Type: `number`
Count to determine whether to use singular or plural.
## License
MIT © [Sindre Sorhus](http://sindresorhus.com)
|
