ArunGovil / sanitize-js

RFC822 based email sanitization in JavaScript

sanitize-js

🧹 RFC822 based email sanitization in Javascript.

---

Installation

Using npm

npm i @arungovil/sanitize-js

Using Yarn

yarn add @arungovil/sanitize-js

Usage

import { sanitize } from "@arungovil/sanitize-js";

const email = "arun(🐞)[e-mail]";

const sanitizedEmail = sanitize(email);

Result

❌ Before
arun(🐞)[e-mail] 

✅ After
[e-mail] 

Parameters

Name	Type	Required	Description
Email	string	true	Email string to sanitize
options	object	false	Additional options

Options

Name	Type	Required	Description
customRegex	regex	false	Regex to strip out custom patterns
isNormalString	boolean	false	To sanitize non email inputs

Examples

Using custom regex

Pass a custom regex to strip out matching characters.

import { sanitize } from "@arungovil/sanitize-js";

const email = "arun(🐞)[e-mail]";
const myRegex = /#/g; // regex to strip out #

const sanitizedEmail = sanitize(email, { customRegex: myRegex  });

Result

❌ Before
arun#[e-mail] 

✅ After
[e-mail] 

Sanitize non email strings

To sanitize only the username of an email or a random string

import { sanitize } from "@arungovil/sanitize-js";

const userName = "arun(🐞)govil";

const sanitizedUserName = sanitize(userName, { isNormalString: true  });

Result

❌ Before
arun(🐞)govil

✅ After
arungovil 

Note

Sanitize-js is used for email sanitization, if you are looking for an email validator use validator.js