A javascript filter for badwords
As of version 2, requires you either have an environment that understands ES2016 and beyond or a transpiler like Babel.
npm install bad-words
var Filter = require('bad-words'),
filter = new Filter();
console.log(filter.clean("Don't be an ash0le")); //Don't be an ******
var Filter = require('bad-words');
var customFilter = new Filter({ placeHolder: 'x'});
customFilter.clean('Don't be an ash0le'); //Don't be an xxxxxx
var filter = new Filter({ regex: /\*|\.|$/gi });
var filter = new Filter({ replaceRegex: /[A-Za-z0-9가-힣_]/g });
//multilingual support for word filtering
var filter = new Filter();
filter.addWords(['some', 'bad', 'word']);
filter.clean("some bad word!") //**** *** ****!
//or
var filter = new Filter({ list: ['some', 'bad', 'word'] });
filter.clean("some bad word!") //**** *** ****!
var filter = new Filter({ emptyList: true });
filter.clean('hell this wont clean anything'); //hell this wont clean anything
var filter = new Filter();
filter.removeWords('hells');
filter.clean("some hells word!"); //some hells word!
Filter constructor.
Parameters
options object Filter instance options
options.emptyList boolean Instantiate filter with no blacklistoptions.list array Instantiate filter with custom listoptions.placeHolder string Character used to replace profane words.options.regex string Regular expression used to sanitize words before comparing them to blacklist.options.replaceRegex string Regular expression used to replace profane words with placeHolder.Determine if a string contains profane language.
Parameters
string string String to evaluate for profanity.Determine if a single word is profane or looks profane.
Parameters
word string String to evaluate for profanity.Replace a word with placeHolder characters;
Parameters
string string String to replace.Evaluate a string for profanity and return an edited version.
Parameters
string string Sentence to filter.Add words to blacklist filter / remove words from whitelist filter
Parameters
wordsAdd words to whitelist filter
Parameters
word ...string Word to add to whitelist.npm test
The MIT License (MIT)
Copyright (c) 2013 Michael Price
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
FAQs
A javascript filter for bad words
The npm package bad-words receives a total of 62,357 weekly downloads. As such, bad-words popularity was classified as popular.
We found that bad-words demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.
Security News
ENISA’s 2024 report highlights the EU’s top cybersecurity threats, including rising DDoS attacks, ransomware, supply chain vulnerabilities, and weaponized AI.
Security News
NIST's new password guidelines remove periodic changes and special character requirements, focusing on longer, more secure passwords for better authentication practices.