https://github.com/mauroerta/deno-plural
deno-plural module helps you to pluralize or singularize a given word.
https://github.com/mauroerta/deno-plural
deno module pluralization pluralize singularize typescript
Last synced: 5 months ago
JSON representation
deno-plural module helps you to pluralize or singularize a given word.
- Host: GitHub
- URL: https://github.com/mauroerta/deno-plural
- Owner: mauroerta
- License: mit
- Created: 2020-06-21T19:07:27.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-06-08T12:01:40.000Z (almost 3 years ago)
- Last Synced: 2024-11-17T05:43:14.503Z (6 months ago)
- Topics: deno, module, pluralization, pluralize, singularize, typescript
- Language: TypeScript
- Homepage:
- Size: 30.3 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/mauroerta/deno-plural/issues)
[](https://github.com/mauroerta/deno-plural/network)
[](https://github.com/mauroerta/deno-plural/stargazers)
[](https://github.com/mauroerta/deno-plural/blob/master/LICENSE)
# Deno Plural ~ 🙏🏻 = 🍞 🐟
deno-plural module helps you to pluralize or singularize a given word.
## 📝 How to use
You just need to import the singular and plural functions from `deno.land`:
```typescript
import { plural, singular } from "https://deno.land/x/deno_plural/mod.ts";
```
And use it!
```typescript
const pluralWord = plural(`foot`); // Will return the string `feet`
const singularWord = singular(`feet`); // Will return the string `foot`
```
## 🤓 Advanced
### Add a new Language
```typescript
import {
addRules,
plural,
setLanguage,
singular,
} from "https://deno.land/x/deno_plural/mod.ts";
import itRules from "./myCustomRules/it.ts";
addRules("it", itRules);
setLanguage("it");
const pluralWord = plural(`persona`); // Will return the string `persone`
const singularWord = singular(`persone`); // Will return the string `persona`
```
Don't forget to also augment the type definition or Typescript will complain!
```typescript
declare module "https://deno.land/x/deno_plural/mod.ts" {
interface Languages {
it: string;
}
}
```
### Use another language one-time
```typescript
import { plural, singular } from "https://deno.land/x/deno_plural/mod.ts";
const pluralWord = plural(`persona`, "it"); // Will return the string `persone`
const singularWord = singular(`people`); // Will return the string `person`
```
## 🎓 Example
```typescript
import { plural, singular } from "https://deno.land/x/deno_plural/mod.ts";
const singulars = ["foot", "computer"];
let plurals: string[] = [];
console.log("Testing singular --> plural");
singulars.forEach((word) => {
const pluralWord = plural(word);
plurals.push(pluralWord);
console.log(`The plural of ${word} is ${pluralWord}`);
});
console.log("---------------------------");
console.log("Testing plural --> singular");
plurals.forEach((word) => {
console.log(`The singular of ${word} is ${singular(word)}`);
});
```
The output of this simple code will be:
```
Testing singular --> plural
The plural of foot is feet
The plural of computer is computers
---------------------------
Testing plural --> singular
The singular of feet is foot
The singular of computers is computer
```
## 🙏 Thanks
This project could not exist without the work of
[pluralize](https://github.com/plurals/pluralize).