china-id-mask/README.md

A utility to mask Chinese ID card numbers by replacing birth date with asterisks

# china-id-mask

中国身份证号码脱敏工具，用于隐藏身份证中的出生年月日信息。

## 安装

```bash
npm install china-id-mask
```

## 使用方法

```javascript
const maskId = require('china-id-mask');

// 18位身份证
console.log(maskId('11010519491231002X'));
// 输出: 110105********002X

// 15位身份证
console.log(maskId('110105491231002'));
// 输出: 110105******002

// 数字输入
console.log(maskId(11010519491231002X));
// 输出: 110105********002X

// 无效身份证会抛出错误
try {
  maskId('123456');
} catch (e) {
  console.error(e.message);
  // 输出: Invalid Chinese ID card length. Must be 15 or 18 digits.
}
```

## 功能

- 支持 15 位和 18 位中国身份证号码
- 支持字符串和数字输入
- 自动验证身份证格式
- 将出生年月日部分替换为星号(\*)
  - 15 位身份证: 替换第 7-12 位(6 位)
  - 18 位身份证: 替换第 7-14 位(8 位)

## 许可证

MIT