LeoProfanity

Methods

(static) add(data)

Source:

• index.js, line 281

Example

// add word
filter.add('b00b');

// add word's array
// check duplication automatically
filter.add(['b00b', 'b@@b']);

Parameters:

(static) badWordsUsed(str) → {Array.string}

Source:

• index.js, line 262

Example

// should return original string if string not contain profanity word
// output: []
filter.badWordsUsed('I have 2 eyes')

// should found profanity word
// output: ['zoophilia']
filter.badWordsUsed('lorem zoophilia ipsum')

// should detect case sensitive
// output: ['BoOb']
filter.badWordsUsed('I have BoOb')

// should detect multi occurrence
// output: ['boob', 'boob', 'ass']
filter.badWordsUsed('I have boob,boob, ass, and etc.')

// should not detect unspaced-word
// output: []
filter.badWordsUsed('Buy classic watches online')

// should detect multi-length-space and multi-space
// output: ['BoOb']
filter.badWordsUsed(',I h  a.   v e BoOb.')

Parameters:

Returns:

Type

Array.string

(static) check(str) → {boolean}

Source:

• index.js, line 120

See:

• http://stackoverflow.com/questions/26425637/javascript-split-string-with-white-space
• http://stackoverflow.com/questions/6116474/how-to-find-if-an-array-contains-a-specific-string-in-javascript-jquery
• http://stackoverflow.com/questions/9141951/splitting-string-by-whitespace-without-empty-elements

Example

// output: true
filter.check('I have boob');

Parameters:

Returns:

Type

boolean

(static) clean(str, replaceKeyopt, nbLettersopt) → {string}

Source:

• index.js, line 223

Example

// no bad word
// output: I have 2 eyes
filter.clean('I have 2 eyes');

// normal case
// output: I have ****, etc.
filter.clean('I have boob, etc.');

// case sensitive
// output: I have ****
filter.clean('I have BoOb');

// separated by comma and dot
// output: I have ****.
filter.clean('I have BoOb.');

// multi occurrence
// output: I have ****,****, ***, and etc.
filter.clean('I have boob,boob, ass, and etc.');

// should not detect unspaced-word
// output: Buy classic watches online
filter.clean('Buy classic watches online');

// clean with custom replacement-character
// output: I have ++++
filter.clean('I have boob', '+');

// support "clear letter" in the beginning of the word
// output: I have bo++
filter.clean('I have boob', '+', 2);

Parameters:

Returns:

Type

string

(static) clearList()

Source:

• index.js, line 338

(static) getDictionary(nameopt) → {Array.string}

Source:

• index.js, line 358

Example

// returns words in en dictionary
filter.getDictionary();

// returns words in fr dictionary
filter.getDictionary('fr');

Parameters:

Returns:

Type

Array.string

(static) list() → {Array.string}

Source:

• index.js, line 100

Example

filter.list();

Returns:

Type

Array.string

(static) loadDictionary(nameopt)

Source:

• index.js, line 388

Example

// replace current dictionary with the french one
filter.loadDictionary('fr');

// replace dictionary with the default one (same as filter.reset())
filter.loadDictionary();

Parameters:

(static) remove(data)

Source:

• index.js, line 308

Example

// remove word
filter.remove('b00b');

// remove word's array
filter.remove(['b00b', 'b@@b']);

Parameters:

(static) reset()

Source:

• index.js, line 328