Package Exports

textspace
textspace/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (textspace) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Text Censor Package (textspace)

Censor your text with textspace package. It is a simple package to censor your text. Quick example: latefrul@gmail.com => l******l@gmail.com

Installation

npm install textspace

Usage

// Censor email address
const { emailCensor,censor } = require('textspace');

const emailCensorValue = emailCensor({email:'yourmail@gmail.com'})
// => Output = y******l@gmail.com

// Censor any text
const censorValue = censor({text:'emresengul',censorCharacter:'*'})
// => Output = e********l

All Functions

Functions	Args	Usage	Output
emailCensor	`{email,censorCharacter,splitter}`	`emailCensor({email:'email@gmail.com'})`	`e***l@gmail.com`
randomCensor	`{text,size,censorCharacter}`	`randomCensor({text:'randomword',size:5})`	`anomod`
censor	`{text,censorCharacter}`	`censor({text:'censor character'})`	`c**************r`
censorWithIndexes	`{text,indexes,censorCharacter}`	`censorWithIndexes({text:'emre',indexes:[0,1]})`	`**re`
censorDefinedText	`{text,definedText,censorCharacter}`	`censorDefinedText({text:'emresengul',definedText:'emre'})`	`****sengul`

Todo

Write unit test
Add new functions
- Censor first N Character
- Censor last N character

In Progress

Nothing yet.

Done ✓

Update README.md file
Add examples
Create documentation for package