A lightweight npm package providing two essential utilities:
- Email validation with comprehensive format checks.
- Secure and customizable random password generation.
- Supports standard email formats:
- Basic:
user@example.com - With dots:
user.name@example.com - With plus:
user+tag@example.com - With plus and dots:
user.name+tag@example.com - With special characters:
user-name_123@sub.example.com
- Basic:
- Detects invalid formats such as:
- Consecutive dots:
user..name@example.com - Dot at start/end:
.user@example.comoruser.@example.com - Invalid characters:
user*name@example.com - Missing parts:
user@.comor@example.com
- Consecutive dots:
- Validation rules:
- Local part: Allows alphanumeric, dots, underscores, hyphens, plus signs.
- Prevents dots at the start/end or consecutive dots.
- Allows plus signs after the first character.
- Domain: Allows alphanumeric, dots, hyphens.
- TLD: Requires at least 2 alphabetic characters.
- Generates secure random passwords.
- Customizable options:
- Include numbers.
- Include special characters.
- Include alphabets (uppercase and lowercase).
- Default password length: 8 characters.
- Ensures inclusion of at least one character set if specified.
Install the package using npm:
npm install @wandering/emailpasswordimport { isValidEmail, randomPasswordGenerator } from '@wandering/emailpassword';const isValidEmail = isValidEmail('example@example.com');
if (isValidEmail) {
console.log('Valid email address');
} else {
console.log('Invalid email address');
}const password = randomPasswordGenerator(12, {
numbers: true,
special: true,
alphabets: true
});
console.log(`Generated Password: ${password}`);Validates if the provided email follows standard email formatting rules.
Generates a random password with the specified length and character set options.
- Parameters:
length(number): Length of the password (default: 8).options(Object):numbers(boolean): Include numbers (default: true).special(boolean): Include special characters (!@#$%^&*()_+-=[]{}|;:,.<>?) (default: true).alphabets(boolean): Include alphabets (default: true).
Here is an example demonstrating both utilities:
import { isValidEmail, randomPasswordGenerator } from '@wandering/emailpassword';
// Validate an email
const email = 'user@example.com';
if (!isValidEmail(email)) {
console.log('Invalid email address');
} else {
console.log('Valid email address');
}
// Generate a random password
const password = randomPasswordGenerator(10, {
numbers: true,
special: true,
alphabets: true
});
console.log(`Generated Password: ${password}`);Contributions are welcome! Feel free to submit issues or pull requests to improve this package.
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Commit your changes and push to your fork.
- Submit a pull request.
This project is licensed under the MIT License. See the LICENSE file for details.
For any questions or feedback, feel free to contact:
- Author: Saanvi Lakhanpal
- GitHub: https://github.com/Saanvi26
Thank you for using emailpassword. We hope it simplifies your development process!