选项
所有
  • 公共
  • 公共/受保护
  • 所有
菜单

层级

  • 字符串
    • CSSSelector

索引

属性

只读 length

length: number

返回 String 对象的长度。

方法

[迭代器]

  • [迭代器](): IterableIterator<string>
  • 迭代器

    返回 IterableIterator<string>

anchor

  • anchor(name: string): string

big

  • big(): string
  • 返回一个 ` ` HTML 元素

    返回 string

blink

  • blink(): string
  • 返回一个 ` ` HTML 元素

    返回 string

bold

  • bold(): string
  • 返回一个 `` HTML 元素

    返回 string

charAt

  • charAt(pos: number): string
  • 返回指定索引处的字符。

    参数

    • pos: number

      所需字符的零基索引。

    返回 string

charCodeAt

  • charCodeAt(index: number): number
  • 返回指定位置字符的 Unicode 值。

    参数

    • index: number

      所需字符的零基索引。如果指定索引处没有字符,则返回 NaN。

    返回 number

codePointAt

  • codePointAt(pos: number): undefined | number
  • 返回一个小于 1114112 (0x110000) 的非负整数,该整数是此对象转换为字符串后,从位置 pos 处的字符串元素开始的 UTF-16 编码码点的码点值。如果该位置没有元素,则结果为 undefined。如果有效的 UTF-16 代理对没有在 pos 处开始,则结果为 pos 处的码位。

    参数

    • pos: number

    返回 undefined | number

concat

  • concat(...strings: string[]): string
  • 返回一个包含两个或多个字符串拼接结果的字符串。

    参数

    • 剩余参数 ...strings: string[]

      要附加到字符串末尾的字符串。

    返回 string

endsWith

  • endsWith(searchString: string, endPosition?: number): boolean
  • 如果 searchString 的元素序列(转换为字符串)与此对象(转换为字符串)从 endPosition – length(this) 开始的相应元素相同,则返回 true。否则返回 false。

    参数

    • searchString: string
    • 可选 endPosition: number

    返回 boolean

fixed

  • fixed(): string
  • 返回一个 ` ` HTML 元素

    返回 string

fontcolor

  • fontcolor(color: string): string
  • 返回一个 ` ` HTML 元素并设置 color 属性值

    参数

    • color: string

    返回 string

fontsize

  • fontsize(size: number): string
  • fontsize(size: string): string
  • 返回一个 ` ` HTML 元素并设置 size 属性值

    参数

    • size: number

    返回 string

  • 返回一个 ` ` HTML 元素并设置 size 属性值

    参数

    • size: string

    返回 string

includes

  • includes(searchString: string, position?: number): boolean
  • 如果 searchString 作为此对象(转换为字符串)的子字符串出现在大于或等于 position 的一个或多个位置,则返回 true;否则返回 false。

    参数

    • searchString: string

      搜索字符串

    • 可选 position: number

      如果 position 为 undefined,则假定为 0,以便搜索整个字符串。

    返回 boolean

indexOf

  • indexOf(searchString: string, position?: number): number
  • 返回子字符串第一次出现的位置。

    参数

    • searchString: string

      要在字符串中搜索的子字符串

    • 可选 position: number

      开始搜索 String 对象的索引。如果省略,搜索从字符串开头开始。

    返回 number

italics

  • italics(): string
  • 返回一个 `` HTML 元素

    返回 string

lastIndexOf

  • lastIndexOf(searchString: string, position?: number): number
  • 返回子字符串在字符串中最后一次出现的位置。

    参数

    • searchString: string

      要搜索的子字符串。

    • 可选 position: number

      开始搜索的索引。如果省略,搜索从字符串末尾开始。

    返回 number

link

  • link(url: string): string

