# anti-profanity

> Blocks most profanity, easily add more that aren't blocked, also blocks 1337(LEET)

Latest version **2.0.7** (published 2021-04-17) · ISC license · 0 weekly downloads

## Install

```sh
npm install anti-profanity
pnpm add anti-profanity
yarn add anti-profanity
bun add anti-profanity
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.7 |
| Published | 2021-04-17 |
| First published | 2021-04-16 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 22.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Sean Devine |
| Maintainers | hjoker4 |
| Keywords | anti-profanity, filter, leet |

## Links

- npm: https://www.npmjs.com/package/anti-profanity
- npm.io page: https://npm.io/package/anti-profanity

## Recent versions

- 2.0.7 (latest) — 2021-04-17
- 2.0.6 — 2021-04-17
- 2.0.5 — 2021-04-17
- 2.0.4 — 2021-04-17
- 2.0.3 — 2021-04-17
- 2.0.2 — 2021-04-17
- 2.0.1 — 2021-04-17
- 2.0.0 — 2021-04-17
- 1.0.0 — 2021-04-16

## README

## Anti-Profanity ##
A way to detect badwords, with support for Leet(L33t). Easy to edit, just add values to the array

## What is LEET? ##
Leet (sometimes written as "1337" or "l33t"), also known as eleet or leet-speak, is another alphabet for the English language that is used mostly on the internet. It uses various combinations of ASCII characters to replace Latinate letters.

## **Usage** ##

```
const antiProfanity = require('anti-profanity');  //import Module

var msg = 'Your an asshole';

//anitProfanity.isProfane([String], [Enable Leet? True/False]) returns either true or false

console.log(antiProfanity.isProfane(msg, false)) //returns false
```

#### L33t Enabled ####

```
const antiProfanity = require('anti-profanity');  //import module

var msg = 'Your an a55h0l3';

//L33t enabled
console.log(antiProfanity.isProfane(msg, true)) //returns true

//L33t disabled
console.log(antiProfanity.isProfane(msg, true)) //returns false
```

#### Triggers ####

```
".ass" Profane
"glass" Not Profane
".a55" Profane
"gla55" Not Profane
```

## Functions ##
__isProfane__
*Determine if a string contains language that may be considered profane*
__Usage:__`antiProfanity.isProfane(String, Boolean)`

---
_Source: https://npm.io/package/anti-profanity · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._