内置预设/API

MaskIO 预设了常用的掩码规则，以及主要 maskText、maskObject API。

API

API	说明	版本
maskText	字符串 掩码处理
maskObject	对象、数组、数组对象 掩码处理

maskText 参数说明

maskText: (text: string, config: MaskIoConfig, defaultConfig?: MaskIoConfig)

• text: 必填 需要掩码的字符串
• config: 必填 掩码规则，可使用预设值，也可自定义
• defaultConfig: 可选项 配置兜底的掩码规则，可使用预设值，也可自定义

maskObject 参数说明

maskObject: (obj: Record<string, any> | any[], config: Record<string, MaskIoConfig | FiledHandler>)

• obj: 必填 需要掩码的对象或数组
• config: 必填 掩码规则，配置项，键为路径，值为掩码配置或字段处理函数

预设规则

预设名称	说明
all	全掩码 将整个字符串替换为掩码字符。
bankCard	银行卡 显示银行卡号的最后四位，前面的数字用掩码字符替代 。
idCard	身份证号 显示身份证号的前 3 位和后 2-4 位，其余部分用掩码字符替代。
userName	姓名 显示姓名的最后一位。
email	邮箱 保留邮箱的前两个字符和后缀，其余部分用掩码字符替代，若未匹配上则全掩码。
phone	电话号码 根据不同地区的电话号码格式进行掩码处理，保留特定的数字。
landline	固定电话 默认固定电话，显示区号和后两位，其他显示后两位。
amount	金额 全掩码处理。
verification	验证码 全掩码处理。
address	地址 全掩码处理。
ip	ip 显示前 3 段，最后一段用掩码字符替代。
url	url 显示域名和路径，掩码查询参数。
licensePlate	车牌号 显示车牌号的前两位，后面的部分用掩码字符替代。