localeCompare

  • localeCompare(that: string): number
  • localeCompare(that: string, locales?: string | string[], options?: CollatorOptions): number
  • 确定两个字符串在当前区域设置中是否等效。

    参数

    • that: string

      要与目标字符串比较的字符串

    返回 number

  • 确定两个字符串在当前或指定区域设置中是否等效。

    参数

    • that: string

      要与目标字符串比较的字符串

    • 可选 locales: string | string[]

      包含一个或多个语言或区域设置标签的区域设置字符串或区域设置字符串数组。如果包含多个区域设置字符串,请按优先级降序排列,以便第一个条目是首选区域设置。如果省略此参数,则使用 JavaScript 运行时的默认区域设置。此参数必须符合 BCP 47 标准;有关详细信息,请参见 Intl.Collator 对象。

    • 可选 options: CollatorOptions

      包含一个或多个指定比较选项的属性的对象。有关详细信息,请参见 Intl.Collator 对象。

    返回 number

match

  • match(regexp: string | RegExp): null | RegExpMatchArray
  • match(matcher: { [match]: any }): null | RegExpMatchArray
  • 将字符串与正则表达式匹配,并返回包含该搜索结果的数组。

    参数

    • regexp: string | RegExp

      包含正则表达式模式和标志的变量名或字符串字面量。

    返回 null | RegExpMatchArray

  • 匹配字符串或支持被匹配的对象,并返回包含该搜索结果的数组,如果没有找到匹配项,则返回 null。

    参数

    • matcher: { [match]: any }

      支持被匹配的对象。

      • [match]: 函数
        • [match](string: string): null | RegExpMatchArray
        • 参数

          • string: string

          返回 null | RegExpMatchArray

    返回 null | RegExpMatchArray

matchAll

  • matchAll(regexp: RegExp): IterableIterator<RegExpMatchArray>
  • 将字符串与正则表达式匹配,并返回一个包含该搜索结果的可迭代匹配项。

    参数

    • regexp: RegExp

      包含正则表达式模式和标志的变量名或字符串字面量。

    返回 IterableIterator<RegExpMatchArray>

normalize

  • normalize(form: "NFC" | "NFD" | "NFKC" | "NFKD"): string
  • normalize(form?: string): string
  • 返回根据 Unicode 标准附件 #15《Unicode 规范化形式》中指定的形式将字符串规范化后的字符串值结果。

    参数

    • form: "NFC" | "NFD" | "NFKC" | "NFKD"

      适用值:"NFC"、"NFD"、"NFKC" 或 "NFKD"。如果未指定,默认为 "NFC"

    返回 string

  • 返回根据 Unicode 标准附件 #15《Unicode 规范化形式》中指定的形式将字符串规范化后的字符串值结果。

    参数

    • 可选 form: string

      适用值:"NFC"、"NFD"、"NFKC" 或 "NFKD"。如果未指定,默认为 "NFC"

    返回 string

padEnd

  • padEnd(maxLength: number, fillString?: string): string
  • 用给定的字符串(可能重复)填充当前字符串,使生成的字符串达到给定长度。填充从当前字符串的末尾(右侧)应用。

    参数

    • maxLength: number

      当前字符串填充后生成的字符串的长度。如果此参数小于当前字符串的长度,则返回当前字符串本身。

    • 可选 fillString: string

      用于填充当前字符串的字符串。如果此字符串太长,它将被截断并应用最左侧的部分。此参数的默认值为 " " (U+0020)。

    返回 string

padStart

  • padStart(maxLength: number, fillString?: string): string
  • 用给定的字符串(可能重复)填充当前字符串,使生成的字符串达到给定长度。填充从当前字符串的开头(左侧)应用。

    参数

    • maxLength: number

      当前字符串填充后生成的字符串的长度。如果此参数小于当前字符串的长度,则返回当前字符串本身。

    • 可选 fillString: string

      用于填充当前字符串的字符串。如果此字符串太长,它将被截断并应用最左侧的部分。此参数的默认值为 " " (U+0020)。

    返回 string

repeat

  • repeat(count: number): string
  • 返回一个由 count 个副本拼接而成的字符串值。如果 count 为 0,则返回空字符串。

    参数

    • count: number

      要拼接的副本数量

    返回 string

