String

@native @JSType trait String extends StObject with NumberDictionary[String]
trait NumberDictionary[String]
trait StObject
class Object
trait Any
class Object
trait Matchable
class Any
class String

Value members

Concrete methods

def `match`(matcher: Match): RegExpMatchArray | Null

Matches a string or an object that supports being matched against, and returns an array containing the results of that search, or null if no matches are found.

Matches a string or an object that supports being matched against, and returns an array containing the results of that search, or null if no matches are found.

Value Params
matcher

An object that supports being matched against.

def `match`(regexp: String): RegExpMatchArray | Null

Matches a string with a regular expression, and returns an array containing the results of that search.

Matches a string with a regular expression, and returns an array containing the results of that search.

Value Params
regexp

A variable name or string literal containing the regular expression pattern and flags.

def `match`(regexp: RegExp): RegExpMatchArray | Null
def anchor(name: String): String

Returns an <a> HTML anchor element and sets the name attribute to the text value

Returns an <a> HTML anchor element and sets the name attribute to the text value

def big(): String

Returns a <big> HTML element

Returns a <big> HTML element

def bold(): String

Returns a <b> HTML element

Returns a <b> HTML element

def charAt(pos: Double): String

Returns the character at the specified index.

Returns the character at the specified index.

Value Params
pos

The zero-based index of the desired character.

def charCodeAt(index: Double): Double

Returns the Unicode value of the character at the specified location.

Returns the Unicode value of the character at the specified location.

Value Params
index

The zero-based index of the desired character. If there is no character at the specified index, NaN is returned.

def codePointAt(pos: Double): UndefOr[Double]

Returns a nonnegative integer Number less than 1114112 (0x110000) that is the code point value of the UTF-16 encoded code point starting at the string element at position pos in the String resulting from converting this object to a String. If there is no element at that position, the result is undefined. If a valid UTF-16 surrogate pair does not begin at pos, the result is the code unit at pos.

Returns a nonnegative integer Number less than 1114112 (0x110000) that is the code point value of the UTF-16 encoded code point starting at the string element at position pos in the String resulting from converting this object to a String. If there is no element at that position, the result is undefined. If a valid UTF-16 surrogate pair does not begin at pos, the result is the code unit at pos.

def concat(strings: String*): String

Returns a string that contains the concatenation of two or more strings.

Returns a string that contains the concatenation of two or more strings.

Value Params
strings

The strings to append to the end of the string.

def endsWith(searchString: String): Boolean

Returns true if the sequence of elements of searchString converted to a String is the same as the corresponding elements of this object (converted to a String) starting at endPosition – length(this). Otherwise returns false.

Returns true if the sequence of elements of searchString converted to a String is the same as the corresponding elements of this object (converted to a String) starting at endPosition – length(this). Otherwise returns false.

def endsWith(searchString: String, endPosition: Double): Boolean
def fixed(): String

Returns a <tt> HTML element

Returns a <tt> HTML element

def fontcolor(color: String): String

Returns a <font> HTML element and sets the color attribute value

Returns a <font> HTML element and sets the color attribute value

def fontsize(size: String): String

Returns a <font> HTML element and sets the size attribute value

Returns a <font> HTML element and sets the size attribute value

def fontsize(size: Double): String

Returns a <font> HTML element and sets the size attribute value

Returns a <font> HTML element and sets the size attribute value

def includes(searchString: String): Boolean

Returns true if searchString appears as a substring of the result of converting this object to a String, at one or more positions that are greater than or equal to position; otherwise, returns false.

Returns true if searchString appears as a substring of the result of converting this object to a String, at one or more positions that are greater than or equal to position; otherwise, returns false.

Value Params
position

If position is undefined, 0 is assumed, so as to search all of the String.

searchString

search string

def includes(searchString: String, position: Double): Boolean
def indexOf(searchString: String): Double

Returns the position of the first occurrence of a substring.

Returns the position of the first occurrence of a substring.

Value Params
position

The index at which to begin searching the String object. If omitted, search starts at the beginning of the string.

searchString

The substring to search for in the string

def indexOf(searchString: String, position: Double): Double
def italics(): String

Returns an <i> HTML element

Returns an <i> HTML element

def lastIndexOf(searchString: String): Double

