string

Source: index.js:6

字符串处理工具函数

Static Methods

calcStrLength(str: String, isStrict: Boolean): Number

计算字符串长度 isStrict为true的时候 返回一个字符串的长度，汉字算2个字符长度

Parameters

• str (String) — 要计算的字符串
• isStrict (Boolean) — true 返回一个字符串的长度，汉字算2个字符长度; false 直接返回长度

Returns

• Number — 返回字符串长度

Example

const str = 'script-toolkit库'
console(calcStrLength(str))
console(calcStrLength(str, true))

camelCase(value: string): string

将字符串转换为小驼峰命名。

Parameters

• value (string) — 原字符串

Returns

• string — 小驼峰字符串

Throws

• TypeError — 参数不是字符串时抛出

capitalize(value: string): string

将字符串首字符转为大写，其余字符转为小写。

Parameters

• value (string) — 原字符串

Returns

• string — 首字母大写的新字符串

Throws

• TypeError — 参数不是字符串时抛出

escapeHtml(value: string): string

转义 HTML 中具有特殊含义的五个字符，不依赖 DOM。

Parameters

• value (string) — 原字符串

Returns

• string — 转义后的字符串

Throws

• TypeError — 参数不是字符串时抛出

kebabCase(value: string): string

将字符串转换为短横线命名。

Parameters

• value (string) — 原字符串

Returns

• string — kebab-case 字符串

Throws

• TypeError — 参数不是字符串时抛出

omitStr( str: string, start: number, end: number, replaceStr: string, )

格式化替换字符串

Parameters

• str (string) — 需要操作的字符串
• start (number) — 开始位置
• end (number) — 结束位置 3 的话就是倒数第三个 倒数第三个不被替换
• replaceStr (string) — 替换的值 默认 '*'

Example

omitStr('185098535', 2, 3, '*') // 18****535

truncate( value: string, length?: number, omission?: string, ): string

将字符串截断到指定长度，并在截断处追加省略标记。

Parameters

• value (string) — 原始字符串
• length (number, optional, default: 30) — 包含省略标记在内的最大长度
• omission (string, optional, default: "'...'") — 省略标记

Returns

• string — 截断后的新字符串

Throws

• TypeError | RangeError — 参数类型或长度不正确时抛出

unescapeHtml(value: string): string

解码 escapeHtml 生成的 HTML 实体，不依赖 DOM。

Parameters

• value (string) — 已转义字符串

Returns

• string — 解码后的字符串

Throws

• TypeError — 参数不是字符串时抛出

words(value: string): Array.<string>

将字符串拆分为单词数组，支持空格、连字符、下划线和大小写边界。

Parameters

• value (string) — 要拆分的字符串

Returns

• Array.<string> — 单词数组

Throws

• TypeError — 参数不是字符串时抛出