# id-card-validator

> 中国身份证号验证(内地)

Latest version **1.0.9** (published 2017-07-26) · 13 weekly downloads

## Install

```sh
npm install id-card-validator
pnpm add id-card-validator
yarn add id-card-validator
bun add id-card-validator
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.9 |
| Published | 2017-07-26 |
| First published | 2017-07-25 |
| Weekly downloads | 13 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 4.0.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 14 |
| Author | xiaxiangfeng |
| Maintainers | xiaxiangfeng |

## Links

- npm: https://www.npmjs.com/package/id-card-validator
- Repository: https://github.com/xiaxiangfeng/id-card-validator
- Homepage: https://github.com/xiaxiangfeng/id-card-validator#readme
- Issues: https://github.com/xiaxiangfeng/id-card-validator/issues
- npm.io page: https://npm.io/package/id-card-validator

## Dependencies (1)

- [moment](https://npm.io/package/moment.md) ^2.18.1

## Recent versions

- 1.0.9 (latest) — 2017-07-26
- 1.0.8 — 2017-07-26
- 1.0.7 — 2017-07-26
- 1.0.6 — 2017-07-26
- 1.0.5 — 2017-07-26
- 1.0.4 — 2017-07-26
- 1.0.3 — 2017-07-26
- 1.0.2 — 2017-07-26
- 1.0.1 — 2017-07-26
- 1.0.0 — 2017-07-25

## README

# 验证身份证

> 身份证严格验证和获取基本信息：15位和18位内地身份证包括地区、生日、校验码；获取性别，年龄，出生日期，城市名称

## 从NPM下载包

``` npm
npm i id-card-validator
```

## 使用实例

### 第一种方式引入一个对象

``` js
import { validator } from 'id-card-validator'
//地区码对象，不引入将不对地区做验证
import area from 'id-card-validator/lib/areaNumber'
validator.validate(id, area)
```

#### 直接调用验证方法传入身份证号

``` js
/*
 * id: 身份证号
 * area： 是地区码对象，如果不传将不对
 * 地区的正确性验证
*/

validator.validate(id, area)

// 或者

validator.validate(id)
```

### 第二种方式引入一个类

``` js
import validator from 'id-card-validator'
import area from 'id-card-validator/lib/areaNumber'
```

#### 创建对象然后调用方法传入身份证号

``` js
//area 不传将不验证地区的正确性
const validator = new validator()
validator.validate(id, area)

//或者

const validator = new validator(area)
validator.validate(id)
```

### 获取信息

``` js
/*
 * 获取信息前必须先调用validate()方法
 * 通过验证才能获取正确的信息
 */

 //验证省份证号
 validator.validate(id, area)

 /*
  *获取信息 info 是一个对象
  *{sex, birthday, age, address}
  */
  
 validator.info


```

## 构建

``` bash
# 安装依赖
npm install

# 打包
npm run build

# 单元测试
npm unit
```

---
_Source: https://npm.io/package/id-card-validator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._