You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Character or array of strings to replace bad words with in clean function
useRegex
boolean
false
Option to convert strings in list to regex expressions
Functions
Function
Parameters
Returns
Description
normalize
String message to normalize
String normalized message
converts to lowercase, normalizes accented characters, converts l33t text to normal text, removes excess non-alphabetical characters (automatically used in all package functions)
isUnclean
String message to check for cleanliness
Boolean true if contains any filtered word
parses message for any filtered words
clean
String message to clean
String cleaned message
replaces all filtered words with cleanWith character or a random string
getUncleanWordIndexes
String message to parse
Array <number> indexes of words that contain filtered words
gets indexes of all filtered words
isWordUnclean
String word to check
Boolean true if word is detected as a filtered word
checks if a word is filtered
debug
String message to test
undefined
prints to console the outputs of all functions on the given string
Example Detection
constFilter=require("badwords-filter");constconfig={list: ["hello"]};constfilter=newFilter(config);//All the following would return truefilter.isUnclean("hello");filter.isUnclean("HeLlO");filter.isUnclean("h3ll0");filter.isUnclean("heeeellloooo");filter.isUnclean("heeeeellllooooooo there!!!");filter.isUnclean("héllo");filter.isUnclean("h.#ell-o");
Examples
Using a custom filter list
Normal strings filter
constFilter=require("badwords-filter");constfilter=newFilter({list: ["badword"]});filter.isUnclean("This sentence contains 'badword'");// truefilter.isUnclean("This sentence does not contain any nasty words");// falsefilter.clean("This sentence contains 'badword'");// "This sentence contains *********"filter.getUncleanWordIndexes("This sentence contains 'badword'");//[3]filter.getUncleanWordIndexes("baaadword, goodword, okayword, badword");// [0,3]filter.isUnclean("baaaaaadw0rd");//true
Regex strings filter
constFilter=require("badwords-filter");constfilter=newFilter({list: ["b.+d"],// any word that stars with b and ends with duseRegex: true,});filter.isUnclean("marching band");// truefilter.clean("marching band");// "marching ****"