purgomalum-swear-filter v1.0.2
The easiest way to block swearing on your project!
Install
npm i purgomalum-swear-filter
Usage
Here is a basic example of how purgomalum-swear-filter
works:
const Filter = require("purgomalum-swear-filter")
var filter = new Filter()
filter.clean("Hello a$$")
.then((cleanedText) => {
console.log(cleanedText) //Hello ***
})
You can also use filter.containsProfanity()
, to check if text contains profanity. It returns a boolean.
filter.containsProfanity("Hello")
.then((isBad) => {
console.log(isBad) //false
})
If you don't like promises, you can always use await
in an async
function:
async function() {
var cleaned = await filter.clean("hello")
console.log(cleaned) //hello
}
One of the coolest things about this filter, is that it doesn't always filter out substrings. For example:
await filter.containsProfanity("cock") // true
await filter.containsProfanity("cockpit") // false
Filter Config
You can use a filter config to change functionality of the Purgomalum Filter. Here is a filter object:
{
fill_text: "[CENSORED]",
fill_char: "~",
add: ["badword", "profanityword"]
}
Here is a short explanation about each of them (from the official Purgomalum Website)
Note: You can only have either
fill_char
orfill_text
. You cannot have both.
You can use the config object to create a new Filter
, like this:
var config = {
fill_char: "*",
add: []
}
var filter = new Filter(config)
Author
š¤ CoderGautamYT
YouTube: https://youtube.com/codergautam
Github: @codergautam
š¤ Conclusion
Contributions, issues and feature requests are welcome! Find any issues? Please report them on the issues page.
Give a āļø if this project helped you!