# profanity-scanner

> A very simple profanity scanner.

Latest version **0.0.2** (published 2014-11-16) · ISC license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2014-11-16 |
| First published | 2014-11-16 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Kevin Sloan |
| Maintainers | sloankev |
| Keywords | profanity, filter, scanner, swear |

## Links

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

## Recent versions

- 0.0.2 (latest) — 2014-11-16
- 0.0.1 — 2014-11-16

## README

# Profanity Scanner

This is a very small, and simple profanity scanner that scans for 700+ isolated words. This is not intended to be used as a robust profanity filter, but as a warning mechanism that a string of text might need to be approved or reviewed by a human before it's published.

### Example Usage

```js
var pf = new Profanity_Scanner()
pf.scan('hello there!') // returns false
pf.scan('stfu.') // returns true

pf.add_word('noobie') // returns true if added
pf.remove_word('noobie') // returns true if removed
```

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