https://github.com/selvin-paul-raj/spr-censorify

https://github.com/selvin-paul-raj/spr-censorify

custom-npm-package custom-package nodejs npm npm-package

Last synced: 29 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/selvin-paul-raj/spr-censorify
• Owner: selvin-paul-raj
• License: mit
• Created: 2023-08-15T04:35:39.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-08-30T16:07:25.000Z (over 1 year ago)
• Last Synced: 2024-11-29T21:17:09.672Z (about 2 months ago)
• Topics: custom-npm-package, custom-package, nodejs, npm, npm-package
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/spr-censorify
• Size: 9.77 KB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
SPRHackz-Censority


# CustomCensorify

A JavaScript module for efficient text censorship. Replace sensitive words with asterisks in an easy and effective manner.

## Installation

```sh

npm install sprhackz-censorify

```

# Usage

```sh

// To Install package `npm i sprhackz-censorify`

var censor = require("sprhackz-censorify"); // To Import The Package

console.log("\n PreDefine  Censored Words : ");

console.log(censor.getCensoredWords());

// Censor a sample text

console.log(`\n ${censor.censor("Some very sad, bad and mad text.")}`);

// Add a custom censored word

console.log("\n To Add a Custom Censored Word :");

censor.addCensoredWord("gloomy");

// Output the updated list of censored words

console.log(censor.getCensoredWords());

// Censor another sample text

console.log(`\n ${censor.censor("A very gloomy day.")} \n`);

```

## Authors

- **Selvin PaulRaj k** - _Initial work_ - [SPR Hackz](https://github.com/SPRHackz)