Updated README and added interface for function parameters

Author: arghyadeep-k

README.md

@@ -1 +1,90 @@
-# deno-password-checker
+# Password Checker
+
+A Deno module to test if a password/string matches the preset criteria.
+
+## Installation
+
+`import { checkPassword } from "https://deno.land/x/password-checker/mods.ts";`
+
+## Parameters
+
+### Mandatory Parameters:
+
+- password: string
+
+### Optional Parameters:
+
+- minLen: number - To check the password against a minimum length. Defaults to 0
+  which disables the check.
+- maxLen: number - To check the password against a maximum length. Defaults to 0
+  which disables the check.
+- containsNum: boolean - To check if the password contains any numbers. Defaults
+  to true and enables the check.
+- containsSpecialChar: boolean - To check if the password contains any special
+  characters. Defaults to true and enables the check.
+- containsAlphabet: boolean - To check if the password contains any alphabets.
+  Defaults to true and enables the check.
+
+## Usage
+
+```typescript
+import { checkPassword } from "https://deno.land/x/password-checker/mods.ts";
+
+const passwordString: string = "randomPassword123!.";
+
+let isPasswordValid: boolean;
+
+// Default case which checks if password is alphanumeric and contains special characters
+isPasswordValid = checkPassword({ password: passWordString });
+
+// To set minimum length of password
+isPasswordValid = checkPassword({ password: passwordString, minLen: 5 });
+
+// To set maximum length of password
+isPasswordValid = checkPassword({
+  password: passwordString,
+  minLen: 5,
+  maxLen: 12,
+});
+
+// To disable number check on password
+isPasswordValid = checkPassword({
+  password: passwordString,
+  containsNum: false,
+});
+
+// To disable alphanumeric check on password
+isPasswordValid = checkPassword({
+  password: passwordString,
+  containsNum: false,
+  containsAlphabet: false,
+});
+
+// To disable special characters check on password
+isPasswordValid = checkPassword({
+  password: passwordString,
+  containsSpecialChar: false,
+});
+```
+
+## License
+
+This package is published under the Unlicense. For more information, see the
+accompanying LICENSE file.
+
+<br>
+
+---
+
+<br>
+
+### PS:
+
+If you find this package useful, please consider giving a
+[star](https://github.com/arghyadeep-k/deno-password-checker) to this project on
+Github.
+
+And, if you are willing to [buy me a coffee](https://ko-fi.com/arghyadeep), that
+would be awesome. :)
+
+<a href='https://ko-fi.com/arghyadeep' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://cdn.ko-fi.com/cdn/kofi1.png?v=2' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>

mod.ts

@@ -1,11 +1,19 @@
-export function checkPassword(
-  password: string,
+interface params {
+  password: string;
+  minLen?: number;
+  maxLen?: number;
+  containsNum?: boolean;
+  containsSpecialChar?: boolean;
+  containsAlphabet?: boolean;
+}
+export function checkPassword({
+  password,
   minLen = 0,
   maxLen = 0,
-  containsNum = false,
-  containsSpecialChar = false,
-  containsAlphabets = false,
-): boolean {
+  containsNum = true,
+  containsSpecialChar = true,
+  containsAlphabet = true,
+}: params): boolean {
   if (minLen != 0) {
     if (password.length < minLen) {
       return false;
@@ -26,7 +34,7 @@ export function checkPassword(
       return false;
     }
   }
-  if (containsAlphabets) {
+  if (containsAlphabet) {
     if (password.search(/[A-Za-z]/) == -1) {
       return false;
     }

mod_test.ts

@@ -2,29 +2,69 @@ import { assertEquals } from "./test_deps.ts";
 import { checkPassword } from "./mod.ts";
 
 Deno.test("Test with defaults", () => {
-  assertEquals(checkPassword("random"), true);
+  assertEquals(checkPassword({ password: "random123." }), true);
 });
 
 Deno.test("Test for minimum length", () => {
-  assertEquals(checkPassword("random123", 10), false);
+  assertEquals(checkPassword({ password: "random123", minLen: 10 }), false);
 });
 
 Deno.test("Test for maximum length", () => {
-  assertEquals(checkPassword("random123", 2, 5), false);
+  assertEquals(
+    checkPassword({ password: "random123", minLen: 2, maxLen: 5 }),
+    false,
+  );
 });
 
 Deno.test("Test for numbers", () => {
-  assertEquals(checkPassword("random", 2, 10, true), false);
+  assertEquals(
+    checkPassword({
+      password: "random",
+      minLen: 2,
+      maxLen: 10,
+      containsNum: true,
+    }),
+    false,
+  );
 });
 
 Deno.test("Test for special characters", () => {
-  assertEquals(checkPassword("random123", 2, 10, true, true), false);
+  assertEquals(
+    checkPassword({
+      password: "random123",
+      minLen: 2,
+      maxLen: 10,
+      containsNum: true,
+      containsSpecialChar: true,
+    }),
+    false,
+  );
 });
 
 Deno.test("Test for alphabets", () => {
-  assertEquals(checkPassword("123456.!", 2, 10, true, true, true), false);
+  assertEquals(
+    checkPassword({
+      password: "123456.!",
+      minLen: 2,
+      maxLen: 10,
+      containsNum: true,
+      containsSpecialChar: true,
+      containsAlphabet: true,
+    }),
+    false,
+  );
 });
 
 Deno.test("Test for all options", () => {
-  assertEquals(checkPassword("abc123456.!", 2, 12, true, true, true), true);
+  assertEquals(
+    checkPassword({
+      password: "abc123456.!",
+      minLen: 2,
+      maxLen: 12,
+      containsNum: true,
+      containsSpecialChar: true,
+      containsAlphabet: true,
+    }),
+    true,
+  );
 });