# automod-filter

> Bad word filter.

Latest version **1.0.1** (published 2022-09-23) · ISC license · 0 weekly downloads

## Install

```sh
npm install automod-filter
pnpm add automod-filter
yarn add automod-filter
bun add automod-filter
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2022-09-23 |
| First published | 2022-09-23 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 67 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | idaspin |
| Maintainers | idaspin |
| Keywords | bad, word, words, profanity, filter, blacklist, black, list, swear, english, russian, мат, фильтр |

## Links

- npm: https://www.npmjs.com/package/automod-filter
- Repository: https://github.com/idaspin/automod-filter
- Homepage: https://github.com/idaspin/automod-filter#readme
- Issues: https://github.com/idaspin/automod-filter/issues
- npm.io page: https://npm.io/package/automod-filter

## Recent versions

- 1.0.1 (latest) — 2022-09-23
- 1.0.0 — 2022-09-23

## README

# automod-filter

A javascript filter for badwords

[![Build Status](https://travis-ci.com/idaspin/automod-filter.svg?branch=master)](https://travis-ci.com/idaspin/automod-filter)

## Installation

    npm install automod-filter --save

## Usage

```js
const { Automod } = require('automod-filter');

console.log(Automod.filter("What the fuck is going on here? Whore", { langs: [ Lang.ENGLISH ] })) // What the ████ is going on here? █████
```

### Options

```js
const { Automod, Lang, Method } = require('./lib/index.js');

console.log(Automod.filter("d@mn а я fuck не понял 6ля что вы shit делаете whore в холодильнике cуk@", { langs: [ Lang.ENGLISH ], method: Method.CLASSIC } ));
// {
//     input: 'd@mn а я fuck не понял 6ля что вы shit делаете whore в холодильнике cуk@',      
//     output: 'd@mn а я ████ не понял 6ля что вы ████ делаете █████ в холодильнике cуk@'
//     matches: [ 'fuck', 'Whore' ]
// }

console.log(Automod.filter("d@mn а я fuck не понял 6ля что вы shit делаете whore в холодильнике cуk@", { langs: [ Lang.ENGLISH, Lang.RUSSIAN ], method: Method.STRICT, replacer: "*" }));
// {
//     input: 'd@mn а я fuck не понял 6ля что вы shit делаете whore в холодильнике cуk@',      
//     output: '**** я **** не понял *** что вы **** делаете ***** в холодильнике ****',     
//     matches: [ 'd@mn', 'fuck', '6ля', 'shit', 'whore', 'cуk@' ]
// }
```

### TODO
- Regex search
- Fill English replacers
- URL parser

### Community

- Found a bug: [submit an issue.](https://github.com/idaspin/automod-filter/issues/new)
- Discussion and help about automod-filter: [🇷🇺 Discord Server](https://discord.gg/YeqrTtpmaH)

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