@yizhuying/fakerx
v0.3.0
Published
Extensible faker toolkit with built-in China data generators.
Downloads
52
Maintainers
Readme
fakerx
基于 @faker-js/faker 的可扩展数据生成工具,当前内置中国场景插件(cn)。
特性
- 统一入口:
createFakerX() - 插件机制:支持本地插件自动加载 + 外部插件动态加载
- 内置
cn领域能力:身份证、手机号、银行卡、车牌、统一社会信用代码、地址 - ESM 友好(
"type": "module")
安装
npm install @yizhuying/fakerx快速开始
import { createFakerX } from "@yizhuying/fakerx"
const fakerX = createFakerX()
await fakerX.start()
console.log("Loaded plugins:", fakerX.plugin.list())
const randomId = fakerX.cn.id.idCard() // 不传参数:随机生成
console.log("随机身份证:", randomId, "valid:", fakerX.cn.id.verify(randomId))
const fixedId = fakerX.cn.id.idCard({ sex: "male", areaCode: "110101" })
console.log("指定参数身份证:", fixedId, "valid:", fakerX.cn.id.verify(fixedId))
console.log("银行卡:", fakerX.cn.bank.bankCard({ bank: "ICBC", length: 19 }))
console.log("车牌:", fakerX.cn.vehicle.plate({ province: "粤" }))
console.log("手机号:", fakerX.cn.phone.mobile({ carrier: "cmcc" }))可用脚本
npm run demo
npm testAPI 文档
- 完整接口说明见 docs/API.md
- 示例代码见 examples/demo.js
当前插件
cnfakerX.cn.id.idCard()/fakerX.cn.id.verify()/fakerX.cn.id.parse()fakerX.cn.phone.mobile()fakerX.cn.bank.bankCard()fakerX.cn.vehicle.plate()fakerX.cn.org.uscc()/fakerX.cn.org.verify()fakerX.cn.address.province()/city()/district()/fullAddress()
