PluralJS
A micro library to produce any singular noun into plural
💡 Motive
I was curious to learn about how to build a library, what are the thought-processes behind it, what are the technical stuff you need to know etc. This was the primary reason PluralJS came into conception.
📥 Installation
via npm
npm install pluraljs --save
via yarn
yarn add pluraljs
via CDN direct link
<!-- or -->
direct download
curl -o https://unpkg.com/pluraljs/dist/pluraljs.umd.min.js
📑 Usage
The PluralJS is single responsibility library. It takes only a noun (with optional count parameter) and produce plural noun out of it.
API
parameter | description | type | required | example |
---|---|---|---|---|
word | a word to pluralize | string | yes | pluralJs('cat') // cats |
count | pluralize the word based on count | number | no | pluralJs('cat', 3) // cats pluralJs('cat', 1) // cat |
Node
const pluralJs = require('pluraljs');console.log(pluralJs('cat')); // cats console.log(pluralJs('cat', 1)); // catconsole.log(pluralJs('cat', 3)); // cats
ES6
;console; // cats console; // cat
Browser
🧡 Show little more care in your product
Product without words pluralization | Product using PluralJS |
---|---|
📋 Changelog
1.1.0
ENHANCEMENT
Added ability to pass count parameter
1.0.0
FEATURE
Released first stable version
💂♂️Maintainer
Kalpesh Singh (@knowkalpesh)
🙇 Credits
- The core logic and testing file are borrowed from Blake Embrey's Pluralize
- Card screenshot used from Chakra UI
- Those lovely cats artwork used for branding is from Undraw
⚖️ License
kalpeshsingh/PluralJS is licensed under the MIT license.