Teal TealUI

字符串扩展util/string

提供 JavaScript 内置对象 String 的扩展接口。

API

函数 描述
⮞ format(formatString, ...)(formatString:string, ...args:any[]):string

格式化字符串。

参数 类型 描述 默认值
formatString* string —
args any[] —

返回值

类型：string

返回格式化后的字符串。

示例

format("我是{0}，不是{1}", "小黑", "大白") // "我是小黑，不是大白"
format("我是{xiaohei}，不是{dabai}", {xiaohei: "小黑", dabai: "大白"}) // "我是小黑，不是大白"
format("在字符串内使用两个{{和}}避免被转换") //  "在字符串内使用两个{和}避免被转换"

格式化字符串。
⮞ isString(obj)(obj:any):boolean

判断对象是否是字符串。

参数 类型 描述 默认值
obj* any —

返回值

类型：boolean

如果 obj 是字符串则返回 true，否则返回 false。

示例

isString("") // true

判断对象是否是字符串。
⮞ trunc(str, length, ...)(str:string, length:number, append?:string):string

截断字符串超出长度的部分。

参数 类型 描述 默认值
str* string —
length* number —
append string "..."

返回值

类型：string

返回处理后的字符串。

示例

trunc("1234567", 6) // "123..."
trunc("1234567", 9) // "1234567"

截断字符串超出长度的部分。
⮞ truncByWord(str, length, ...)(str:string, length:number, append?:string):string

截断字符串超出长度的部分，并确保不强制截断单词。

参数 类型 描述 默认值
str* string —
length* number —
append string "..."

返回值

类型：string

返回处理后的字符串。

示例

truncByWord("abc def", 6) //   "abc..."

截断字符串超出长度的部分，并确保不强制截断单词。
⮞ containsWord(str, value, ...)(str:string, value:string, separator?:string):boolean

判断字符串是否包含指定的单词。

参数 类型 描述 默认值
str* string —
value* string —
separator string " "

返回值

类型：boolean

如果包含指定的单词则返回 true，否则返回 false。

示例

containsWord("abc ab", "ab")

判断字符串是否包含指定的单词。
⮞ removeLeadingWhiteSpaces(str)(str:string):string

删除字符串每行的公共缩进部分。

参数 类型 描述 默认值
str* string —

返回值

类型：string

返回新字符串。

示例

removeLeadingWhiteSpaces("  a") // "a"

删除字符串每行的公共缩进部分。
⮞ replaceAll(str, from, to)(str:string, from:string, to:string):string

替换字符串内指定的子字符串，如果出现多次则全部替换。

参数 类型 描述 默认值
str* string —
from* string —
to* string —

返回值

类型：string

返回新字符串。

示例

replaceAll("1121", "1", "3") // "3323"

替换字符串内指定的子字符串，如果出现多次则全部替换。
⮞ clean(str)(str:string):string

删除字符串内的所有空白符号。

参数 类型 描述 默认值
str* string —

返回值

类型：string

返回新字符串。

示例

clean(" a b   ") // "ab"

删除字符串内的所有空白符号。
⮞ byteLength(str)(str:string):number

计算字符串按字节计算的长度（英文算一个字符，中文算两个个字符）。

参数 类型 描述 默认值
str* string —

返回值

类型：number

返回长度值。

示例

byteLength("a中文") // 5

计算字符串按字节计算的长度（英文算一个字符，中文算两个个字符）。
⮞ capitalize(str)(str:string):string

将字符串首字母大写。

参数 类型 描述 默认值
str* string —

返回值

类型：string

返回新字符串。

示例

capitalize("qwert") // "Qwert"

将字符串首字母大写。
⮞ uncapitalize(str)(str:string):string

将字符串首字母小写。

参数 类型 描述 默认值
str* string —

返回值

类型：string

返回新字符串。

示例

uncapitalize("Qwert") // "qwert"

将字符串首字母小写。
⮞ toCamelCase(str)(str:string):string

将字符串转为骆驼规则（如 fontSize）。

参数 类型 描述 默认值
str* string —

返回值

类型：string

返回新字符串。

示例

toCamelCase("font-size") // "fontSize"

将字符串转为骆驼规则（如 fontSize）。
⮞ toKebabCase(str)(str:string):string

将字符串转为横线规则（如 font-size）。

参数 类型 描述 默认值
str* string —

返回值

类型：string

返回新字符串。

示例

toKebabCase("fontSize") // "font-size"

将字符串转为横线规则（如 font-size）。
⮞ words(str)(str:string):string[]

获取字符串中的所有单词。

参数 类型 描述 默认值
str* string —

返回值

类型：string[]

返回所有单词组成的数组。

示例

words("fontSize") // ["font", "size"]

获取字符串中的所有单词。
⮞ unique(str)(str:string):string

删除字符串内的重复字符。

参数 类型 描述 默认值
str* string —

返回值

类型：string

返回新字符串。

示例

unique("aabbcc") // "abc"

删除字符串内的重复字符。
⮞ left(str, length)(str:string, length:number):string

获取字符串左边指定长度的子字符串。

参数 类型 描述 默认值
str* string —
length* number —

返回值

类型：string

返回字符串左边指定长度的子字符串。

示例

left("abcde", 3) // "abc"

获取字符串左边指定长度的子字符串。
⮞ right(str, length)(str:string, length:number):string

获取字符串右边指定长度的子字符串。

参数 类型 描述 默认值
str* string —
length* number —

返回值

类型：string

返回字符串右边指定长度的子字符串。

示例

right("abcde", 3) // "cde"

获取字符串右边指定长度的子字符串。
⮞ match(str, re, ...)(str:string, re:RegExp, index?:number):string

使用正则表达式匹配字符串并返回指定索引的匹配结果。

参数 类型 描述 默认值
str* string —
re* RegExp —
index number 0

返回值

类型：string

返回匹配结果。如果正则表达式不匹配则返回 null。

示例

match("abc", /a(b)/, 1) // "b"

使用正则表达式匹配字符串并返回指定索引的匹配结果。