53 lines
635 B
Markdown
53 lines
635 B
Markdown
|
# plur [](https://travis-ci.org/sindresorhus/plur)
|
||
|
|
|
||
|
|
> Naively pluralize a word
|
||
|
|
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
```
|
||
|
|
$ npm install --save plur
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```js
|
||
|
|
var plur = require('plur');
|
||
|
|
|
||
|
|
plur('unicorn', 4);
|
||
|
|
//=> 'unicorns'
|
||
|
|
|
||
|
|
plur('hero', 'heroes', 4);
|
||
|
|
//=> 'heroes'
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## API
|
||
|
|
|
||
|
|
### plur(word, [plural], count)
|
||
|
|
|
||
|
|
#### word
|
||
|
|
|
||
|
|
Type: `string`
|
||
|
|
|
||
|
|
Word to pluralize.
|
||
|
|
|
||
|
|
#### plural
|
||
|
|
|
||
|
|
Type: `string`
|
||
|
|
Default: `word` + `s`
|
||
|
|
|
||
|
|
Pluralized word.
|
||
|
|
|
||
|
|
#### count
|
||
|
|
|
||
|
|
Type: `number`
|
||
|
|
|
||
|
|
Count to determine whether to use singular or plural.
|
||
|
|
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
MIT © [Sindre Sorhus](http://sindresorhus.com)
|