README.md

#  email-password-validator

A lightweight TypeScript-based package for validating **emails, passwords, names, and custom fields** in real-time.  
Designed for use in **Node.js** and **frontend frameworks** like React, Vue, or Angular.

---

##  Installation

```bash
npm install email-password-validator

🔧 Usage

Email Validation

import { validateEmail } from "email-password-validator";

console.log(validateEmail("[email protected]"));
// { valid: true }

console.log(validateEmail("wrong-email"));
// { valid: false, error: "The provided email is an invalid email format" }

Password Validation

import { validatePassword } from "email-password-validator";

console.log(validatePassword("MyP@ssw0rd"));
// { valid: true, errors: [] }

console.log(validatePassword("weak"));
// { valid: false, errors: ["Password must be at least 8 characters", "At least one uppercase letter required", ...] }

Custom rules:

validatePassword("password123", { minLength: 6, requireSpecialChar: false });
// { valid: true, errors: [] }

Name Validation

import { validateName } from "email-password-validator";

console.log(validateName("John Doe"));
// { valid: true }

console.log(validateName("J1"));
// { valid: false, error: "Name can only contain letters and spaces" }

Custom Validation

import { validateCustom } from "email-password-validator";

// Username validator: letters, numbers, underscores, 3–15 chars
const usernameCheck = validateCustom(
  "user_123",
  (val) => /^[a-zA-Z0-9_]{3,15}$/.test(val),
  "Username must be 3-15 characters, letters/numbers/underscore only"
);

console.log(usernameCheck);
// { valid: true }

Testing

This package comes with Jest tests. Run:

npm test

Features

• 1. Email validation (basic RFC-compliant format)
• 2. Password validation (configurable rules: length, numbers, uppercase, special chars)
• 3. Name validation (letters + spaces, min/max length)
• 4. Custom validation (use your own regex or function)
• 5. TypeScript support (auto-complete & type safety)

Example (React Form)

import React, { useState } from "react";
import { validateEmail, validatePassword, validateName } from "email-password-validator";

export default function ExampleForm() {
  const [email, setEmail] = useState("");
  const [password, setPassword] = useState("");

  const emailResult = validateEmail(email);
  const passwordResult = validatePassword(password);

  return (
    <div>
      <input value={email} onChange={(e) => setEmail(e.target.value)} placeholder="Email" />
      {!emailResult.valid && <p style={{ color: "red" }}>{emailResult.error}</p>}

      <input type="password" value={password} onChange={(e) => setPassword(e.target.value)} placeholder="Password" />
      {!passwordResult.valid && (
        <ul style={{ color: "red" }}>
          {passwordResult.errors.map((err, i) => <li key={i}>{err}</li>)}
        </ul>
      )}
    </div>
  );
}

License

MIT © 2025 [ENIGMA]