String

Methods

(static) camelCase(string, patternopt) → {string}

Description:

• 转换字符串为驼峰写法。

Source:

• camelCase.js, line 28

Since:

• 1.0.0

See:

• Camel_case

Example

camelCase('foo bar'); // 'fooBar'

camelCase('foo-bar'); // 'fooBar'

camelCase('Foo Bar'); // 'fooBar'

camelCase('FOO BAR'); // 'fooBar'

camelCase('--FOO-BAR--'); // 'fooBar'

camelCase('__FOO_BAR__'); // 'fooBar'

Parameters:

Returns:

Type

string

(static) capitalize(string) → {string}

Description:

• 转换字符串首字母大写，剩下为小写。

Source:

• capitalize.js, line 18

Since:

• 1.0.0

Example

capitalize('bar'); // 'Bar'

capitalize('BAR'); // 'Bar'

Parameters:

Returns:

Type

string

(static) escape(string) → {string}

Description:

• 转义字符串中的 & < > " ' 字符为 HTML 实体字符。

  注意：不会转义其他字符。如果需要，可以使用第三方库，如 he 。

  虽然 ">" 是对称转义的，字符如 ">" 和 "/" 没有特殊的意义，所以不需要在 HTML 转义。 除非它们是标签的一部分，或者是不带引号的属性值。

  当解析 HTML 时，总应该在属性值上使用引号以减少 XSS 的可能性。

Source:

• escape.js, line 33

Since:

• 1.0.0

See:

• ambiguous-ampersands

Example

escape('<script></script>'); // '&lt;script&gt;&lt;/script&gt;'

escape('&'); // '&amp;'

Parameters:

Returns:

Type

string

(static) escapeRegExp(string) → {string}

Description:

• 转义 RegExp 字符串中特殊的字符 \\ ^ $ . * + ? - ( ) [ ] { } |。

Source:

• escapeRegExp.js, line 21

Since:

• 1.0.0

See:

• syntax characters

Example

escapeRegExp('\\'); // '\\\\'

escapeRegExp('-+='); // '\\-\\+='

escapeRegExp('[ut2](https://caijf.github.io/ut2/)'); // '\\[ut2\\]\\(https://caijf\\.github\\.io/ut2/\\)'

Parameters:

Returns:

Type

string

(static) kebabCase(string, patternopt) → {string}

Description:

• 转换字符串为连接符小写。

Source:

• kebabCase.js, line 27

Since:

• 1.0.0

See:

• kebab case

Example

kebabCase('foo bar'); // 'foo-bar'

kebabCase('foo-bar'); // 'foo-bar'

kebabCase('Foo Bar'); // 'foo-bar'

kebabCase('FOO BAR'); // 'foo-bar'

kebabCase('--FOO-BAR--'); // 'foo-bar'

kebabCase('__FOO_BAR__'); // 'foo-bar'

Parameters:

Returns:

Type

string

(static) lowerCase(string, patternopt) → {string}

Description:

• 转换字符串为空格分隔的小写单词。

Source:

• lowerCase.js, line 26

Since:

• 1.0.0

Example

lowerCase('foo bar'); // 'foo bar'

lowerCase('foo-bar'); // 'foo bar'

lowerCase('Foo Bar'); // 'foo bar'

lowerCase('FOO BAR'); // 'foo bar'

lowerCase('--FOO-BAR--'); // 'foo bar'

lowerCase('__FOO_BAR__'); // 'foo bar'

Parameters:

Returns:

Type

string

(static) lowerFirst(string) → {string}

Description:

• 转换字符串第一个字符为小写。

Source:

• lowerFirst.js, line 21

Since:

• 1.0.0

Example

lowerFirst('Bar'); // 'bar'

lowerFirst('BAR'); // 'bAR'

lowerFirst('--Foo-bar--'); // '--Foo-bar--' 不进行分词处理

lowerFirst('Foo-bar'); // 'foo-bar'

Parameters:

Returns:

Type

string

(static) pascalCase(string, patternopt) → {string}

Description:

• 转换字符串为帕斯卡写法。又名为大驼峰写法。

Source:

• pascalCase.js, line 28

Since:

• 1.8.0

See:

• Camel_case

Example

pascalCase('foo bar'); // 'FooBar'

pascalCase('foo-bar'); // 'FooBar'

pascalCase('Foo Bar'); // 'FooBar'

pascalCase('FOO BAR'); // 'FooBar'

pascalCase('--FOO-BAR--'); // 'FooBar'

pascalCase('__FOO_BAR__'); // 'FooBar'

Parameters:

Returns:

Type

string

(static) snakeCase(string, patternopt) → {string}

Description:

• 转换字符串为下划线小写。

Source:

• snakeCase.js, line 27

Since:

• 1.0.0

See:

• snake case

Example

snakeCase('foo bar'); // 'foo_bar'

snakeCase('foo-bar'); // 'foo_bar'

snakeCase('Foo Bar'); // 'foo_bar'

snakeCase('FOO BAR'); // 'foo_bar'

snakeCase('--FOO-BAR--'); // 'foo_bar'

snakeCase('__FOO_BAR__'); // 'foo_bar'

Parameters:

Returns:

Type

string

(static) unescape(string) → {string}

Description:

• 转义字符串中的 HTML 实体字符 & < " ' 为对应的字符。

  注意：不会转换其他的 HTML 实体。如果需要，可以使用第三方库，如 he 。

Source:

• unescape.js, line 27

Since:

• 1.0.0

Example

unescape('&lt;script&gt;&lt;/script&gt;'); // '<script></script>'

unescape('&amp;'); // '&'

Parameters:

Returns:

Type

string

(static) upperCase(string, patternopt) → {string}

Description:

• 转换字符串为空格分隔的大写单词。

Source:

• upperCase.js, line 26

Since:

• 1.0.0

Example

upperCase('foo bar'); // 'FOO BAR'

upperCase('foo-bar'); // 'FOO BAR'

upperCase('Foo Bar'); // 'FOO BAR'

upperCase('FOO BAR'); // 'FOO BAR'

upperCase('--FOO-BAR--'); // 'FOO BAR'

upperCase('__FOO_BAR__'); // 'FOO BAR'

Parameters:

Returns:

Type

string

(static) upperFirst(string) → {string}

Description:

• 转换字符串第一个字符为大写。

Source:

• upperFirst.js, line 21

Since:

• 1.0.0

Example

upperFirst('bar'); // 'Bar'

upperFirst('BAR'); // 'BAR'

lowerFirst('--foo-bar--'); // '--foo-bar--' 不进行分词处理

lowerFirst('foo-bar'); // 'Foo-bar'

Parameters:

Returns:

Type

string

(static) words(string, patternopt) → {Array.<string>}

Description:

• 拆分字符串中的词为数组。

Source:

• words.js, line 19

Since:

• 1.0.0

See:

• ASCII

Example

words('fred, barney, & pebbles'); // ['fred', 'barney', 'pebbles']

words('fred, barney, & pebbles', /[^, ]+/g); // ['fred', 'barney', '&', 'pebbles']

Parameters:

Returns:

Type

Array.<string>