New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Feat iranian postal code #340
base: master
Are you sure you want to change the base?
Feat iranian postal code #340
Conversation
Thanks for your contribution, we are reviewing |
> this function validate entry postal code and return boolean for validation confirm | ||
|
||
```js | ||
import { iranianPostalCodeValidate } from "@persian-tools/persian-tools"; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rename to validateIranianPostalCode
|
||
**Usage** | ||
|
||
> this function validate entry postal code and return boolean for validation confirm |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Replace with This function validates the entry postal code and returns a boolean for validation confirmation.
/** | ||
* iranianPostalCodeValidate | ||
* | ||
* @description Takes a postal code and validate with return a boolean. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add
@returns boolean
and explain the algorithms you've implemented.
feat: add iranian postal code validation function