История

github-actions[bot] 0da815296a Update checked-in dependencies		2022-02-24 17:03:29 +00:00
..
index.d.ts	Upgrade Ava to v4	2022-02-01 18:56:42 +00:00
index.js	Upgrade Ava to v4	2022-02-01 18:56:42 +00:00
license	replace jest with ava	2020-05-13 11:13:27 +01:00
package.json	Update checked-in dependencies	2022-02-24 17:03:29 +00:00
readme.md	Upgrade Ava to v4	2022-02-01 18:56:42 +00:00

readme.md

plur

Pluralize a word

Install

npm install plur

Usage

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.
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.