greek-swearword-filter v1.0.2

greek-swearword-filter

• Βιβλιοθήκη JavaScript για φιλτράρισμα βρισιών στα ελληνικά.
• JavaScript library to filter Greek swear words

Installation

npm install greek-swearword-filter

Usage

Setting Up the Filter

Create an instance of the GreekFilter class:

const GreekFilter = require('greek-swearword-filter');

const filter = new GreekFilter(); 
filter.filter("Σκατά στα μούτρα σου ρε σούργελο!");
// ***** στα μούτρα σου ρε ********!

OR

import GreekFilter from 'greek-swearword-filter';

const filter = new GreekFilter();
filter.filter("Σκατά στα μούτρα σου ρε σούργελο!");
// ***** στα μούτρα σου ρε ********!

You're also able to create a filter instance with a specific placeholder and default filter style

const filter = new GreekFilter({ placeholder: '*', filterStyle: 'all' });

Placeholder

The placeholder is the character used to mask the filtered words:

const filter = new GreekFilter();

filter.placeholder =  '-';
filter.filter("Είναι μεγάλο αρχίδι ο προϊστάμενος.");
// Είναι μεγάλο ------ ο προϊστάμενος.

filter.placeholder =  'x';
filter.filter("Είναι μεγάλο αρχίδι ο προϊστάμενος.");
// Είναι μεγάλο xxxxxx ο προϊστάμενος.

Style

The filtering style determines how the words will be masked. Supported styles include:

• 'all': Masks the entire word.
• 'first': Masks all characters except the first one.
• 'firstlast': Masks all characters except the first and last one.

You can specify the style:

const filter = new GreekFilter();

filter.filter("μαλάκας") // *******
filter.filter("μαλάκας", style = 'all') // *******
filter.filter("μαλάκας", style = 'first') // μ******
filter.filter("μαλάκας", style = 'firstlast') // μ*****ς

// You can simply pass the style as the second parameter
filter.filter("μαλάκας", 'firstlast') // μ*****ς

Add your word/words to the list

Add words to the filter list. You can add a single word or multiple words at once using a list:

// Adding a single word
filter.filter("μηλο"); // μηλο

filter.addWords("μηλο");

filter.filter("μηλο"); // ****


// Adding multiple words
filter.filter("λεμονι, πορτοκαλι, πεπονι"); // λεμονι, πορτοκαλι, πεπονι

filter.addWords(["λεμονι",  "πορτοκαλι",  "πεπονι"]);

filter.filter("λεμονι, πορτοκαλι, πεπονι"); // ******, *********, ******

Remove any word/words you want from the list

Remove words from the filter list. Similar to adding words, you can remove a single word or multiple words using a list:

// Removing a single word
filter.removeWords("Σκατά")

filter.filter("Σκατά στα μούτρα σου ρε σούργελο!"); // Σκατά στα μούτρα σου ρε ********!


// Removing multiple words
filter.removeWords(["Σκατά",  "σούργελο"])

filter.filter("Σκατά στα μούτρα σου ρε σούργελο!"); // Σκατά στα μούτρα σου ρε σούργελο!

API

The GreekFilter class offers various methods for text filtering. Below are detailed descriptions of its main methods:

Constructor

GreekFilter(options)

• Description: Creates an instance of the GreekFilter class.
• Parameters:
  • options: Object, specifying the filtering options.
    • placeholder: String (optional), the character used to replace filtered words.
    • filterStyle: String (optional), the default style of filtering ('all', 'first', 'firstlast').
• Usage:

const filter = new GreekFilter({ placeholder: '*', filteringStyle: 'all' });

Methods

addWords(words)

• Description: Adds words to the filtering list.
• Parameters:
  • words: String or array of strings, the words to be filtered. For adding multiple words, an array of strings must be used.
• Usage:

// Adding a single word
filter.addWords("badword");
filter.addWords(["badword"]);

// Adding multiple words
filter.addWords(["badword1", "badword2", "badword3"]);

removeWords(words)

• Description: Removes words from the filtering list.
• Parameters:
  • words: String or array of strings, the words to be removed. For removing multiple words, an array of strings must be used.
• Usage:

// Removing a single word
filter.removeWords("badword");
filter.removeWords(["badword"]);

// Removing multiple words
filter.removeWords(["badword1", "badword2", "badword3"]);

filter(text, style)

• Description: Filters the given text according to the specified style.
• Parameters:
  • text: String, the text to be filtered.
  • style: String (optional), the style of filtering ('all', 'first', 'ends').
• Usage:

const filteredText = filter.filter("This is a test sentence.", 'first');

replaceWord(word, style)

• Description: Filters an individual word according to the specified style.
• Parameters:
  • word: String, the word to be filtered.
  • style: String, the style of filtering.
• Usage:

const maskedWord = filter.replaceWord("badword", 'ends');

License

This project is provided under the MIT License.