函数 hideString

  • hideString(origin, options?): string

  • 字符串遮掩部分或全部

    可选传start、end

    参数

    • origin: string

      原字符串

    • 可选options: {
          replacementLen?: number;
          replacement?: string;
          start?: number;
          end?: number;
      }

      选项

      • 可选replacementLen?: number

        替换字符不对应实际字符数量

      • 可选replacement?: string

        替换的字符串，默认为'*'

      • 可选start?: number

        替换起始位置

      • 可选end?: number

        替换结束位置 默认为原字符串长度

    返回 string

    示例

    // 省略参数
    hideString('helloworld'); // '**********'
    // 上面👆省略的约等于下面👇的参数
    hideString('helloworld', { start: 0, replacement: '*' }); // '**********'

    // start等于end时，不做替换
    hideString('helloworld', { start: 0, end: 0 }); // 'helloworld'
    hideString('helloworld', { start: 5, end: 5 }); // 'helloworld'

    // 下面3种结果一样
    hideString('helloworld', { start: 1, end: -1 }); // 'h********d'
    hideString('helloworld', { start: 1, end: 9 }); // 'h********d'
    hideString('helloworld', { start: -9, end: 9 }); // 'h********d'

    // start、end可逆
    hideString('helloworld', { start: -1, end: 1 }); // 'h********d'
    hideString('helloworld', { start: 9, end: 1 }); // 'h********d'

    // 支持表情
    hideString('👨‍👨‍👧‍👦helloworld👨‍👨‍👧‍👦', { start: 1, end: -1 }); // '👨‍👨‍👧‍👦**********👨‍👨‍👧‍👦'
    hideString('👨‍👨‍👧‍👦hello👨‍👨‍👧world👨‍👨‍👧‍👦', { start: 1, end: -1 }); // '👨‍👨‍👧‍👦***********👨‍👨‍👧‍👦'

    // 替换字符不对应实际字符数量
    hideString('👨‍👨‍👧‍👦hello👨‍👨‍👧world👨‍👨‍👧‍👦', { start: -12, end: -1, replacementLen: 1 }); // '👨‍👨‍👧‍👦*👨‍👨‍👧‍👦'
  • hideString(origin, options?): string

  • 字符串遮掩部分或全部

    可选传start、len

    参数

    • origin: string

      原字符串

    • 可选options: {
          replacementLen?: number;
          replacement?: string;
          start?: number;
          len?: number;
      }

      选项

      • 可选replacementLen?: number

        替换字符不对应实际字符数量

      • 可选replacement?: string

        替换的字符串，默认为'*'

      • 可选start?: number

        替换起始位置

      • 可选len?: number

        替换文字长度 默认为原字符串长度

    返回 string

    示例

    // 省略参数
    hideString('helloworld'); // '**********'
    // 上面👆省略的约等于下面👇的参数
    hideString('helloworld', { start: 0, len: 10 }); // '**********'

    // len为0时，不做替换
    hideString('helloworld', { start: 0, len: 0 }); // 'helloworld'

    // 只传len约等于start为0
    hideString('helloworld', { len: 9 }); // '*********d'
    hideString('helloworld', { start: 0, len: 9 }); // '*********d'

    // 下面两种结果一样
    hideString('helloworld', { start: 1, len: 8 }); // 'h********d'
    hideString('helloworld', { start: -9, len: 8 }); // 'h********d'

    // 支持表情
    hideString('👨‍👨‍👧‍👦helloworld👨‍👨‍👧‍👦', { start: 1, len: 10 }); // '👨‍👨‍👧‍👦**********👨‍👨‍👧‍👦'
    hideString('👨‍👨‍👧‍👦hello👨‍👨‍👧world👨‍👨‍👧‍👦', { start: 1, len: 11 }); // '👨‍👨‍👧‍👦***********👨‍👨‍👧‍👦'

    // 替换字符不对应实际字符数量
    hideString('👨‍👨‍👧‍👦hello👨‍👨‍👧world👨‍👨‍👧‍👦', { start: 1, len: 11, replacementLen: 1 }); // '👨‍👨‍👧‍👦*👨‍👨‍👧‍👦'
  • hideString(origin, options?): string

  • 字符串遮掩部分或全部

    可选传len、end

    参数

    • origin: string

      原字符串

    • 可选options: {
          replacementLen?: number;
          replacement?: string;
          end?: number;
          len?: number;
      }

      选项

      • 可选replacementLen?: number

        替换字符不对应实际字符数量

      • 可选replacement?: string

        替换的字符串，默认为'*'

      • 可选end?: number

        替换结束位置 默认为原字符串长度

      • 可选len?: number

        默认为原字符串长度

    返回 string

    示例

    // 省略参数
    hideString('helloworld'); // '**********'
    // 上面👆省略的约等于下面👇的参数
    hideString('helloworld', { len: 10, end: 10, replacement: '*' }); // '**********'

    // len为0时，不做替换
    hideString('helloworld', { len: 0, end: 10 }); // 'helloworld'

    // 下面2种结果一样
    hideString('helloworld', { len: 8, end: -1 }); // 'h********d'
    hideString('helloworld', { len: 8, end: 9 }); // 'h********d'

    // 支持表情
    hideString('👨‍👨‍👧‍👦helloworld👨‍👨‍👧‍👦', { len: 10, end: -1 }); // '👨‍👨‍👧‍👦**********👨‍👨‍👧‍👦'
    hideString('👨‍👨‍👧‍👦hello👨‍👨‍👧world👨‍👨‍👧‍👦', { len: 11, end: -1 }); // '👨‍👨‍👧‍👦***********👨‍👨‍👧‍👦'

    // 替换字符不对应实际字符数量
    hideString('👨‍👨‍👧‍👦hello👨‍👨‍👧world👨‍👨‍👧‍👦', { len: 11, end: -1, replacementLen: 1 }); // '👨‍👨‍👧‍👦*👨‍👨‍👧‍👦'