feat: add methods definition and test unsing string with numbers

src/data/dictionary.ts

@@ -97,6 +97,8 @@ export default {
       'Fukkin',
       'g00k',
       'God-damned',
+      'Handjob',
+      'H4ndjob',
       'h00r',
       'h0ar',
       'h0re',
@@ -595,6 +597,8 @@ export default {
       'Iscrota',
       'Iscroto',
       'Japa',
+      'Lesbian',
+      'L3sbi4n',
       'Ladra',
       'Ladrao',
       'Ladroeira',

src/index.ts

@@ -76,7 +76,7 @@ export class Profanity {
   }
 
   /**
-   * Censure a word with placeHolder characters;
+   * Censure a word with placeHolder characters.
    * @param {any} word - String to censure.
    * @public
    */
@@ -153,13 +153,23 @@ export class Profanity {
     return '';
   }
 
+  /**
+   * Add word(s) to wordlist filter.
+   * @param {...string} words - Word(s) to add to wordlist.
+   * @public
+   */
   addWords(...words: string[]) {
     if (words.length === 0)
       console.error('Unexpected error: need at last one word');
     this.wordlist?.push(...words);
     return this;
   }
 
+  /**
+   * Remove word(s) to wordlist filter.
+   * @param {...string} words - Word(s) to be removed from wordlist.
+   * @public
+   */
   removeWords(...words: string[]) {
     if (words.length === 0)
       console.error('Unexpected error: need at last one word to remove');

test/unit/isProfane.test.ts

@@ -19,11 +19,11 @@ describe('isProfane tests', () => {
     assert(profanity.isProfane('You\'re an asshole^ you are'));
   });
 
-  it('should return true if detect profrane words with type case', () => {
+  it('should return true if detect profrane words and numberswith', () => {
     const profanity = new Profanity('', {
       language: 'en-us',
     });
 
-    assert(profanity.isProfane('FuCk'));
+    assert(profanity.isProfane('That l3sbi4n did a very good H4ndjob.'));
   });
 });