Permalink
Cannot retrieve contributors at this time
62 lines (38 sloc)
1.09 KB
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
codeql-action/node_modules/plur/readme.md
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# plur | |
> Pluralize a word | |
## Install | |
```sh | |
npm install plur | |
``` | |
## Usage | |
```js | |
import plur from 'plur'; | |
plur('rainbow'); | |
//=> 'rainbows' | |
plur('unicorn', 4); | |
//=> 'unicorns' | |
plur('puppy', 2); | |
//=> 'puppies' | |
plur('box', 2); | |
//=> 'boxes' | |
plur('cactus', 2); | |
//=> 'cacti' | |
``` | |
## API | |
### plur(word, plural?, count?) | |
#### word | |
Type: `string` | |
The word to pluralize. | |
#### plural | |
Type: `string`\ | |
Default: | |
- Irregular nouns will use this [list](https://github.com/sindresorhus/irregular-plurals/blob/main/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*). | |
Explicitly provide the 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` | |
The count to determine whether to use singular or plural. If omitted, defaults to plural. |