Optional value: anyReadonly lengthReturns 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 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.
Optional endPosition: numberReturns a <font> HTML element and sets the size attribute value
A legacy feature for browser compatibility
Returns a <font> HTML element and sets the size attribute value
A legacy feature for browser compatibility
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.
search string
Optional position: numberIf position is undefined, 0 is assumed, so as to search all of the String.
Returns the position of the first occurrence of a substring.
The substring to search for in the string
Optional position: numberThe index at which to begin searching the String object. If omitted, search starts at the beginning of the string.
Determines whether two strings are equivalent in the current locale.
String to compare to target string
Determines whether two strings are equivalent in the current or specified locale.
String to compare to target string
Optional locales: string | string[]A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. This parameter must conform to BCP 47 standards; see the Intl.Collator object for details.
Optional options: CollatorOptionsAn object that contains one or more properties that specify comparison options. see the Intl.Collator object for details.
Matches a string with a regular expression, and returns an array containing the results of that search.
A variable name or string literal containing the regular expression pattern and flags.
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 with a regular expression, and returns an iterable of matches containing the results of that search.
A variable name or string literal containing the regular expression pattern and flags.
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.
Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"
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.
Optional form: stringApplicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"
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.
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.
Optional fillString: stringThe 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).
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.
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.
Optional fillString: stringThe 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).
Replaces text in a string, using a regular expression or search string.
A string or regular expression to search for.
A string containing the text to replace. When the searchValue is a RegExp, all matches are replaced if the g flag is set (or only those matches at the beginning, if the y flag is also present). Otherwise, only the first match of searchValue is replaced.
Replaces text in a string, using a regular expression or search string.
A string to search for.
A function that returns the replacement text.
Rest ...args: any[]Passes a string and replaceValue to the [Symbol.replace] method on searchValue. This method is expected to implement its own replacement algorithm.
Replaces text in a string, using an object that supports replacement within a string.
A object can search for and replace matches within a string.
A function that returns the replacement text.
Rest ...args: any[]Returns a section of a string.
Optional start: numberThe index to the beginning of the specified portion of stringObj.
Optional end: numberThe 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.
Split a string into substrings using the specified separator and return them as an array.
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.
Optional limit: numberA value used to limit the number of elements returned in the array.
Split a string into substrings using the specified separator and return them as an array.
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.
Optional position: numberGets a substring beginning at the specified location and having the specified length.
The starting position of the desired substring. The index of the first character in the string is zero.
Optional length: numberThe number of characters to include in the returned substring.
A legacy feature for browser compatibility
Returns the substring at the specified location within a String object.
The zero-based index number indicating the beginning of the substring.
Optional end: numberZero-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.
Static capitalizeStatic charThe function charAt takes a string and an index as input and returns the character at the
specified index in the string.
A string
The index parameter in the charAt function represents the position of
the character you want to retrieve from the str string. It is a number that indicates the
zero-based index of the character you want to access.
The charAt function is returning the character at the specified index in the given
string.
Static charThe function charCodeAt takes a string and an index, and returns the Unicode value of the
character at that index in the string.
a string
The index parameter in the charCodeAt function represents the position
of the character in the string str for which you want to retrieve the Unicode value. The index
is a zero-based integer value indicating the position of the character in the string.
The charCodeAt function is returning the Unicode value of the character at the
specified index in the given string.
Static concatenateStatic endsThe function endsWith checks if a string ends with a specified search value.
a strubg
The searchValue parameter is the string that the endsWith method
will check if the input string ends with.
Optional position: numberThe position parameter in the endsWith function is an optional
parameter that specifies the position within the string at which to stop searching for the
specified searchValue. If provided, the endsWith function will only search within the
substring starting from the beginning of the string up to the specified position
The endsWith method is being called on the str string with the searchValue and
optional position arguments, and the result of this method call is being returned as a boolean
value.
Static fromStatic fromStatic includesThe static includes function checks if a string includes a specific search value at an optional specified position.
a string
The searchValue parameter is the string that you want to search
for within the str string.
Optional position: numberThe position parameter in the includes function is an optional
parameter that specifies the position within the string at which to begin searching for the
searchValue. If provided, the includes function will start searching for the searchValue at
the specified position within the str string
The includes function is returning a boolean value indicating whether the searchValue
is found within the str string starting from the optional position index.
Static indexThe indexOf function in TypeScript returns the index of the first occurrence of a specified
value within a string, starting the search at a specified index if provided.
a string
The searchValue parameter is the string that you want to find
within the str string.
Optional fromIndex: numberThe fromIndex parameter in the indexOf function is an optional
parameter that specifies the index at which to start the search for the searchValue within the
str string. If provided, the search will start at the specified index. If not provided, the
search will start at
The indexOf method is being called on the str string with the searchValue and
optional fromIndex parameters. The method returns the index of the first occurrence of the
searchValue within the str string, starting the search at the optional fromIndex if
provided.
Static lastThe function lastIndexOf returns the index of the last occurrence of a specified value within a
string.
a string
The searchValue parameter is the string value that you want to
find within the str string.
Optional fromIndex: numberThe fromIndex parameter in the lastIndexOf function is an
optional parameter that specifies the index at which to start searching backwards in the string.
If this parameter is not provided, the search will start from the end of the string.
The lastIndexOf method is being called on the str string with the searchValue and
optional fromIndex parameters. The method returns the index within the calling String object of
the last occurrence of the specified value, searching backwards from the specified index
fromIndex.
Static rawString.raw is usually used as a tag function of a Tagged Template String. When called as such, the first argument will be a well formed template call site object and the rest parameter will contain the substitution values. It can also be called directly, for example, to interleave strings and values from your own tag function, and in this case the only thing it needs from the first argument is the raw property.
A well-formed template string call site representation.
Rest ...substitutions: any[]A set of substitution values.
Static repeatThe repeat function takes a string and a count, and returns the string repeated the specified
number of times.
a string
The count parameter specifies the number of times the str parameter
should be repeated in the repeat function.
The repeat function is returning a new string that is the concatenation of the input
string str repeated count number of times.
Static replaceThe function replaces all occurrences of a specified search value in a string with a specified replace value.
a string
The searchValue parameter in the replace function can
be either a string or a regular expression. It is the value that you want to search for in the
input string str and replace with the replaceValue.
The replaceValue parameter in the replace function is the value
that will replace the searchValue in the input str string. It can be a string that will
replace all occurrences of the searchValue in the input string.
The replace function is returning a modified string where all occurrences of the
searchValue have been replaced with the replaceValue.
Static reverseThe reverse function in TypeScript takes a string as input and returns the reversed version of
that string.
a string
The reverse function takes a string as input, splits it into an array of characters,
reverses the order of the characters in the array, and then joins them back together into a new
string. The function returns this new string that has the characters in reverse order.
Static sliceThe slice function takes a string, a starting index, and an optional ending index, and returns a
substring based on the indices provided.
a string
The start parameter in the slice function represents the index at
which to begin extraction. This means that the function will start slicing the string from the
character at the index specified by the start parameter.
Optional end: numberThe end parameter in the slice function is an optional parameter that
specifies the end index at which to end the extraction of characters from the string. If the end
parameter is not provided, the extraction will continue to the end of the string.
The slice method is being called on the str string with the start and optional
end parameters. The method returns a new string that is a subset of the original string starting
from the start index up to (but not including) the end index.
Static splitThe split function in TypeScript splits a string into an array of substrings based on a
specified separator and optional limit.
a string
The separator parameter in the split function is used to
specify the character or regular expression at which the str should be split into an array of
substrings.
Optional limit: numberThe limit parameter in the split function specifies the maximum
number of splits to be performed on the input string. If the limit parameter is provided, the
split function will split the input string into substrings at each occurrence of the specified
separator up to the limit specified.
The split function is returning an array of strings after splitting the input str
based on the separator and limit provided.
Static startsThis static function checks if a string starts with a specified search value at an optional position.
a string
The searchValue parameter is the string that the startsWith
method will check if the given string str starts with.
Optional position: numberThe position parameter in the startsWith function is an optional
parameter that specifies the position within the string at which to begin searching for the
searchValue. If provided, the function will only check if the string starts with the
searchValue starting from the specified position. If not provided
The startsWith method is being returned, which checks if a string starts with the
specified value.
Static substringThe function "substring" takes a string, a start index, and an optional end index, and returns a substring of the original string based on the provided indices.
a string
The start parameter in the substring function represents the index at
which to begin extracting characters from the string.
Optional end: numberThe end parameter in the substring function is an optional parameter
that specifies the index at which to end the extraction of characters from the string. If the
end parameter is not provided, the extraction will continue to the end of the string.
The substring function is returning a substring of the input string str starting at
the index start and ending at the index end (if provided).
Static toThe function toLowerCase takes a string as input and returns the string converted to lowercase.
The parameter str is a string that represents the input text that you want
to convert to lowercase.
The toLowerCase method is being called on the input string str, converting all
characters to lowercase, and then returning the resulting lowercase string.
Static toStatic trimGenerated using TypeDoc
Returns the length of a String object.