Skip to content

Commit dd2708e

Browse files
committed
Updating Readme file.
- Preparing to publish a new update.
1 parent 6e6444d commit dd2708e

File tree

2 files changed

+21
-2
lines changed

2 files changed

+21
-2
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,15 @@ Then you can use the available methods for different available validators:
1616
```javascript
1717
IRCheck.Phone.checkType('02191001848'); //returns 'LANDLINE'
1818
IRCheck.Phone.normalizeMobile('+989121234567'); // returns '9121234567'
19+
IRCheck.Postal.isPostalCodeValid('7634598734'); // returns 'TRUE'
20+
IRCheck.National.isNationalCodeValid('4721016352'); // returns 'TRUE'
1921
```
2022

2123
## Validators Availability
2224
Currently, the following validators are available:
2325
* [Iran Phone Numbers](#phone)
26+
* [Iran Postal](#postal)
27+
* [Iran National Codes](#national)
2428

2529
### Phone
2630
Here’s a list of available methods:
@@ -29,10 +33,25 @@ Here’s a list of available methods:
2933
* `isLandline(number)` Verify the input number is a type of landline
3034
* `normalizeMobile(number)` Normalize a mobile number as 9121234567
3135
* `normalizeLandline(number)` Normalize a landline number as 2191001848
32-
* `getProvinceData(number)` Get province info from its area code or code name
36+
* `getProvinceData(province {String|Number})` Get province info from its area code or code name
3337
* `getProvincesFromLandline(number)` Extract province data from a landline numbers
3438

39+
### Postal
40+
Here’s a list of available methods:
41+
* `isPostalCodeValid(postalCode {String})` Check if the entered postal code is valid
42+
43+
### National
44+
Here’s a list of available methods:
45+
* `isNationalCodeValid(nationalCode {String})` Check if the entered Iranian national code is valid
46+
47+
3548
## History
49+
### 0.3.0
50+
* Postal code validation has been added into the library.
51+
* National code validation has been added into the library.
52+
* Updating README.md file.
53+
* A few changes in the main file.
54+
3655
### 0.1.1
3756
* Fixing typo errors in README.md file.
3857

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "ircheck",
3-
"version": "0.1.1",
3+
"version": "0.3.0",
44
"description": "Node.js validation library for Iranian developers",
55
"main": "index.js",
66
"scripts": {

0 commit comments

Comments
 (0)