axetroy / chinese-idcard-checker

**居民身份证验证

chinese-idcard-checker

🇨🇳中华人民共和国居民身份证验证器

安装

yarn add chinese-idcard-checker

如果使用npm则执行 npm install chinese-idcard-checker --save 安装

用法

import IDCardChecker from 'chinese-idcard-checker';
// or 
// const IDCardChecker = require('chinese-idcard-checker'); 

// 验证身份证有效性
IDCardChecker.validate(idCardNum); // true or false

// 获取省份
IDCardChecker.getProvince(idCardNum); // '北京市'

// 获取出生日期
IDCardChecker.getBirthDate(idCardNum);  // new Date('1949-10-1')

// 获取性别
IDCardChecker.getGender(idCardNum); // '男','女'

// 返回正则表达式常量
const pattern = IDCardChecker.pattern(); // /^[1-9]\d{5}(18|19|20)\d{2}((0[1-9])|(1[0-2]))(([0-2][1-9])|10|20|30|31)\d{3}[0-9Xx]$/;
if(pattern.test(idCardNum)){
  // ...
}

API

idCardChecker.pattern() ⇒ RegExp

返回正则表达式

Returns: RegExp - /^[1-9]\d{5}(18|19|20)\d{2}((0[1-9])|(1[0-2]))(([0-2][1-9])|10|20|30|31)\d{3}[0-9Xx]$/

idCardChecker.validate(idCardNum) ⇒ boolean

验证身份证有效性

Param	Type	Description
idCardNum	string	身份证号码

idCardChecker.getProvince(idCardNum) ⇒ string | null

获取省份

Returns: string | null - 身份证号码

Param	Type	Description
idCardNum	string	身份证号码

idCardChecker.getBirthDate(idCardNum) ⇒ Date | null

获取出生日期

Returns: Date | null - 出生日期

Param	Type	Description
idCardNum	string	身份证号码

idCardChecker.getGender(idCardNum) ⇒ string | null

获取性别

Returns: string | null - '男','女'

Param	Type	Description
idCardNum	string	身份证号码

LICENSE

MIT License