Skip to content

Latest commit

 

History

History
40 lines (24 loc) · 932 Bytes

README.md

File metadata and controls

40 lines (24 loc) · 932 Bytes

GitHub Workflow Status (branch) npm

adults

A simple JavaScript / TypeScript library to detect bad words. Use it with your custom list of bad words.

Installation

npm install adults

Usage

// TypeScript Usage
import { addWords, isBad } from 'adults';

// JavaScript Usage
const { addWords, isBad} = require('adults');

addWords('some', 'custom', 'word'); // add your list of custom words here

const isBadWord = isBad('This is a sample xxx content', 'Some more custom word content here');

console.log(isBadWord);

// OUTPUT true

const isItBad = isBad('Hey StackBlogger!');

console.log(isItBad);

// OUTPUT false

License

MIT