String - Prototype JavaScript 框架

Xunxin Prototype API

String

Prototype 通过 String.prototype 添加了一系列的方法,增强了 String 对象的功能。 厌倦了手动移除字符串首尾的空格吗?试一下我们的 String#strip 方法。 想要把 replace 方法替换掉吗?注意一下 String#subString#gsub 方法。需要将字符串解析为一个查询字符串吗?我们刚好有 String#toQueryParams 方法。

方法

blank
1.5.1

blank() -> Boolean

检查字符串是否为空或只包含空白符。

camelize

camelize() -> string

将一个用横线分隔的字符串转换为 Camel 形式。如 'foo-bar' 将被转换为 'fooBar'

capitalize

capitalize() -> string

将一个字符串的首字母转换为大写,其它的字母全部转为小写。

dasherize

dasherize() -> string

将字符串中的下划线全部替换为横线("_" 替换为 "-")。

empty
1.5.1

empty() -> Boolean

检查字符串是否为空。

endsWith
1.5.1

endsWith(substring) -> Boolean

检查字符串是否以 substring 作为结尾。

escapeHTML

escapeHTML() -> string

将 HTML 特殊字符转换为它们的等价实体。

evalJSON
1.5.1

evalJSON([sanitize = false]) -> object

执行一个 JSON 格式的字符串,并返回结果对象。如果可选的参数 sanitize 被设置为 true,则会检测字符串中是否包含恶意或错误代码,若检测到,则会停止字符串的执行, 不再调用 eval

evalScripts

evalScripts() -> [returnedValue...]

执行字符串中包含的所有 script 块的内容。返回一个数组,该数组包含每个 script 执行后返回的值。

extractScripts

extractScripts() -> [script...]

提取出字符串中包含的所有 script 的内容,并将之返回作为一个字符串数组。

gsub

gsub(pattern, replacement) -> string

将字符串中所有与 pattern 指定的模式匹配的子串全部用 replacement 替换掉。replacement 可以是一个普通的字符串、一个回调函数或是一个 Template 字符串。pattern 可以是一个字符串或是一个正则表达式。

include
1.5.1

include(substring) -> Boolean

检查字符串是否包含子串 substring

inspect

inspect([useDoubleQuotes = false]) -> String

返回该字符串针对调试的字符串表现形式(即用单引号或双引号包括起来,并使用 '\' 对特殊字符进行转义)。

interpolate
1.6

interpolate(object[, pattern]) -> string

将字符串看作一个模板,并使用 object 的属性填充它。

isJSON
1.5.1.1

isJSON() -> boolean

使用正则表达式检测字符串是否是合法的 JSON 格式。这是一个在内部使用的安全检测方法。

parseQuery

toQueryParams 方法的别名。

scan

scan(pattern, iterator) -> string

该方法允许遍历字符串中与参数 pattern 指定的模式(可以是一个字符串或是一个正则表达式) 匹配的所有子串。返回原始字符串本身。

startsWith
1.5.1

startsWith(substring) -> Boolean

检查字符串是否以 substring 作为开头。

strip

strip() -> string

移除字符串首尾的所有空白符。

stripScripts

stripScripts() -> string

移除字符串中所有的 HTML script 块。

stripTags

stripTags() -> string

移除字符串中所有的 HTML 标签。

sub

sub(pattern, replacement[, count = 1]) -> string

将字符串中前 count 个与 pattern 指定的模式匹配的子串用 replacement 替换掉。replacement 可以是一个普通的字符串、一个回调函数或是一个 Template 字符串。pattern 可以是一个字符串或是一个正则表达式。

succ

succ() -> string

用于 ObjectRange 内部。根据 Unicode 字母表转换字符串最后的字符为后续的字符。

times
1.5.1

times(count) -> string

将字符串重复 count 次。

toArray

toArray() -> [character...]

将字符串拆分为字符数组。

toJSON
1.5.1

toJSON() -> String

返回一个 JSON 格式的字符串。

toQueryParams

toQueryParams([separator = '&']) -> Object

解析一个 URI 查询字符串,并返回由“参数/值”对组成的对象。

truncate

truncate([length = 30[, suffix = '...']]) -> string

将字符串截短为指定的长度(注意:这里的长度包含了后缀部分), 并添加一个后缀(表示它仅只是一个摘要)。

underscore

underscore() -> string

将一个 Camel 形式的字符串转换为以下划线("_")分隔的一系列单词。

unescapeHTML

unescapeHTML() -> string

移除字符串中的标签,并将用实体表示的 HTML 特殊字符转换为它们的正常形式。

unfilterJSON
1..5.1

unfilterJSON([filter = Prototype.JSONFilter]) -> String

移除 Ajax JSON 或 JavaScript 响应内容周围的安全注释界定符。这是供内部使用的一种安全机制。