js-string-cleaner
v1.2.0
Published
A simple npm module to replace special characters in a string with unicode letters.
Downloads
53
Readme
A simple npm module to replace special characters in a string with unicode letters.
🏠 Homepage
Install
npm i js-string-cleaner
Usage
The module has only one function that takes as parameter a string and an optionnal object. By default, each character will simply be replaced by its corresponding letter, which can lead to mixtures of lower and upper case letters. If a character is not recognized, it is left as it is. To get a formatted string, with only the first letter of each word in uppercase or only the first character of the sentence in uppercase, use parameters capitalizeAllWords
or capitalizeFirstLetter
.
const clean = require('js-string-cleaner');
const txt = 'sιмση ℓεcℓεяε#5765';
clean(txt); // simon leclere#5765
clean(txt, { capitalizeFirstLetter: true }); // Simon leclere#5765
clean(txt, { capitalizeAllWords: true }); // Simon Leclere#5765
Author
👤 Simon Leclère
- Github: @SimonLeclere
🤝 Contributing
Contributions, issues and feature requests are welcome!Feel free to check issues page.
PS: If you want to add new characters, don't hesitate to make a pull request or to contact me on Discord : sιмση ℓεcℓεяε#5765
.
Build it yourself
npm run test
npm run format
npm run lint
npm run build
Show your support
Give a ⭐️ if this project helped you!
📝 License
Copyright © 2020 Simon Leclère. This project is ISC licensed.
This README was generated with ❤️ by readme-md-generator