Skip to content

PluginHookName

Signature

export type PluginHookName = keyof SeyfertPluginHooks & string;

Properties

readonly length: number;

Returns the length of a String object.

Methods

toString(): string;

Returns a string representation of a string.

charAt(pos: number): string;

Returns the character at the specified index.

Parameters
pos
The zero-based index of the desired character.
charCodeAt(index: number): number;

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

Parameters
index
The zero-based index of the desired character. If there is no character at the specified index, NaN is returned.
concat(...strings: string[]): string;

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

Parameters
strings
The strings to append to the end of the string.
indexOf(searchString: string, position?: number): number;

Returns the position of the first occurrence of a substring, or -1 if it is not present.

Parameters
searchString
The substring to search for in the string
position
The index at which to begin searching the String object. If omitted, search starts at the beginning of the string.
lastIndexOf(searchString: string, position?: number): number;

Returns the last occurrence of a substring in the string, or -1 if it is not present.

Parameters
searchString
The substring to search for.
position
The index at which to begin searching. If omitted, the search begins at the end of the string.
localeCompare(that: string): number;localeCompare(that: string, locales?: string | string[], options?: Intl.CollatorOptions): number;localeCompare(that: string, locales?: Intl.LocalesArgument, options?: Intl.CollatorOptions): number;

Determines whether two strings are equivalent in the current locale. Determines whether two strings are equivalent in the current or specified locale.

Parameters
that
String to compare to target string
that
String to compare to target string
locales
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.
options
An object that contains one or more properties that specify comparison options. see the Intl.Collator object for details.
that
String to compare to target string
locales
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.
options
An object that contains one or more properties that specify comparison options. see the Intl.Collator object for details.
match(regexp: string | RegExp): RegExpMatchArray | null;match(matcher: {    [Symbol.match](string: string): RegExpMatchArray | null;}): RegExpMatchArray | null;

Matches a string with a regular expression, and returns an array containing the results of that search. 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.

Parameters
regexp
A variable name or string literal containing the regular expression pattern and flags.
matcher
An object that supports being matched against.
replace(searchValue: string | RegExp, replaceValue: string): string;replace(searchValue: string | RegExp, replacer: (substring: string, ...args: any[]) => string): string;replace(searchValue: {    [Symbol.replace](string: string, replaceValue: string): string;}, replaceValue: string): string;replace(searchValue: {    [Symbol.replace](string: string, replacer: (substring: string, ...args: any[]) => string): string;}, replacer: (substring: string, ...args: any[]) => string): string;

Replaces text in a string, using a regular expression or search string. Passes a string and {@linkcode replaceValue} to the `[Symbol.replace]` method on {@linkcode 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.

Parameters
searchValue
A string or regular expression to search for.
replaceValue
A string containing the text to replace. When the {@linkcode 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 {@linkcode searchValue } is replaced.
searchValue
A string to search for.
replacer
A function that returns the replacement text.
searchValue
An object that supports searching for and replacing matches within a string.
replaceValue
The replacement text.
searchValue
A object can search for and replace matches within a string.
replacer
A function that returns the replacement text.
slice(start?: number, end?: number): string;

Returns a section of a string.

Parameters
start
The index to the beginning of the specified portion of stringObj.
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.
split(separator: string | RegExp, limit?: number): string[];split(splitter: {    [Symbol.split](string: string, limit?: number): string[];}, limit?: number): string[];

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

Parameters
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.
limit
A value used to limit the number of elements returned in the array.
splitter
An object that can split a string.
limit
A value used to limit the number of elements returned in the array.
substring(start: number, end?: number): string;

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

Parameters
start
The zero-based index number indicating the beginning of the substring.
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.
toLowerCase(): string;

Converts all the alphabetic characters in a string to lowercase.

toLocaleLowerCase(locales?: string | string[]): string;toLocaleLowerCase(locales?: Intl.LocalesArgument): string;

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

toUpperCase(): string;

Converts all the alphabetic characters in a string to uppercase.

toLocaleUpperCase(locales?: string | string[]): string;toLocaleUpperCase(locales?: Intl.LocalesArgument): string;

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

trim(): string;

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

substr(from: number, length?: number): string;

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

Deprecated

A legacy feature for browser compatibility

Parameters
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.
valueOf(): string;

Returns the primitive value of the specified object.

codePointAt(pos: number): number | undefined;

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.

includes(searchString: string, position?: number): 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.

Parameters
searchString
search string
position
If position is undefined, 0 is assumed, so as to search all of the String.
endsWith(searchString: string, endPosition?: number): 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.

normalize(form: "NFC" | "NFD" | "NFKC" | "NFKD"): string;normalize(form?: string): 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.

Parameters
form
Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"
form
Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"
repeat(count: number): string;

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

Parameters
count
number of copies to append
startsWith(searchString: string, position?: number): 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.

anchor(name: string): string;

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

Deprecated

A legacy feature for browser compatibility

Parameters
name
big(): string;

Returns a `<big>` HTML element

Deprecated

A legacy feature for browser compatibility

bold(): string;

Returns a `<b>` HTML element

Deprecated

A legacy feature for browser compatibility

fixed(): string;

Returns a `<tt>` HTML element

Deprecated

A legacy feature for browser compatibility

fontcolor(color: string): string;

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

Deprecated

A legacy feature for browser compatibility

fontsize(size: number): string;fontsize(size: string): string;

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

Deprecated

A legacy feature for browser compatibility

Deprecated

A legacy feature for browser compatibility

italics(): string;

Returns an `<i>` HTML element

Deprecated

A legacy feature for browser compatibility

small(): string;

Returns a `<small>` HTML element

Deprecated

A legacy feature for browser compatibility

strike(): string;

Returns a `<strike>` HTML element

Deprecated

A legacy feature for browser compatibility

sub(): string;

Returns a `<sub>` HTML element

Deprecated

A legacy feature for browser compatibility

sup(): string;

Returns a `<sup>` HTML element

Deprecated

A legacy feature for browser compatibility

padStart(maxLength: number, fillString?: string): 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.

Parameters
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.
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).
padEnd(maxLength: number, fillString?: string): 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.

Parameters
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.
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).
trimEnd(): string;

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

trimStart(): string;

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

trimLeft(): string;

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

Deprecated

A legacy feature for browser compatibility. Use `trimStart` instead

trimRight(): string;

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

Deprecated

A legacy feature for browser compatibility. Use `trimEnd` instead

matchAll(regexp: RegExp): RegExpStringIterator<RegExpExecArray>;

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

Parameters
regexp
A regular expression
replaceAll(searchValue: string | RegExp, replaceValue: string): string;replaceAll(searchValue: string | RegExp, replacer: (substring: string, ...args: any[]) => string): string;

Replace all instances of a substring in a string, using a regular expression or search string.

Parameters
searchValue
A string to search for.
replaceValue
A string containing the text to replace for every successful match of searchValue in this string.
searchValue
A string to search for.
replacer
A function that returns the replacement text.
at(index: number): string | undefined;

Returns a new String consisting of the single UTF-16 code unit located at the specified index.

Parameters
index
The zero-based index of the desired code unit. A negative index will count back from the last item.
isWellFormed(): boolean;

Returns true if all leading surrogates and trailing surrogates appear paired and in order.

toWellFormed(): string;

Returns a string where all lone or out-of-order surrogates have been replaced by the Unicode replacement character (U+FFFD).