Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fandogh/codemeli
Iranians national number (NID,SSN) parser & validator
https://github.com/fandogh/codemeli
code iran iranian meli melli national national-number nid persian ssn
Last synced: about 3 hours ago
JSON representation
Iranians national number (NID,SSN) parser & validator
- Host: GitHub
- URL: https://github.com/fandogh/codemeli
- Owner: fandogh
- License: mit
- Created: 2017-03-10T10:11:10.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-09-12T08:52:17.000Z (about 1 year ago)
- Last Synced: 2024-11-14T09:52:18.145Z (3 days ago)
- Topics: code, iran, iranian, meli, melli, national, national-number, nid, persian, ssn
- Language: JavaScript
- Homepage:
- Size: 126 KB
- Stars: 28
- Watchers: 4
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CodeMeli
> Iranians national number (NID,SSN) parser & validator
[](https://circleci.com/gh/fandogh/codemeli)
[](https://www.npmjs.com/package/codemeli)
**Node.js**
# City codes
```bash
# Using Yarn
yarn add codemeli
# Using NPM
npm install --save codemeli
```
**Browser**
```html
```
## API
This packages exports `codemeli(code,returnObj)` function
**code**
National number value. it can be string or number, both are supported.
**return value**
If for any reason input is invalid it will return `null` Otherwise It will return a formatted **10 digits** code.
If returnObj is true (defaults to `false`) function will return an object with this fields instead:
- code
- parity
- city_code
- uid
## Example
```js
const codemeli = require('codemeli');
var inputValue='xxxxxxxxxx'; // TODO: Change this value
// Simple usage
const national_number = codemeli(inputValue);
console.log(national_number); // xxxxxxxxxx
// Object style
const national_number_obj = codemeli(inputValue, true);
/*
{
code: 'xxxxxxxxxx',
parity: 'x',
city_code: 'xx',
uid: 'xxxxxxx'
}
*/
console.log(national_number_obj);
```
## Algorithm
Parity checking algorithm extracted from an article from [aliarash.com](http://www.aliarash.com/article/codemeli/codemeli.htm)
(Also available [here](https://fandogh.github.io/codemeli/codemeli.html))
## City & State DB [WIP]
Unfortunately there is no public official db of city codes and there was typos in unofficial ones.
I tried my best to detect typos by both comparing all of them and user comments.
Here is the list of discovered references:
- [yasa.co](https://www.yasa.co/%D8%A7%D8%AF%D8%A7%D8%B1%D9%87-%D8%AB%D8%A8%D8%AA-%D8%A7%D8%AD%D9%88%D8%A7%D9%84/%DA%A9%D8%AF-%D9%85%D9%84%DB%8C-%D9%88-%D8%B4%D9%87%D8%B1-%D9%85%D8%AD%D9%84-%D8%B5%D8%AF%D9%88%D8%B1-%D8%A2%D9%86-%D8%B4%D9%87%D8%B1-%D9%85%D8%AD%D9%84-%D8%AA%D9%88%D9%84%D8%AF)
- [police10.blog.ir](http://police10.blog.ir/post/220/Search%20Iranian%20national%20code%20for%20each%20city)
- [it-office.ir](http://www.it-office.ir/index.php?option=com_content&view=article&id=133&Itemid=794)
- [codemelli.blogfa.com](http://codemelli.blogfa.com/post-2.aspx)
Please check [docs/city_codes.json](docs/citiy_codes.json) and [docs/missing_cities.txt](docs/missing_cities.txt) for more info.
## Read More
- [Wikipedia](https://en.wikipedia.org/wiki/Iranian_national_identity_card)
- [Wikipedia + Algorithm (Persian)](https://fa.wikipedia.org/wiki/Iranian_national_identity_card)
- [IR Family](http://irfamily.com/iranian-national-identity-card/)
- [History of iranian identify cards (Persian)](http://www.farsnews.com/newstext.php?nn=13941107000664)
## Related projects
- [rghorbani/node-iranian-ssn](https://github.com/rghorbani/node-iranian-ssn)
- [rghorbani/iranian-ssn-gem](https://github.com/rghorbani/iranian-ssn-gem)
## LICENSE
MIT License Copyright (c) 2017 Fandogh - [Pooya Parsa](mailto:[email protected])