README
redact
Censors blacklisted words with built in lists of words that can be used.
Table of Contents
Installation
This library is available through the npm registry.
NPM
$ npm -i @princedev/redact
Yarn
$ yarn add @princedev/redact
Import
Start using it by importing the library first.
CommonJS
const redact = require('@princedev/redact');
ES6
import { redact } from '@princedev/redact';
Usage
Redact or censor a word from a sentence
import { redact } from '@princedev/redact';
const englishProfanity = ['fuck', 'shit', ...];
redact('Fuck yeah', englishProfanity,);
// output: **** yeah
redact('Fuck yeah', englishProfanity, {
grawlix: '