ph

profanity-hindi

Small Utility for checking profanity (hindi and English).It supports functionality like detecting bad words and cleaning them.

Showing:

Popularity

Downloads/wk

696

GitHub Stars

9

Maintenance

Last Commit

5yrs ago

Contributors

2

Package

Dependencies

1

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

profanity-hindi

Author : Suraj Kumar Jha

This is a small nodejs module for dealing with profanity in english and hindi. This Module has functionalities for detecting bad words and cleaning them. Technologies used : Nodejs

Installation

just run - npm install profanity-hindi

Requirements

It internally uses lodash , will be automatically installed

Code Example

function maskBadWords()
var profanity = require("profanity-hindi");
var message = "hi asshole you are a bitch chutiya";
var cleaned = profanity.maskBadWords(message);
console.log(cleaned); // hi ******* you are a ***** *******
function isMessageDirty()
var profanity = require("profanity-hindi");
var message = "hi asshole you are a bitch chutiya";
var isDirty = profanity.isMessageDirty(message);
console.log(isDirty);
// prints true

var message = "hi there. How are you";
var isDirty = profanity.isMessageDirty(message);
console.log(isDirty);
// prints false
function addWords()
var profanity = require("profanity-hindi");
 var newWords = ["this", "dumbness"];
 profanity.addWords(newWords); // this will add the new words 
 to the dictionary of bad words. This function optionally
 returns the entire dictionary of bad words.
function removeWords()
var profanity = require("profanity-hindi");
 var newWords = ["this", "dumbness"];
 profanity.removeWords(newWords); // this will remove the new words 
 from the dictionary of bad words. This function optionally
 returns the entire dictionary of bad words.

Unit Tests

Run command : npm test

Contributors

Suraj Kumar Jha

License

MIT License

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial