Swears
Note: This package already includes TypeScript types - no need to go find them.
What is this?
A basic package that includes:
-
swearWords
: string[] - An array of swear words taken from Google's big ol' list. -
cleanUpSwearyString
: Function - basic helper function (defintely not very performant) that takes in a string and replaces any rude words with something clean.
Install
With npm:
npm i swears
With yarn:
yarn add swears
Import
import { swearWords, cleanUpSwearyString } from "swears"
Usage
swearWords
- array of swears
import { swearWords } from "swears"
swearWords // ["list", "of", "swear", "words"]
cleanUpSwearyString
- replace swear words from a string
Note: this helper function uses loops and RegEx which comes at a performance cost, so use sparingly.
import { cleanUpSwearyString } from "swears"
// Default usage
cleanUpSwearyString("You son of a bitch")
// Result: "You son of a *****"
// Pass optional `wordToUseInstead`
cleanUpSwearyString("You son of a bitch", { wordToUseInstead: "fluff" })
// Result: "You son of a fluff"
Notes
Beware the S****horpe Problem.