replace

  • replace(searchValue: string | RegExp, replaceValue: string): string
  • replace(searchValue: string | RegExp, replacer: (substring: string, ...args: any[]) => string): string
  • replace(searchValue: { [replace]: any }, replaceValue: string): string
  • replace(searchValue: { [replace]: any }, replacer: (substring: string, ...args: any[]) => string): string
  • 使用正则表达式或搜索字符串替换字符串中的文本。

    参数

    • searchValue: string | RegExp

      要搜索的字符串。

    • replaceValue: string

      包含用于替换此字符串中 searchValue 每次成功匹配的文本的字符串。

    返回 string

  • 使用正则表达式或搜索字符串替换字符串中的文本。

    参数

    • searchValue: string | RegExp

      要搜索的字符串。

    • replacer: (substring: string, ...args: any[]) => string

      返回替换文本的函数。

        • (substring: string, ...args: any[]): string
        • 参数

          • substring: string
          • 剩余参数 ...args: any[]

          返回 string

    返回 string

  • 使用支持在字符串中替换的对象替换字符串中的文本。

    参数

    • searchValue: { [replace]: any }

      可以在字符串中搜索和替换匹配项的对象。

      • [replace]: 函数
        • [replace](string: string, replaceValue: string): string
        • 参数

          • string: string
          • replaceValue: string

          返回 string

    • replaceValue: string

      包含用于替换此字符串中 searchValue 每次成功匹配的文本的字符串。

    返回 string

  • 使用支持在字符串中替换的对象替换字符串中的文本。

    参数

    • searchValue: { [replace]: any }

      可以在字符串中搜索和替换匹配项的对象。

      • [replace]: 函数
        • [replace](string: string, replacer: (substring: string, ...args: any[]) => string): string
        • 参数

          • string: string
          • replacer: (substring: string, ...args: any[]) => string
              • (substring: string, ...args: any[]): string
              • 参数

                • substring: string
                • 剩余参数 ...args: any[]

                返回 string

          返回 string

    • replacer: (substring: string, ...args: any[]) => string

      返回替换文本的函数。

        • (substring: string, ...args: any[]): string
        • 参数

          • substring: string
          • 剩余参数 ...args: any[]

          返回 string

    返回 string

replaceAll

  • replaceAll(searchValue: string | RegExp, replaceValue: string): string
  • replaceAll(searchValue: string | RegExp, replacer: (substring: string, ...args: any[]) => string): string
  • 使用正则表达式或搜索字符串替换字符串中所有子字符串实例。

    参数

    • searchValue: string | RegExp

      要搜索的字符串。

    • replaceValue: string

      包含用于替换此字符串中 searchValue 每次成功匹配的文本的字符串。

    返回 string

  • 使用正则表达式或搜索字符串替换字符串中所有子字符串实例。

    参数

    • searchValue: string | RegExp

      要搜索的字符串。

    • replacer: (substring: string, ...args: any[]) => string

      返回替换文本的函数。

        • (substring: string, ...args: any[]): string
        • 参数

          • substring: string
          • 剩余参数 ...args: any[]

          返回 string

    返回 string

search

  • search(regexp: string | RegExp): number
  • search(searcher: { [search]: any }): number
  • 在正则表达式搜索中查找第一个子字符串匹配项。

    参数

    • regexp: string | RegExp

      正则表达式模式和适用的标志。

    返回 number

  • 在正则表达式搜索中查找第一个子字符串匹配项。

    参数

    • searcher: { [search]: any }

      支持在字符串中搜索的对象。

      • [search]: 函数
        • [search](string: string): number
        • 参数

          • string: string

          返回 number

    返回 number

slice

  • slice(start?: number, end?: number): string
  • 返回字符串的一部分。

    参数

    • 可选 start: number

      stringObj 指定部分的开头索引。

    • 可选 end: number

      stringObj 指定部分的末尾索引。子字符串包含直到(但不包括)由 end 指示的字符。如果未指定此值,则子字符串将继续到 stringObj 的末尾。

    返回 string

small

  • small(): string
  • 返回一个 ` ` HTML 元素

    返回 string

