Function mask

  • mask(src, mask, align?, fillMask?, maskMark?): string

  • 对字符串进行掩码处理

    Parameters

    • src: string

      原始字符串

    • mask: string

      掩码模板字符串，由'#'和''组成，'#'表示保留原字符，''表示需要掩码的位置

    • align: "left" | "right" = "left"

      长度不一致时的对齐方式（'left'或'right'），默认为'left'

    • fillMask: "#" | "*" = "*"

      当模板长度不足时，用于填充模板的字符（只能是'#'或''），默认为''

    • maskMark: string = "*"

      实际输出时用于替换模板中''的字符，默认为''（可以是任意字符）

    Returns string

    处理后的掩码字符串

    Example

    // 基本用法：保留前2后2，中间用*掩码
    mask("1234567890", "##******##"); // "12******90"

    Example

    // 使用X作为掩码输出字符
    mask("1234567890", "##******##", "left", "*", "X"); // "12XXXXXX90"

    Example

    // 右对齐，模板不足时用#填充（即保留原字符）
    mask("123456", "###", "right", "#"); // "123456"

    Example

    // 左对齐，模板不足时用*填充（即需要掩码）
    mask("123456", "###", "left", "*", "X"); // "123XXX"

Settings

Member Visibility