diff options
Diffstat (limited to 'node_modules/irregular-plurals/readme.md')
| -rw-r--r-- | node_modules/irregular-plurals/readme.md | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/node_modules/irregular-plurals/readme.md b/node_modules/irregular-plurals/readme.md new file mode 100644 index 000000000..a700d630e --- /dev/null +++ b/node_modules/irregular-plurals/readme.md @@ -0,0 +1,46 @@ +# irregular-plurals [](https://travis-ci.org/sindresorhus/irregular-plurals) + +> Map of nouns to their irregular plural form +> +> An irregular plural in this library is defined as a noun that cannot be made plural by applying these rules: +> - If the noun ends in an "s", "x", "z", "ch" or "sh", add "es" +> - If the noun ends in a "y" and is preceded by a consonent, drop the "y" and add "ies" +> - If the noun ends in a "y" and is preceded by a vowel, add "s" + +*The list is just a [JSON file](irregular-plurals.json) and can be used wherever.* + + +## Install + +``` +$ npm install --save irregular-plurals +``` + + +## Usage + +```js +const irregularPlurals = require('irregular-plurals'); + +console.log(irregularPlurals['cactus']); +//=> 'cacti' + +console.log(irregularPlurals); +/* + { + addendum: 'addenda', + alga: 'algae', + ... + } +*/ +``` + + +## Related + +- [plur](https://github.com/sindresorhus/plur) - Pluralize a word + + +## License + +MIT © [Sindre Sorhus](http://sindresorhus.com) |