Initial commit.

Author: jmosawy

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{json,gitignore}]
+insert_final_newline = false

.eslintrc.json

@@ -0,0 +1,3 @@
+{
+    "extends": "airbnb-base"
+}

.gitignore

@@ -0,0 +1 @@
+node_modules/

LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2017 Jeff Mosawy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,43 @@
+# IRCHECK
+IRCHECK is a Node.js validation library developed for Iranian developers in order to help them to do some validations on their specific national data.
+
+## Install & Usage
+You can install the package via the following command:
+`npm install ircheck`
+
+### Usage
+First you need to import the package:
+```javascript
+const IRCheck = require('ircheck');
+```
+
+Then you can use the available methods for different available validators:
+```javascript
+IRCheck.Phone.checkType('02191001848'); //returns 'LANDLINE'
+IRCheck.Phone.normalizeMobile('+989121234567'); // returns '91234567'
+```
+
+## Validators Availability
+Currently, the following validators are available:
+* [Iranian Phone Numbers](#phone)
+
+### Phone
+Here’s a list of available methods:
+* `checkType(number)`  Check whether if a number is a type of mobile or landline
+* `isMobile(number)` Verify the input number is a type of mobile
+* `isLandline(number)` Verify the input number is a type of landline
+* `normalizeMobile(number)`  Normalize a mobile number as 9121234567
+* `normalizeLandline(number)` Normalize a landline number as 2191001848
+* `getProvinceData(number)` Get province info from its area code or code name
+* `getProvincesFromLandline(number)` Extract province data from a landline numbers
+
+## History
+### 0.1.0
+* Initial release
+
+## Contribution
+Any contribution is much appreciated. Make sure that you write and run tests before submitting PR.
+
+## License
+MIT licensed
+Copyright (C) 2017 Jeff Mosawy, [http://jmosawy.com](http://jmosawy.com)

index.js

@@ -0,0 +1,7 @@
+const Phone = require('./phone');
+
+const Verifier = function () {};
+
+Verifier.prototype.Phone = Phone;
+
+module.exports = new Verifier();