lets-validate-username 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,63 @@
+# **Username Validator Tool**
+
+A lightweight and easy-to-use npm package to validate usernames based on configurable rules. This tool checks for length, allowed characters, and uniqueness, making it perfect for user registration systems.
+
+---
+
+## **Features**
+- ✅ Validate username length (default: 3-15 characters).  
+- ✅ Ensure usernames contain only letters, numbers, and underscores (`_`).  
+- ✅ Check if a username is already taken.  
+- ✅ Detailed validation messages for better user feedback.
+
+---
+
+## **Installation**
+
+Install the package via npm:
+
+```bash
+npm install username-validator-tool
+```
+## **API**
+
+### `validateUsername(username, existingUsernames)`
+
+**Parameters**:
+- `username` (string): The username to validate.  
+- `existingUsernames` (array): List of existing usernames to check for uniqueness.
+
+**Returns**:
+An object with the following structure:
+```
+  valid: Boolean, // true if valid, false if invalid
+  message: String, // Success message (if valid)
+  errors: Array    // List of error messages (if invalid)
+```
+
+### **Examples**
+
+#### 1. Valid Username
+```
+validateUsername('valid_user', ['john_doe', 'jane123']);
+// Output:
+// { valid: true, message: 'Username is valid!' }
+```
+
+#### 2. Username too Short
+````
+Output:
+// { valid: false, errors: ['Username must be between 3 and 15 characters.'] }
+````
+
+#### 3. Invalid Characters
+```validateUsername('invalid@name', []);
+// Output:
+// { valid: false, errors: ['Username can only contain letters, numbers, and underscores.'] }
+```
+#### 4. Username Already Taken
+```
+validateUsername('john_doe', ['john_doe', 'jane123']);
+// Output:
+// { valid: false, errors: ['Username is already taken.'] }
+```

package/package.json

@@ -1,12 +1,17 @@
 {
-  "name": "lets-validate-username", 
-  "version": "1.0.0",
+  "name": "lets-validate-username",
+  "version": "1.0.1",
   "description": "A simple npm package to validate usernames based on length, allowed characters, and uniqueness.",
   "main": "index.js",
   "scripts": {
     "test": "node test.js"
   },
-  "keywords": ["username", "validator", "npm-package", "validation"],
-  "author": "Zoha", 
+  "keywords": [
+    "username",
+    "validator",
+    "npm-package",
+    "validation"
+  ],
+  "author": "Zoha",
   "license": "MIT"
 }