Skip to content

InkyzProd/toksik

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

toksik

npm npm npm bundle size (version) GitHub top language

Toksik is a simple and flexible package for filtering messages containing bad words.

installation

npm install toksik

usage

const Words = require('toksik');
const word = new Words();

console.log(word.isToxic('muka mu seperti lonte')); // return true
console.log(word.isToxic('muka mu seperti bidadari')); // return false

console.log(word.censor('muka mu seperti lonte')); // muka mu seperti *****
console.log(word.censor('muka mu seperti bidadari')); // muka mu seperti bidadari
// You can also use custom characters
console.log(word.censor('muka mu seperti lonte', '•')) // muka mu seperti •••••

console.log(word.filter('muka mu seperti lonte')); // muka mu seperti
console.log(word.filter('muka mu seperti bidadari')); // muka mu seperti bidadari

console.log(word.analyze('muka mu seperti lonte')); // { isToxic: true, toxicList: [ 'lonte' ] }
console.log(word.analyze('muka mu seperti bidadari')); // { isToxic: false, toxicList: [] }

functions

isToxic = Returns true if the text contains an abusive word, and returns false if the text does not contain an abusive word.

censor = Replace badwords to *

filter = Delete text that contains badwords

analyze = Provides a list of all bad words if the text contains dirty words

license

MIT License

contribution

you can contribute badwords for words.json thank you!

Thank you for using this package!