badwords-js-detector

The badwords-js-detector library exported as Node.js modules.

Installation

Using npm:

1$ npm i badwords-js-detector

Using CDN:

1<script src="https://cdn.jsdelivr.net/gh/aldrin112602/badwords-js-detector/badwords-js-detector.js"></script>

Importing:

1// CJS
2const { Detector } = require('badwords-js-detector');
3const badwords = new Detector();
4
5// ESM
6import { Detector } from 'badwords-js-detector';
7const badwords = new Detector();
8
9// CDN
10const badwords = new Detector();

Usage:

1const response = badwords.filter('Hello fuck you...');
2console.log(response); 
3
4/*
5Expected output:
6
7{
8    bad-words-list: [
9        'fuck'
10    ],
11    bad-words-total: 1,
12    censor-character: '*',
13    content: 'Hello fuck you...',
14    content-filtered: 'Hello **** you...'
15}
16
17*/
18
19// You can customized censor-character
20const badwords = new Detector({ placeholder: '@' });
21const response = badwords.filter('Hello fuck you...');
22console.log(response); 
23
24/*
25Expected output:
26
27{
28    bad-words-list: [
29        'fuck'
30    ],
31    bad-words-total: 1,
32    censor-character: '@',
33    content: 'Hello fuck you...',
34    content-filtered: 'Hello @@@@ you...'
35}
36
37*/

Developed with ❤️ by Aldrin Caballero