hongfangze-string

字符串的操作

介绍

字符串操作

/**
 * 去除前后空格
 * @param {string} str
 * @return {*}  {string}
 */
export declare const trim: (str: string) => string;
/**
 * 去除前面的空格
 * @param {string} str
 * @return {*}  {string}
 */
export declare const ltrim: (str: string) => string;
/**
 * 去除后面的空格
 * @param {string} str
 * @return {*}  {string}
 */
export declare const rtrim: (str: string) => string;
/**
 * 填充（前置）字符串，一般用于流水号前面的占位
 * @param {string} str 原始字符串
 * @param {number} [len] 填充后的总位数长度
 * @param {string} [fixText] 需要填充（前置）的字符
 * @return {string} 填充后的新字符串
 */
export declare const prefix: (str: string, len?: number, fixText?: string) => string;
/**
 * 字符串开头是否包含指定字符串
 * @param {string} str 要检查的字符串
 * @param {string} includeStr 要包含的字符
 * @return {*}  {boolean}
 */
export declare const startWith: (str: string, includeStr: string) => boolean;
/**
 * 字符串结尾是否包含指定字符串
 * @param {string} str 要检查的字符串
 * @param {string} includeStr 要包含的字符
 * @return {*}  {boolean}
 */
export declare const endWith: (str: string, includeStr: string) => boolean;
/**
 * 格式化字符串
 * @param {string} str 原始字符串
 * - 可以使用{0} {1}这种下标方式占位，对应replace参数传入string[]，依次替换下标数据
 * - 也可以使用{name} {age}这种变量名占位，对应replace参数传入Record<string, string>的JSON，将匹配到的变量名进行替换
 * @param {(string[] | Record<string, string>)} replace 需要被替换的数据源
 * @return {*}  {string}
 */
export declare const format: (str: string, replace: string[] | Record<string, string>) => string;
/**
 * 压缩字符串
 * @param {string} str 待压缩的字符串
 * @return {string} 压缩后的字符串
 */
export declare const compress: (str: string) => string;
/**
 * 解压缩字符串
 * @param {string} str 待解压缩的字符串
 * @return {string} 解压缩后的字符串
 */
export declare const decompress: (str: string) => string;
/**
 * 字符串是否包含指定的字符串
 * @param {string} str 需要检验的字符串
 * @param {string} include 被包含的字符串
 * @return {*}  {boolean}
 */
export declare const include: (str: string, include: string) => boolean;

版本迭代记录

2025-04-11 v1.0.2

• 被移除后更名发布。

2024-06-12 v0.1.0

• 增加字符串压缩和解压缩函数