Feat iranian postal code

README.md

@@ -37,6 +37,7 @@
 -   [Get the Remaining Time of the Date](#get-the-remaining-time-of-the-date)
 -   [Validate and find information of phone number](#validate-and-find-information-of-phone-number).
 -   [Find capital city by province name ](#find-capital-city-by-province-name)
+-   [Validate Iranian Postal code](#validate-iranian-postal-code).
 
 ## Getting started
 
@@ -558,6 +559,23 @@ findCapitalByProvince("آذربایجان شرقی"); // تبریز
 findCapitalByProvince("دبی");
 ```
 
+### Validate Iranian Postal code
+
+**Usage**
+
+> this function validate entry postal code and return boolean for validation confirm
+
+```js
+import { iranianPostalCodeValidate } from "@persian-tools/persian-tools";
+
+// valid postal code
+iranianPostalCodeValidate("1193653471"); // true
+
+// invalid postal code
+iranianPostalCodeValidate("142386473"); // false
+iranianPostalCodeValidate("1111111111"); // false
+```
+
 ### Todo
 
 -   [ ] Write Jalaali and Gregorian functions to convert Date together.

src/index.ts

@@ -56,3 +56,6 @@ export { default as remainingTime } from "./modules/remainingTime";
 //Find capital city by state name
 
 export { default as findCapitalByProvince } from "./modules/findCapitalByProvince";
+
+//iranian postal code validation
+export { default as iranianPostalCodeValidate } from './modules/iranianPostalCode'

src/modules/iranianPostalCode/index.ts

@@ -0,0 +1,27 @@
+
+/**
+ * iranianPostalCodeValidate
+ *
+ * @description Takes a postal code and validate with return a boolean.
+ *
+ *
+ * @param postalCode as string
+ * @return if postal code is valid return true , but if postal code is not valid return false
+ */
+const iranianPostalCodeValidate = (postalCode: string = ""): boolean => {
+    const pc = postalCode.toString();
+    if (/\D/g.test(pc)) return false;
+
+    return (
+      pc.length === 10 &&
+      !pc.slice(0, 5).includes("2") &&
+      !pc.slice(0, 5).includes("0") &&
+      pc[4] !== "5" &&
+      pc[5] !== "0" &&
+      pc.slice(-4) !== "0000" &&
+      !pc.split("").every((char) => char === pc[0])
+    );
+}
+
+
+export default iranianPostalCodeValidate

test/iranianPostalCode.spec.ts

@@ -0,0 +1,23 @@
+import { iranianPostalCodeValidate } from "../src";
+import { describe, it, expect } from "vitest";
+
+const validPostalCode = "1193653471"
+const invalidPostalCodes = [
+    '142386473',
+    '12',
+    '1111111111',
+    '0423437584',
+    "test invalid postalCode"
+]
+
+describe("iranianPostalCode", () => {
+    it('valid postal code', () => {
+        expect(iranianPostalCodeValidate(validPostalCode)).toBeTruthy()
+    })
+
+    it('invalid postal codes', () => {
+        invalidPostalCodes.forEach((invalidPostalCode) => {
+            expect(iranianPostalCodeValidate(invalidPostalCode)).toBeFalsy()
+        })
+    })
+});