# swearjaranz

> Profanity detection and filtering library.

Latest version **0.4.2** (published 2021-12-07) · ISC license · 0 weekly downloads

## Install

```sh
npm install swearjaranz
pnpm add swearjaranz
yarn add swearjaranz
bun add swearjaranz
```

## 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.4.2 |
| Published | 2021-12-07 |
| First published | 2021-12-07 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 0 |
| Unpacked size | 78.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Mike |
| Maintainers | mikeym007 |
| Keywords | swear, curse, unallowed, profanity, clean, filter, badwords |

## Links

- npm: https://www.npmjs.com/package/swearjaranz
- Repository: https://github.com/mmeisels/swearjar-node-anz
- Issues: https://github.com/mmeisels/swearjar-node-anz/issues
- npm.io page: https://npm.io/package/swearjaranz

## Recent versions

- 0.4.2 (latest) — 2021-12-07
- 0.4.1 — 2021-12-07
- 0.4.0 — 2021-12-07
- 0.3.0 — 2021-12-07
- 0.2.0 — 2021-12-07

## README

# swearjar-node

Profanity detection and filtering library.
Taken from Raymond's version and extended for ANZ swear words etc

## Installation

    npm install --save swearjaranz

## Usage

### swearjar.profane(text)

Returns true if the given string contains profanity.

    var swearjar = require('swearjar');
    swearjar.profane("hello there"); // false
    swearjar.profane("hello mother f-bomb"); // true

### swearjar.censor(text)

Replaces profanity with asterisks.

    var clean = swearjar.censor("f-bomb you"); // **** you

## Acknowledgements

`swearjar-node` is based on [Swearjar](https://github.com/joshbuddy/swearjar) (Ruby) and [Swearjar PHP](https://github.com/raymondjavaxx/swearjar-php).

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