@therohitdas/profanityjs

    0.1.2 • Public • Published

    Profanity JS

    Simple profanity filter and masker.

    Installation

    npm install @therohitdas/profanityjs

    Usage

    ProfanityJs comes with two functions:

    • containsProfanity(sentence, useHomoglyphSearch): This function takes two required arguments.

      • sentence can be a word/ sentence/ paragraph which you want to check.
      • useHomoglyphSearch should be set true for now. In the future, I will add a method to checkProfanity without using glyph and better search time.

      It returns true if the sentence contains at least one naughty word, false otherwise.

    const { containsProfanity } = require("@therohitdas/profanityjs");
    
    var testSentence = "Go fuck yourself!";
    
    if (containsProfanity(testSentence, true)) {
      console.log("Naughty word(s) detected");
    } else {
      console.log("Clean :)");
    }
    // Output -
    // Naughty word(s) detected
    • maskProfanity(sentence, mask): This function takes two arguments.

      • sentence can be a word/ sentence/ paragraph from which you want to check and mask the naughty word(s).
      • mask is the character with which you want to mask the naughty word. Default is "*".

      It returns the sentence with all the naughty words masked with the mask character. If there are no naughty words, it returns the input sentence unchanged.

    const { maskProfanity } = require("@therohitdas/profanityjs");
    
    var testSentence = "Go fuck yourself!";
    
    var maskedSentence = maskProfanity(testSentence);
    console.log(maskedSentence); // Output - Go **** yourself!
    
    maskedSentence = maskProfanity(testSentence, "#");
    console.log(maskedSentence); // Output - Go #### yourself!

    Contribution

    All contributions are welcome to improve this project.

    Install

    npm i @therohitdas/profanityjs

    DownloadsWeekly Downloads

    1

    Version

    0.1.2

    License

    CC-BY-4.0 License

    Unpacked Size

    74.2 kB

    Total Files

    6

    Last publish

    Collaborators

    • therohitdas