Check sentences for blacklisted word

You can check if a given string/sentence has a blacklisted word in it.

Syntax

isBlacklisted(string: string, ...args: string[]): boolean

string: string - Given string/sentence to be checked.

blacklist: string[] - Blacklist

boolean - Returns true if it has a blacklisted word, otherwise false.

Throws an error if the required parameters are not given to the function.

import { isBlacklisted } from '@princedev/redact';

Basic usage with a blacklisted word.

const racialBlacklist = blacklist('nigga', 'eskimo');
const result = isBlacklisted('Wassup my nigga', racialBlacklist);

result would be true.

Basic usage with no blacklisted word.

const racialBlacklist = blacklist('nigga', 'eskimo');
const result = isBlacklisted('Wassup my friend', racialBlacklist);

result would be false.