Returns the last occurrence of a substring in the string.

Returns the last occurrence of a substring in the string.

Value Params
position

The index at which to begin searching. If omitted, the search begins at the end of the string.

searchString

The substring to search for.

def lastIndexOf(searchString: String, position: Double): Double
def localeCompare(that: String): Double

Determines whether two strings are equivalent in the current locale.

Determines whether two strings are equivalent in the current locale.

Value Params
that

String to compare to target string

def localeCompare(that: String, locales: String): Double
def localeCompare(that: String, locales: String, options: CollatorOptions): Double
def localeCompare(that: String, locales: Array[String]): Double
def localeCompare(that: String, locales: Array[String], options: CollatorOptions): Double
def localeCompare(that: String, locales: Unit, options: CollatorOptions): Double

Matches a string with a regular expression, and returns an iterable of matches containing the results of that search.

Matches a string with a regular expression, and returns an iterable of matches containing the results of that search.

Value Params
regexp

A variable name or string literal containing the regular expression pattern and flags.

def normalize(): String

Returns the String value result of normalizing the string into the normalization form named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.

Returns the String value result of normalizing the string into the normalization form named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.

Value Params
form

Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"

def normalize(form: String): String
@JSName("normalize")
def normalize_NFC(form: NFC): String

Returns the String value result of normalizing the string into the normalization form named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.

Returns the String value result of normalizing the string into the normalization form named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.

Value Params
form

Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"

@JSName("normalize")
def normalize_NFD(form: NFD): String
@JSName("normalize")
def normalize_NFKC(form: NFKC): String
@JSName("normalize")
def normalize_NFKD(form: NFKD): String
def padEnd(maxLength: Double): String

Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the end (right) of the current string.

Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the end (right) of the current string.

Value Params
fillString

The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).

maxLength

The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.

def padEnd(maxLength: Double, fillString: String): String
def padStart(maxLength: Double): String

Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the start (left) of the current string.

Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the start (left) of the current string.

Value Params
fillString

The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).

maxLength

The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.

def padStart(maxLength: Double, fillString: String): String
def repeat(count: Double): String

Returns a String value that is made from count copies appended together. If count is 0, the empty string is returned.

Returns a String value that is made from count copies appended together. If count is 0, the empty string is returned.

Value Params
count

number of copies to append

def replace(searchValue: Replace, replaceValue: String): String

Replaces text in a string, using an object that supports replacement within a string.

Replaces text in a string, using an object that supports replacement within a string.

Value Params
replaceValue

A string containing the text to replace for every successful match of searchValue in this string.

searchValue

A object can search for and replace matches within a string.

def replace(searchValue: 0, replacer: Function2[String, Any, String]): String

Replaces text in a string, using an object that supports replacement within a string.

Replaces text in a string, using an object that supports replacement within a string.

Value Params
replacer

A function that returns the replacement text.

searchValue

A object can search for and replace matches within a string.

def replace(searchValue: String, replaceValue: String): String

Replaces text in a string, using a regular expression or search string.

Replaces text in a string, using a regular expression or search string.

Value Params
replaceValue

A string containing the text to replace for every successful match of searchValue in this string.

searchValue

A string to search for.

def replace(searchValue: String, replacer: Function2[String, Any, String]): String

Replaces text in a string, using a regular expression or search string.

Replaces text in a string, using a regular expression or search string.

Value Params
replacer

A function that returns the replacement text.

searchValue

A string to search for.

def replace(searchValue: RegExp, replaceValue: String): String
def replace(searchValue: RegExp, replacer: Function2[String, Any, String]): String
def search(regexp: String): Double

Finds the first substring match in a regular expression search.

Finds the first substring match in a regular expression search.

Value Params
regexp

The regular expression pattern and applicable flags.

def search(regexp: RegExp): Double
def search(searcher: Search): Double

Finds the first substring match in a regular expression search.

Finds the first substring match in a regular expression search.

Value Params
searcher

An object which supports searching within a string.

def slice(): String

Returns a section of a string.

Returns a section of a string.

Value Params
end

The index to the end of the specified portion of stringObj. The substring includes the characters up to, but not including, the character indicated by end. If this value is not specified, the substring continues to the end of stringObj.

start

