auth-api/tests/node_modules/plur/readme.md

53 lines
635 B
Markdown
Raw Normal View History

2021-06-23 22:30:45 +02:00
# plur [![Build Status](https://travis-ci.org/sindresorhus/plur.svg?branch=master)](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)