脱敏方法

一些脱敏的方法

desensitization

支持自定义脱敏，也支持快捷脱敏的方法，v1.1.0版本开始 maskType支持自定义新增的脱敏方法

const defaultOptions = {
  start: 0, // 从前往后保留的位数，默认为 0
  middle: 0, // 0 表示中间剩多少位就展示多少位
  end: 0, // 从后往前保留的位数，默认为 0
  symbol: "*", // 替换的字符，默认为 *
  defaultVal: "", // 缺省时显示的值，默认为 ""
  maskType: "" // 为快捷脱敏 支持 name、mobile、idCard、email、address、phone、none v1.1.0版本开始支持自定义新增的脱敏方法
}

/**
 * str: 需要脱敏的字符串
 * options: 配置项 
 * 默认配置如上述 defaultOptions  
 * 字符串类型时 为快捷脱敏 支持 name、mobile、idCard、email、address、phone、none v1.1.0版本开始支持自定义新增的脱敏方法
 */
desensitization(str, options)

mask

自定义脱敏方法

const defaultOptions = {
  start: 0,
  end: 0,
  middle: 0,
  symbol: "*"
}

/**
 * str: 需要脱敏的字符串
 * options: 配置项 
 * 默认配置如上述 defaultOptions  
 */
mask(str, options)

maskName

姓名脱敏，支持如下81个复姓脱敏。

  // 所有中文复姓列表（共81个）
  const compoundSurnames = [
    "欧阳", "太史", "端木", "上官", "司马", "东方", "独孤", "南宫", "万俟", 
    "闻人", "夏侯", "诸葛", "尉迟", "公羊", "赫连", "澹台", "皇甫", "宗政", 
    "濮阳", "公冶", "太叔", "申屠", "公孙", "慕容", "仲孙", "钟离", "长孙", 
    "宇文", "司徒", "鲜于", "司空", "闾丘", "子车", "亓官", "司寇", "巫马", 
    "公西", "颛孙", "壤驷", "公良", "漆雕", "乐正", "宰父", "谷梁", "拓跋", 
    "夹谷", "轩辕", "令狐", "段干", "百里", "呼延", "东郭", "南门", "羊舌", 
    "微生", "公户", "公玉", "公仪", "梁丘", "公仲", "公上", "公门", "公山", 
    "公坚", "左丘", "公伯", "西门", "公祖", "第五", "公乘", "贯丘", "公皙", 
    "南荣", "东里", "东宫", "仲长", "子书", "子桑", "即墨", "达奚", "褚师"
  ]

/**
 * 中文姓名脱敏处理（新版规则）
 * @param {string} name 原始姓名
 * @param {string} symbol 脱敏字符，默认为 *
 * @returns {string} 脱敏后的姓名
 */
maskName(name, symbol = "*")

maskPhone

手机号脱敏，十一位时才会脱敏，不等于十一位时原值返回。

/**
 * phone: 手机号
 * symbol: 脱敏符号 默认为 "*"
 */
maskPhone(phone, symbol = "*")

maskIdCard

身份证号脱敏

/**
 * idcard: 身份证号
 * symbol: 脱敏符号 默认为 "*"
 */
maskIdCard(idcard, symbol = "*")

maskEmail

邮箱地址脱敏

/**
 * 对邮箱地址进行脱敏处理
 * @param {string} email - 需要脱敏的邮箱地址
 * @param {string} [symbol="*"] - 脱敏字符，默认为 "*"
 * @param {number} [keepStart=2] - 保留用户名开头的字符数
 * @param {number} [keepEnd=1] - 保留用户名结尾的字符数
 * @returns {string} 脱敏后的邮箱地址，无效邮箱返回原字符串
 */
maskEmail(email, symbol = "*", keepStart = 2, keepEnd = 1)

maskAddress

地址脱敏

/**
 * address: 地址信息
 * symbol: 脱敏符号 默认为 "*"
 */
maskAddress(address, symbol = "*")

v1.1.0开始，如需补充或者修改，可阅读配置进行拓展 点击前往配置文档