@imranbarbhuiya/decancer

@imranbarbhuiya/decancer

GitHub codecov npm

Description

A package to remove zalgo and common confusable characters from strings.

Read Full Documentation here.

Features

  • Written In Typescript
  • Offers CJS, ESM and UMD builds
  • Full TypeScript & JavaScript support

Note This project is not perfect, false-positives may happen.

Installation

You can use the following command to install this package, or replace npm install with your package manager of choice.

npm i @imranbarbhuiya/decancer

Usage

import { decancer, isCancerous, cancerPercentage } from '@imranbarbhuiya/decancer';

// Check if a string is cancerous

isCancerous('hello world'); // false
isCancerous('vEⓡ𝔂 𝔽𝕌Ňℕy ţ乇𝕏𝓣'); // true

cancerPercentage('vEⓡ𝔂 𝔽𝕌Ňℕy ţ乇𝕏𝓣', true); // 67
cancerPercentage('My name is Stale'); // 0

// Decancer a string
const result = decancer('Ḣ͚͇͎̰̙̗̹́͟e̞̪̫̣͖̱͍̻̲ͧ̌̀̚̚͘͜w̸̡͕̽̈̾ͬw̥̪͈̖̻ͭ̈́̽ͫ̈͘ơ̢̞ͭͣ̅̑ͭ͗̒̃ ̸͔̝̟̟̳̝͋̄ͥ̈͞W̸͍̬̎̊̎̑͆̐̀̕ò̰̙̺̋ͭ͗́̄̚͝r̪͈̹͈ͧ̅ͨ͛͋͛̃͒̌́l̴̡̰̰͇̪̘̱ͯ̈̓ͨ̕d͎͙̥̩̔̾ͦ̀͞'); // 'Hewwo World'

Buy me some doughnuts

If you want to support me by donating, you can do so by using any of the following methods. Thank you very much in advance!

Buy Me A Coffee Buy Me a Coffee at ko-fi.com

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Parbez
Parbez

💻 🚧 🤔
WhiteSource Renovate
WhiteSource Renovate

🚧
Voxelli
Voxelli

⚠️ 💻 📖

This project follows the all-contributors specification. Contributions of any kind welcome!

Generated using TypeDoc