split

  • split(separator: string | RegExp, limit?: number): string[]
  • split(splitter: { [split]: any }, limit?: number): string[]
  • 使用指定的分隔符将字符串拆分为子字符串,并将其作为数组返回。

    参数

    • separator: string | RegExp

      一个字符串,用于标识用于分隔字符串的字符或字符。如果省略,则返回包含整个字符串的单元素数组。

    • 可选 limit: number

      用于限制数组中返回元素数量的值。

    返回 string[]

  • 使用指定的分隔符将字符串拆分为子字符串,并将其作为数组返回。

    参数

    • splitter: { [split]: any }

      可以拆分字符串的对象。

      • [split]: 函数
        • [split](string: string, limit?: number): string[]
        • 参数

          • string: string
          • 可选 limit: number

          返回 string[]

    • 可选 limit: number

      用于限制数组中返回元素数量的值。

    返回 string[]

startsWith

  • startsWith(searchString: string, position?: number): boolean
  • 如果 searchString 的元素序列(转换为字符串)与此对象(转换为字符串)从 position 开始的相应元素相同,则返回 true。否则返回 false。

    参数

    • searchString: string
    • 可选 position: number

    返回 boolean

strike

  • strike(): string
  • 返回一个 ` ` HTML 元素

    返回 string

sub

  • sub(): string
  • 返回一个 ` ` HTML 元素

    返回 string

substr

  • substr(from: number, length?: number): string
  • 获取从指定位置开始且具有指定长度的子字符串。

    参数

    • from: number

      所需子字符串的起始位置。字符串中第一个字符的索引为零。

    • 可选 length: number

      要包含在返回子字符串中的字符数。

    返回 string

substring

  • substring(start: number, end?: number): string
  • 返回 String 对象中指定位置的子字符串。

    参数

    • start: number

      指示子字符串开头的零基索引号。

    • 可选 end: number

      零基索引号,指示子字符串的末尾。子字符串包含直到(但不包括)由 end 指示的字符。如果省略 end,则返回从 start 到原始字符串末尾的字符。

    返回 string

sup

  • sup(): string
  • 返回一个 ` ` HTML 元素

    返回 string

toLocaleLowerCase

  • toLocaleLowerCase(locales?: string | string[]): string
  • 将所有字母字符转换为小写,同时考虑宿主环境的当前区域设置。

    参数

    • 可选 locales: string | string[]

    返回 string

toLocaleUpperCase

  • toLocaleUpperCase(locales?: string | string[]): string
  • 返回一个字符串,其中所有字母字符都已转换为大写,同时考虑宿主环境的当前区域设置。

    参数

    • 可选 locales: string | string[]

    返回 string

toLowerCase

  • toLowerCase(): string
  • 将字符串中所有字母字符转换为小写。

    返回 string

toString

  • toString(): string
  • 返回字符串的字符串表示形式。

    返回 string

toUpperCase

  • toUpperCase(): string
  • 将字符串中所有字母字符转换为大写。

    返回 string

trim

  • trim(): string
  • 从字符串中移除开头和结尾的空格和行终止符。

    返回 string

trimEnd

  • trimEnd(): string
  • trimEnd(): string
  • 从字符串中移除末尾的空格和行终止符。

    返回 string

  • 返回一个移除了尾部空格的副本。

    返回 string

trimLeft

  • trimLeft(): string
  • trimLeft(): string
  • 从字符串中移除开头的空格和行终止符。

    返回 string

  • 从字符串左侧移除空格。

    返回 string

trimRight

  • trimRight(): string
  • trimRight(): string
  • 从字符串中移除末尾的空格和行终止符。

    返回 string

  • 从字符串右侧移除空格。

    返回 string

trimStart

  • trimStart(): string
  • trimStart(): string
  • 从字符串中移除开头的空格和行终止符。

    返回 string

  • 返回一个移除了头部空格的副本。

    返回 string

valueOf

  • valueOf(): string
  • 返回指定对象的原始值。

    返回 string

图例

使用 TypeDoc 生成