The index to the beginning of the specified portion of stringObj.

def slice(start: Double): String
def slice(start: Double, end: Double): String
def slice(start: Unit, end: Double): String
def small(): String

Returns a <small> HTML element

Returns a <small> HTML element

def split(separator: String): Array[String]

Split a string into substrings using the specified separator and return them as an array.

Split a string into substrings using the specified separator and return them as an array.

Value Params
limit

A value used to limit the number of elements returned in the array.

separator

A string that identifies character or characters to use in separating the string. If omitted, a single-element array containing the entire string is returned.

def split(separator: String, limit: Double): Array[String]
def split(separator: RegExp): Array[String]
def split(separator: RegExp, limit: Double): Array[String]
def split(splitter: Split): Array[String]

Split a string into substrings using the specified separator and return them as an array.

Split a string into substrings using the specified separator and return them as an array.

Value Params
limit

A value used to limit the number of elements returned in the array.

splitter

An object that can split a string.

def split(splitter: Split, limit: Double): Array[String]
def startsWith(searchString: String): Boolean

Returns true if the sequence of elements of searchString converted to a String is the same as the corresponding elements of this object (converted to a String) starting at position. Otherwise returns false.

Returns true if the sequence of elements of searchString converted to a String is the same as the corresponding elements of this object (converted to a String) starting at position. Otherwise returns false.

def startsWith(searchString: String, position: Double): Boolean
def strike(): String

Returns a <strike> HTML element

Returns a <strike> HTML element

def sub(): String

Returns a <sub> HTML element

Returns a <sub> HTML element

def substr(from: Double): String

Gets a substring beginning at the specified location and having the specified length.

Gets a substring beginning at the specified location and having the specified length.

Value Params
from

The starting position of the desired substring. The index of the first character in the string is zero.

length

The number of characters to include in the returned substring.

def substr(from: Double, length: Double): String
def substring(start: Double): String

Returns the substring at the specified location within a String object.

Returns the substring at the specified location within a String object.

Value Params
end

Zero-based index number indicating the end of the substring. The substring includes the characters up to, but not including, the character indicated by end. If end is omitted, the characters from start through the end of the original string are returned.

start

The zero-based index number indicating the beginning of the substring.

def substring(start: Double, end: Double): String
def sup(): String

Returns a <sup> HTML element

Returns a <sup> HTML element

def toLocaleLowerCase(): String

Converts all alphabetic characters to lowercase, taking into account the host environment's current locale.

Converts all alphabetic characters to lowercase, taking into account the host environment's current locale.

def toLocaleLowerCase(locales: String): String
def toLocaleLowerCase(locales: Array[String]): String
def toLocaleUpperCase(): String

Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale.

Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale.

def toLocaleUpperCase(locales: String): String
def toLocaleUpperCase(locales: Array[String]): String
def toLowerCase(): String

Converts all the alphabetic characters in a string to lowercase.

Converts all the alphabetic characters in a string to lowercase.

def toUpperCase(): String

Converts all the alphabetic characters in a string to uppercase.

Converts all the alphabetic characters in a string to uppercase.

def trim(): String

Removes the leading and trailing white space and line terminator characters from a string.

Removes the leading and trailing white space and line terminator characters from a string.

def trimEnd(): String

Removes the trailing white space and line terminator characters from a string.

Removes the trailing white space and line terminator characters from a string.

def trimLeft(): String

Removes the leading white space and line terminator characters from a string.

Removes the leading white space and line terminator characters from a string.

def trimRight(): String

Removes the trailing white space and line terminator characters from a string.

Removes the trailing white space and line terminator characters from a string.

def trimStart(): String

Removes the leading white space and line terminator characters from a string.

Removes the leading white space and line terminator characters from a string.

Inherited methods

def hasOwnProperty(v: String): Boolean
Inherited from
Object
def isPrototypeOf(v: Object): Boolean
Inherited from
Object
def propertyIsEnumerable(v: String): Boolean
Inherited from
Object
def toLocaleString(): String
Inherited from
Object
def valueOf(): Any
Inherited from
Object

Concrete fields

@JSName
var iterator: Function0[IterableIterator[String]]

Iterator

Iterator

val length: Double

Returns the length of a String object.

Returns the length of a String object.