idcard-verify/README.md

二代身份证合法性校验

# 校验身份证[第二代]合法性，获取身份证详细信息（稳定版）
声明: 本项目的源项目为[navyxie](https://github.com/navyxie/idcard)大佬创建，本项目创建的目的为备份学习。
### 安装: npm install idcard-verify / yarn add idcard-verify

## [API](#API)

[`verify`](#verify)

[`info`](#info)

[`generateIdcard`](#generateIdcard)

[`constellation`](#constellation)

[`getAge`](#getAge)

[`upgrade15To18`](#upgrade15To18)

<a name="verify" />
verify: 校验身份证合法性，返回boolean值

```js
import idCard from "idcard-verify"
/**
* param:idcard(string)
* return boolean
*/
idCard.verify('440882199100201232');//false
```

<a name="info" />
info:获取身份证详细信息，返回一个json对象，key:valid为boolean值，代表身份证是否合法。

```js
import idCard from "idcard-verify"
/**
* param:idcard(string)
* return object
*/
idCard.info('440882199100201232');
```
**返回结果：**

```js
//身份证合法时返回的数据结构
{ 
	valid: true,//身份证是否合法的标志
	gender: '男',
	birthday: 19910210,//
	province: {
		code: '440000',//行政区域编码
		text: '广东省' 
	},
	city: { 
		code: '440800', 
		text: '湛江市' 
	},
	area: { 
		code: '440882', 
		text: '雷州市' 
	},
	cardType: 1,//身份证类型，1->大陆，2->港澳台
	cardText: '大陆',
	address: '广东省湛江市雷州市',
	age:24,
	constellation:'水瓶座'//星座 
}
//身份证非法时返回的数据结构
{
	valid: false
}
```

<a name="generateIdcard" />
generateIdcard:随机生成一个合法身份证号码，返回身份证号码

```js
import idCard from "idcard-verify"
/**
* return string
*/
idCard.generateIdcard();//返回随机身份证号码
```

<a name="constellation" />
constellation:根据生日返回星座

```js
import idCard from "idcard-verify"
/**
* return string
*/
idCard.constellation(19910210);//水瓶座
idCard.constellation('1991/02/10','/');//水瓶座
```

<a name="getAge" />
getAge:根据生日返回年龄

```js
import idCard from "idcard-verify"
/**
* return number
*/
idCard.getAge(19910210);//25 (调用时的日期：2016/03/23)
```

<a name="upgrade15To18" />
upgrade15To18:身份证15位升级到18位

```js
import idCard from "idcard-verify"
/**
* return Object
*/
var result = idCard.upgrade15To18(422201720809227);
result结构:
{
	code: 0,
	msg: '身份证15位升级到18位成功',
	card: '18位的身份证'
}
```


### 身份证中第十八位数字的计算方法

- 将前面的身份证号码17位数分别乘以不同的系数。从第一位到第十七位的系数分别为：7、9、10、5、8、4、2、1、6、3、7、9、10、5、8、4、2； 
- 将这17位数字和系数相乘的结果相加； 
- 用加出来和除以11，看余数是多少
- 余数只可能有0 、1、 2、 3、 4、 5、 6、 7、 8、 9、 10这11个数字。其分别对应的最后一位身份证的号码为1、0、X、9、8、7、6、5、4、3、2； 
- 通过上面得知如果余数是2，就会在身份证的第18位数字上出现罗马数字的Ⅹ。如果余数是10，身份证的最后一位号码就是2。
- 第一代身份证十五位数升为第二代身份证十八位数:第一步，在原十五位数身份证的第六位数后面插入19 ，这样身份证号码即为十七位数；第二步，按照国家规定的统一公式计算出第十八位数，作为校验码放在第二代身份证的尾号。

*身份证倒数第二位：偶数性别为女，奇数为男*