Tunisian Bad Words Filter

This TypeScript library, Tunisian Bad Words Filter, is designed to help maintain a more respectful and inclusive environment in applications by filtering out Tunisian bad words from text.

Installation

To integrate the library, install it using your preferred package manager:

Yarn

yarn add tunisian-badwords-filter

Npm

npm install tunisian-badwords-filter

Pnpm

pnpm add tunisian-badwords-filter

Usage

Use the filterBadWords function to replace potential bad words in input text with ****. Below is an example usage:

// Import the filterBadWords function from the library
import { filterBadWords } from 'tunisian-badwords-filter';

// Example text containing a Tunisian bad word
const inputText = 'This is a bad word: zebi';

// Use the filterBadWords function to filter out bad words
const filteredText = filterBadWords(inputText);

// Display the original and filtered text
console.log('Original Text:', inputText);
console.log('Filtered Text:', filteredText);

The provided API documentation and this example usage demonstrate the straightforward implementation of the library. Contributions are welcome, and the project is licensed under the MIT License. Feel free to explore and enhance this library!