feat(string): hideString添加replacementLen选项，支持替换字符不等于实际字符数量

Author: mengxinssfd

src/string.ts

@@ -346,15 +346,19 @@ export function getStringLen(value: string): number {
  * hideString('👨‍👨‍👧‍👦helloworld👨‍👨‍👧‍👦', { start: 1, end: -1 }); // '👨‍👨‍👧‍👦**********👨‍👨‍👧‍👦'
  * hideString('👨‍👨‍👧‍👦hello👨‍👨‍👧world👨‍👨‍👧‍👦', { start: 1, end: -1 }); // '👨‍👨‍👧‍👦***********👨‍👨‍👧‍👦'
  *
+ * // 替换字符不对应实际字符数量
+ * hideString('👨‍👨‍👧‍👦hello👨‍👨‍👧world👨‍👨‍👧‍👦', { start: -12, end: -1, replacementLen: 1 }); // '👨‍👨‍👧‍👦*👨‍👨‍👧‍👦'
+ *
  * @param origin 原字符串
  * @param [options={}] 选项
  * @param [options.replacement='*'] 替换的字符串，默认为'*'
  * @param [options.start=0] 替换起始位置
  * @param [options.end] 替换结束位置 默认为原字符串长度
+ * @param [options.replacementLen] 替换字符不对应实际字符数量
  */
 export function hideString(
   origin: string,
-  options?: { replacement?: string; start?: number; end?: number },
+  options?: { replacement?: string; start?: number; end?: number; replacementLen?: number },
 ): string;
 /**
  * 字符串遮掩部分或全部
@@ -383,15 +387,19 @@ export function hideString(
  * hideString('👨‍👨‍👧‍👦helloworld👨‍👨‍👧‍👦', { start: 1, len: 10 }); // '👨‍👨‍👧‍👦**********👨‍👨‍👧‍👦'
  * hideString('👨‍👨‍👧‍👦hello👨‍👨‍👧world👨‍👨‍👧‍👦', { start: 1, len: 11 }); // '👨‍👨‍👧‍👦***********👨‍👨‍👧‍👦'
  *
+ * // 替换字符不对应实际字符数量
+ * hideString('👨‍👨‍👧‍👦hello👨‍👨‍👧world👨‍👨‍👧‍👦', { start: 1, len: 11, replacementLen: 1 }); // '👨‍👨‍👧‍👦*👨‍👨‍👧‍👦'
+ *
  * @param origin 原字符串
  * @param [options={}] 选项
  * @param [options.replacement='*'] 替换的字符串，默认为'*'
  * @param [options.start=0] 替换起始位置
  * @param [options.len] 替换文字长度 默认为原字符串长度
+ * @param [options.replacementLen] 替换字符不对应实际字符数量
  */
 export function hideString(
   origin: string,
-  options?: { replacement?: string; start?: number; len?: number },
+  options?: { replacement?: string; start?: number; len?: number; replacementLen?: number },
 ): string;
 /**
  * 字符串遮掩部分或全部
@@ -416,24 +424,35 @@ export function hideString(
  * hideString('👨‍👨‍👧‍👦helloworld👨‍👨‍👧‍👦', { len: 10, end: -1 }); // '👨‍👨‍👧‍👦**********👨‍👨‍👧‍👦'
  * hideString('👨‍👨‍👧‍👦hello👨‍👨‍👧world👨‍👨‍👧‍👦', { len: 11, end: -1 }); // '👨‍👨‍👧‍👦***********👨‍👨‍👧‍👦'
  *
+ * // 替换字符不对应实际字符数量
+ * hideString('👨‍👨‍👧‍👦hello👨‍👨‍👧world👨‍👨‍👧‍👦', { len: 11, end: -1, replacementLen: 1 }); // '👨‍👨‍👧‍👦*👨‍👨‍👧‍👦'
+ *
  * @param origin 原字符串
  * @param [options={}] 选项
  * @param [options.replacement='*'] 替换的字符串，默认为'*'
  * @param [options.len] 默认为原字符串长度
  * @param [options.end] 替换结束位置 默认为原字符串长度
+ * @param [options.replacementLen] 替换字符不对应实际字符数量
  */
 export function hideString(
   origin: string,
-  options?: { replacement?: string; end?: number; len?: number },
+  options?: { replacement?: string; end?: number; len?: number; replacementLen?: number },
 ): string;
 export function hideString(
   origin: string,
   {
     replacement = '*',
+    replacementLen = -1,
     start,
     end,
     len,
-  }: { replacement?: string; start?: number; end?: number; len?: number } = {},
+  }: {
+    replacement?: string;
+    replacementLen?: number;
+    start?: number;
+    end?: number;
+    len?: number;
+  } = {},
 ): string {
   const segmenter = new Intl.Segmenter('fr', { granularity: 'grapheme' });
   const wordList = Array.from(segmenter.segment(origin));
@@ -460,7 +479,9 @@ export function hideString(
   const [before, after] = [_before, _after].map((item) =>
     item.reduce((prev, cur) => prev + cur.segment, ''),
   );
-  const center = replacement.repeat(wordListLen - _before.length - _after.length);
+  const center = replacement.repeat(
+    replacementLen !== -1 ? replacementLen : wordListLen - _before.length - _after.length,
+  );
 
   return before + center + after;
 }