Profam
All in One Profanity and Spam Tool, supporting multiple languages and modes.
Thanks to:
Tools Overview
Tool | Use |
---|
Profanity | Used to censor words using selected modes |
Spam | Uses an algorithm to stop repeating characters |
How to
Warning : Examples may contain offensive text
Quick Start
import { profanity, spam } from 'profam'
profanity.setDownloadUrl('https://static.gamingforgood.net/assets/profanityLocales/[language].json')
profanity.addLanguages('en')
profanity.setModes('funny')
profanity.run('Go to hell!')
profanity.addCustomLanguages('Klingon')
profanity.addWords('Klingon', ['Hu\'tegh', 'baktag'])
spam.run('trolololololololololol')
API
Profanity Methods
Method | Use |
---|
profanity.getDownloadUrl() | Returns download url |
profanity.setDownloadUrl(string) | Sets download url |
profanity.getLanguages() | Returns array of language downloaded |
profanity.addLanguages(string/array) | Returns a promise and downlods languages |
profanity.addCustomLanguages(string/array) | Adds custom languages |
profanity.removeLanguages(string/array) | Removes languages |
profanity.getWords(string(language)) | Returns bad-words used by language |
profanity.addWords(string(language), string/array) | Adds words to language |
profanity.removeWords(string(language), string/array) | Removes words in language |
profanity.getModes() | Returns enabled modes |
profanity.setModes(string/array) | Enables modes |
profanity.run(string/array) | Returns array of object for each string keyed by mode used |
Spam Tool
Method | Use |
---|
spam.getFrequency() | Returns frequency used in algorithm |
spam.setFrequency(number) | Sets frequency used in algorithm |
spam.run(string/array) | Returns array of strings |
Languages
Name | Code |
---|
Arabic | ar |
Chinese | zh |
Czech | cs |
Danish | da |
Dutch | nl |
English | en |
Esperanto | eo |
Finnish | fi |
French | fr |
German | de |
Hindi | hi |
Hungarian | hu |
Italian | it |
Japanese | ja |
Klingon | tlh |
Korean | ko |
Norwegian | no |
Persian | fa |
Polish | pl |
Portuguese | pt |
Russian | ru |
Spanish | es |
Swedish | sv |
Thai | th |
Turkish | tr |
Modes
Name | Output |
---|
asterisks-obscure | w**d!! |
asterisks-full | ****!! |
funny | unicorn!! |
grawlix | !#%@!! |
spaces | !! |
black | ■■■■!! |
hide | !! |
beep | BEEP!! |