@emrys-cloud/me-utils/core/string.d.ts

me-utils 是一个 基于 TypeScript 开发的、简易的、模块化的 JavaScript 实用工具库。

/**
 * @file 字符串相关api
 */
/**
 * 使用符号遮蔽指定位置的字符串
 * @param {string} str 需要处理的字符串
 * @param {number} start 起始位置index
 * @param {number} end 结束位置index
 * @param {string} _mask 要替换成的字符，默认为 *
 * @returns {string} 返回遮蔽后的字符串
 *
 * @example
 * mask('12398765432', 3, 7) // => "123****5432"
 * mask('12398765432', 3, 7, '-') // => "123----5432"
 */
export declare const mask: (str: string, start?: number, end?: number, _mask?: string) => string;
/**
 * 使用符号遮蔽从最左边到指定位置（从左往右）的字符串
 * @param {string} str
 * @param {number} end 结束位置（从左往右）
 * @param {string} _mask 要替换成的字符，默认为 *
 * @returns {string} 返回遮蔽后的字符串
 *
 * @example
 * maskLeft('12398765432', 3, '-') // "---98765432"
 */
export declare const maskLeft: (str: string, end?: number, _mask?: string) => string;
/**
 * 使用符号遮蔽从最右边到指定位置（从右往左）的字符串
 * @param {string} str
 * @param {number} end 结束位置（从右边起）
 * @param {string} _mask 要替换成的字符，默认为 *
 * @returns {string} 返回遮蔽后的字符串
 *
 * @example
 * maskRight('12398765432', 3, '-') // => "12398765---"
 */
export declare const maskRight: (str: string, end?: number, _mask?: string) => string;
/**
 * 去除字符串所有空格
 * @param {string} str
 * @returns {string} 返回 去除后的字符串
 *
 * @example
 * removeStringSpace('       good        ') // => 'good'
 * removeStringSpace('       b  a  d        ') // => 'bad'
 */
export declare const removeStringSpace: (str: string) => string;