Type Alias VectaraComparisonResult

VectaraComparisonResult: {
 [iterator]: (() => IterableIterator<string>);
 anchor: ((name: string) => string);
 at: ((index: number) => undefined | string);
 big: (() => string);
 blink: (() => string);
 bold: (() => string);
 charAt: ((pos: number) => string);
 charCodeAt: ((index: number) => number);
 codePointAt: ((pos: number) => undefined | number);
 concat: ((...strings: string[]) => string);
 endsWith: ((searchString: string, endPosition?: number) => boolean);
 fixed: (() => string);
 fontcolor: ((color: string) => string);
 fontsize: {
 (size: number): string;
 (size: string): string;
 };
 includes: ((searchString: string, position?: number) => boolean);
 indexOf: ((searchString: string, position?: number) => number);
 italics: (() => string);
 lastIndexOf: ((searchString: string, position?: number) => number);
 length: number;
 link: ((url: string) => string);
 localeCompare: {
 (that: string): number;
 (that: string, locales?: string | string[], options?: CollatorOptions): number;
 };
 match: {
 (regexp: string | RegExp): null | RegExpMatchArray;
 (matcher: {
 [match](string: string): null | RegExpMatchArray;
 }): null | RegExpMatchArray;
 };
 matchAll: ((regexp: RegExp) => IterableIterator<RegExpMatchArray>);
 normalize: {
 (form:
 | "NFC"
 | "NFD"
 | "NFKC"
 | "NFKD"): string;
 (form?: string): string;
 };
 padEnd: ((maxLength: number, fillString?: string) => string);
 padStart: ((maxLength: number, fillString?: string) => string);
 repeat: ((count: number) => string);
 replace: {
 (searchValue: string | RegExp, replaceValue: string): string;
 (searchValue: string | RegExp, replacer: ((substring: string, ...args: any[]) => string)): string;
 (searchValue: {
 [replace](string: string, replaceValue: string): string;
 }, replaceValue: string): string;
 (searchValue: {
 [replace](string: string, replacer: ((substring: string, ...args: any[]) => string)): string;
 }, replacer: ((substring: string, ...args: any[]) => string)): string;
 };
 replaceAll: {
 (searchValue: string | RegExp, replaceValue: string): string;
 (searchValue: string | RegExp, replacer: ((substring: string, ...args: any[]) => string)): string;
 };
 search: {
 (regexp: string | RegExp): number;
 (searcher: {
 [search](string: string): number;
 }): number;
 };
 slice: ((start?: number, end?: number) => string);
 small: (() => string);
 split: {
 (separator: string | RegExp, limit?: number): string[];
 (splitter: {
 [split](string: string, limit?: number): string[];
 }, limit?: number): string[];
 };
 startsWith: ((searchString: string, position?: number) => boolean);
 strike: (() => string);
 sub: (() => string);
 substr: ((from: number, length?: number) => string);
 substring: ((start: number, end?: number) => string);
 sup: (() => string);
 toLocaleLowerCase: ((locales?: string | string[]) => string);
 toLocaleUpperCase: ((locales?: string | string[]) => string);
 toLowerCase: (() => string);
 toString: (() => string);
 toUpperCase: (() => string);
 trim: (() => string);
 trimEnd: (() => string);
 trimLeft: (() => string);
 trimRight: (() => string);
 trimStart: (() => string);
 valueOf: (() => string);
}

Type declaration

[iterator]: (() => IterableIterator<string>)
- - (): IterableIterator<string>
 - Iterator
 
 Returns IterableIterator<string>
anchor: ((name: string) => string)
- - (name): string
 - Returns an <a> HTML anchor element and sets the name attribute to the text value
 Parameters
 - name: string
 Returns string
 Deprecated
 A legacy feature for browser compatibility
at: ((index: number) => undefined | string)
- - (index): undefined | string
  - Takes an integer value and returns the item at that index, allowing for positive and negative integers. Negative integers count back from the last item in the array.
    Parameters
    - index: number
    Returns undefined | string
big: (() => string)
- - (): string
 - Returns a <big> HTML element
 
 Returns string
 Deprecated
 A legacy feature for browser compatibility
blink: (() => string)
- - (): string
 - Returns a <blink> HTML element
 
 Returns string
 Deprecated
 A legacy feature for browser compatibility
bold: (() => string)
- - (): string
 - Returns a  HTML element
 
 Returns string
 Deprecated
 A legacy feature for browser compatibility
charAt: ((pos: number) => string)
- - (pos): string
  - Returns the character at the specified index.
    Parameters
    - pos: number
      The zero-based index of the desired character.
    Returns string
charCodeAt: ((index: number) => number)
- - (index): number
  - Returns the Unicode value of the character at the specified location.
    Parameters
    - index: number
      The zero-based index of the desired character. If there is no character at the specified index, NaN is returned.
    Returns number
codePointAt: ((pos: number) => undefined | number)
- - (pos): undefined | number
  - 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.
    Parameters
    - pos: number
    Returns undefined | number
concat: ((...strings: string[]) => string)
- - (...strings): string
  - Returns a string that contains the concatenation of two or more strings.
    Parameters
    - Rest...strings: string[]
      The strings to append to the end of the string.
    Returns string
endsWith: ((searchString: string, endPosition?: number) => boolean)
- - (searchString, endPosition?): 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.
    Parameters
    - searchString: string
    - OptionalendPosition: number
    Returns boolean
fixed: (() => string)
- - (): string
 - Returns a <tt> HTML element
 
 Returns string
 Deprecated
 A legacy feature for browser compatibility
fontcolor: ((color: string) => string)
- - (color): string
 - Returns a  HTML element and sets the color attribute value
 Parameters
 - color: string
 Returns string
 Deprecated
 A legacy feature for browser compatibility
fontsize: {
(size: number): string;
(size: string): string;
}
- - (size): string
 - Returns a  HTML element and sets the size attribute value
 Parameters
 - size: number
 Returns string
 Deprecated
 A legacy feature for browser compatibility
 - (size): string
 - Returns a  HTML element and sets the size attribute value
 Parameters
 - size: string
 Returns string
 Deprecated
 A legacy feature for browser compatibility
includes: ((searchString: string, position?: number) => boolean)
- - (searchString, position?): 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: string
      search string
    - Optionalposition: number
      If position is undefined, 0 is assumed, so as to search all of the String.
    Returns boolean
indexOf: ((searchString: string, position?: number) => number)
- - (searchString, position?): number
  - Returns the position of the first occurrence of a substring.
    Parameters
    - searchString: string
      The substring to search for in the string
    - Optionalposition: number
      The index at which to begin searching the String object. If omitted, search starts at the beginning of the string.
    Returns number
italics: (() => string)
- - (): string
 - Returns an  HTML element
 
 Returns string
 Deprecated
 A legacy feature for browser compatibility
lastIndexOf: ((searchString: string, position?: number) => number)
- - (searchString, position?): number
  - Returns the last occurrence of a substring in the string.
    Parameters
    - searchString: string
      The substring to search for.
    - Optionalposition: number
      The index at which to begin searching. If omitted, the search begins at the end of the string.
    Returns number
length: number
link: ((url: string) => string)
- - (url): string
 - Returns an <a> HTML element and sets the href attribute value
 Parameters
 - url: string
 Returns string
 Deprecated
 A legacy feature for browser compatibility
localeCompare: {
(that: string): number;
(that: string, locales?: string | string[], options?: CollatorOptions): number;
}
- - (that): number
  - Determines whether two strings are equivalent in the current locale.
    Parameters
    - that: string
      String to compare to target string
    Returns number
  - (that, locales?, options?): number
  - Determines whether two strings are equivalent in the current or specified locale.
    Parameters
    - that: string
      String to compare to target string
    - Optionallocales: 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.
    - Optionaloptions: CollatorOptions
      An object that contains one or more properties that specify comparison options. see the Intl.Collator object for details.
    Returns number
match: {
    (regexp: string | RegExp): null | RegExpMatchArray;
    (matcher: {
        [match](string: string): null | RegExpMatchArray;
    }): null | RegExpMatchArray;
}
- - (regexp): null | RegExpMatchArray
  - Matches a string with a regular expression, and returns an array containing the results of that search.
    Parameters
    - regexp: string | RegExp
      A variable name or string literal containing the regular expression pattern and flags.
    Returns null | RegExpMatchArray
  - (matcher): null | RegExpMatchArray
  - 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
    - matcher: {
      [match](string: string): null | RegExpMatchArray;
      }
      An object that supports being matched against.
      
      [match]:function
      [match](string): null | RegExpMatchArray
      Parameters
      string: string
      Returns null | RegExpMatchArray
      Defined in node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:241
    Returns null | RegExpMatchArray
matchAll: ((regexp: RegExp) => IterableIterator<RegExpMatchArray>)
- - (regexp): IterableIterator<RegExpMatchArray>
 - Matches a string with a regular expression, and returns an iterable of matches containing the results of that search.
 Parameters
 - regexp: RegExp
 A variable name or string literal containing the regular expression pattern and flags.
 Returns IterableIterator<RegExpMatchArray>
normalize: {
    (form:
        | "NFC"
        | "NFD"
        | "NFKC"
        | "NFKD"): string;
    (form?: string): string;
}
- - (form): 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:
          | "NFC"
          | "NFD"
          | "NFKC"
          | "NFKD"
      Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"
    Returns string
  - (form?): 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
    - Optionalform: string
      Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"
    Returns string
padEnd: ((maxLength: number, fillString?: string) => string)
- - (maxLength, fillString?): 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: number
      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.
    - OptionalfillString: string
      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).
    Returns string
padStart: ((maxLength: number, fillString?: string) => string)
- - (maxLength, fillString?): 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: number
      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.
    - OptionalfillString: string
      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).
    Returns string
repeat: ((count: number) => string)
- - (count): 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
      number of copies to append
    Returns string
replace: {
    (searchValue: string | RegExp, replaceValue: string): string;
    (searchValue: string | RegExp, replacer: ((substring: string, ...args: any[]) => string)): string;
    (searchValue: {
        [replace](string: string, replaceValue: string): string;
    }, replaceValue: string): string;
    (searchValue: {
        [replace](string: string, replacer: ((substring: string, ...args: any[]) => string)): string;
    }, replacer: ((substring: string, ...args: any[]) => string)): string;
}
- - (searchValue, replaceValue): string
  - Replaces text in a string, using a regular expression or search string.
    Parameters
    - searchValue: string | RegExp
      A string or regular expression to search for.
    - replaceValue: string
      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.
    Returns string
  - (searchValue, replacer): string
  - Replaces text in a string, using a regular expression or search string.
    Parameters
    - searchValue: string | RegExp
      A string to search for.
    - replacer: ((substring: string, ...args: any[]) => string)
      A function that returns the replacement text.
      
      (substring, ...args): string
      Parameters
      substring: string
      Rest...args: any[]
      Returns string
    Returns string
  - (searchValue, replaceValue): string
  - Passes a string and replaceValue to the [Symbol.replace] method on searchValue. This method is expected to implement its own replacement algorithm.
    Parameters
    - searchValue: {
      [replace](string: string, replaceValue: string): string;
      }
      An object that supports searching for and replacing matches within a string.
      
      [replace]:function
      [replace](string, replaceValue): string
      Parameters
      string: string
      replaceValue: string
      Returns string
      Defined in node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:248
    - replaceValue: string
      The replacement text.
    Returns string
  - (searchValue, replacer): string
  - Replaces text in a string, using an object that supports replacement within a string.
    Parameters
    - searchValue: {
      [replace](string: string, replacer: ((substring: string, ...args: any[]) => string)): string;
      }
      A object can search for and replace matches within a string.
      
      [replace]:function
      [replace](string, replacer): string
      Parameters
      string: string
      replacer: ((substring: string, ...args: any[]) => string)
      (substring, ...args): string
      Parameters
      substring: string
      Rest...args: any[]
      Returns string
      Returns string
      Defined in node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:255
    - replacer: ((substring: string, ...args: any[]) => string)
      A function that returns the replacement text.
      
      (substring, ...args): string
      Parameters
      substring: string
      Rest...args: any[]
      Returns string
    Returns string
replaceAll: {
(searchValue: string | RegExp, replaceValue: string): string;
(searchValue: string | RegExp, replacer: ((substring: string, ...args: any[]) => string)): string;
}
- - (searchValue, replaceValue): string
  - Replace all instances of a substring in a string, using a regular expression or search string.
    Parameters
    - searchValue: string | RegExp
      A string to search for.
    - replaceValue: string
      A string containing the text to replace for every successful match of searchValue in this string.
    Returns string
  - (searchValue, replacer): string
  - Replace all instances of a substring in a string, using a regular expression or search string.
    Parameters
    - searchValue: string | RegExp
      A string to search for.
    - replacer: ((substring: string, ...args: any[]) => string)
      A function that returns the replacement text.
      
      (substring, ...args): string
      Parameters
      substring: string
      Rest...args: any[]
      Returns string
    Returns string
search: {
    (regexp: string | RegExp): number;
    (searcher: {
        [search](string: string): number;
    }): number;
}
- - (regexp): number
  - Finds the first substring match in a regular expression search.
    Parameters
    - regexp: string | RegExp
      The regular expression pattern and applicable flags.
    Returns number
  - (searcher): number
  - Finds the first substring match in a regular expression search.
    Parameters
    - searcher: {
      [search](string: string): number;
      }
      An object which supports searching within a string.
      
      [search]:function
      [search](string): number
      Parameters
      string: string
      Returns number
      Defined in node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:261
    Returns number
slice: ((start?: number, end?: number) => string)
- - (start?, end?): string
  - Returns a section of a string.
    Parameters
    - Optionalstart: number
      The index to the beginning of the specified portion of stringObj.
    - Optionalend: number
      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.
    Returns string
small: (() => string)
- - (): string
 - Returns a  HTML element
 
 Returns string
 Deprecated
 A legacy feature for browser compatibility
split: {
    (separator: string | RegExp, limit?: number): string[];
    (splitter: {
        [split](string: string, limit?: number): string[];
    }, limit?: number): string[];
}
- - (separator, limit?): string[]
  - Split a string into substrings using the specified separator and return them as an array.
    Parameters
    - separator: string | RegExp
      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.
    - Optionallimit: number
      A value used to limit the number of elements returned in the array.
    Returns string[]
  - (splitter, limit?): string[]
  - Split a string into substrings using the specified separator and return them as an array.
    Parameters
    - splitter: {
      [split](string: string, limit?: number): string[];
      }
      An object that can split a string.
      
      [split]:function
      [split](string, limit?): string[]
      Parameters
      string: string
      Optionallimit: number
      Returns string[]
      Defined in node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:268
    - Optionallimit: number
      A value used to limit the number of elements returned in the array.
    Returns string[]
startsWith: ((searchString: string, position?: number) => boolean)
- - (searchString, position?): 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.
    Parameters
    - searchString: string
    - Optionalposition: number
    Returns boolean
strike: (() => string)
- - (): string
 - Returns a <strike> HTML element
 
 Returns string
 Deprecated
 A legacy feature for browser compatibility
sub: (() => string)
- - (): string
 - Returns a  HTML element
 
 Returns string
 Deprecated
 A legacy feature for browser compatibility
substr: ((from: number, length?: number) => string)
- - (from, length?): string
  - Gets a substring beginning at the specified location and having the specified length.
    Parameters
    - from: number
      The starting position of the desired substring. The index of the first character in the string is zero.
    - Optionallength: number
      The number of characters to include in the returned substring.
    Returns string
    Deprecated
    A legacy feature for browser compatibility
substring: ((start: number, end?: number) => string)
- - (start, end?): string
  - Returns the substring at the specified location within a String object.
    Parameters
    - start: number
      The zero-based index number indicating the beginning of the substring.
    - Optionalend: number
      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.
    Returns string
sup: (() => string)
- - (): string
 - Returns a  HTML element
 
 Returns string
 Deprecated
 A legacy feature for browser compatibility
toLocaleLowerCase: ((locales?: string | string[]) => string)
- - (locales?): string
  - Converts all alphabetic characters to lowercase, taking into account the host environment's current locale.
    Parameters
    - Optionallocales: string | string[]
    Returns string
toLocaleUpperCase: ((locales?: string | string[]) => string)
- - (locales?): string
  - Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale.
    Parameters
    - Optionallocales: string | string[]
    Returns string
toLowerCase: (() => string)
- - (): string
  - Converts all the alphabetic characters in a string to lowercase.
    
    Returns string
toString: (() => string)
- - (): string
  - Returns a string representation of a string.
    
    Returns string
toUpperCase: (() => string)
- - (): string
  - Converts all the alphabetic characters in a string to uppercase.
    
    Returns string
trim: (() => string)
- - (): string
  - Removes the leading and trailing white space and line terminator characters from a string.
    
    Returns string
trimEnd: (() => string)
- - (): string
  - Removes the trailing white space and line terminator characters from a string.
    
    Returns string
trimLeft: (() => string)
- - (): string
  - Removes the leading white space and line terminator characters from a string.
    
    Returns string
    Deprecated
    A legacy feature for browser compatibility. Use trimStart instead
trimRight: (() => string)
- - (): string
  - Removes the trailing white space and line terminator characters from a string.
    
    Returns string
    Deprecated
    A legacy feature for browser compatibility. Use trimEnd instead
trimStart: (() => string)
- - (): string
  - Removes the leading white space and line terminator characters from a string.
    
    Returns string
valueOf: (() => string)
- - (): string
  - Returns the primitive value of the specified object.
    
    Returns string

Type Alias VectaraComparisonResult

Type declaration

[iterator]: (() => IterableIterator<string>)

Returns IterableIterator<string>

anchor: ((name: string) => string)

Parameters

Returns string

Deprecated

at: ((index: number) => undefined | string)

Parameters

Returns undefined | string

big: (() => string)

Returns string

Deprecated

blink: (() => string)

Returns string

Deprecated

bold: (() => string)

Returns string

Deprecated

charAt: ((pos: number) => string)

Parameters

Returns string

charCodeAt: ((index: number) => number)

Parameters

Returns number

codePointAt: ((pos: number) => undefined | number)

Parameters

Returns undefined | number

concat: ((...strings: string[]) => string)

Parameters

Returns string

endsWith: ((searchString: string, endPosition?: number) => boolean)

Parameters

Returns boolean

fixed: (() => string)

Returns string

Deprecated

fontcolor: ((color: string) => string)

Parameters

Returns string

Deprecated

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

Parameters

Returns string

Deprecated

Parameters

Returns string

Deprecated

includes: ((searchString: string, position?: number) => boolean)

Parameters

Returns boolean

indexOf: ((searchString: string, position?: number) => number)

Parameters

Returns number

italics: (() => string)

Returns string

Deprecated

lastIndexOf: ((searchString: string, position?: number) => number)

Parameters

Returns number

length: number

link: ((url: string) => string)

Parameters

Returns string

Deprecated

localeCompare: { (that: string): number; (that: string, locales?: string | string[], options?: CollatorOptions): number; }

Parameters

Returns number

Parameters

Returns number

match: { (regexp: string | RegExp): null | RegExpMatchArray; (matcher: { [match](string: string): null | RegExpMatchArray; }): null | RegExpMatchArray; }

Parameters

Returns null | RegExpMatchArray

Parameters

[match]:function

Parameters

Returns null | RegExpMatchArray

Returns null | RegExpMatchArray

matchAll: ((regexp: RegExp) => IterableIterator<RegExpMatchArray>)

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

localeCompare: {
(that: string): number;
(that: string, locales?: string | string[], options?: CollatorOptions): number;
}

match: {
(regexp: string | RegExp): null | RegExpMatchArray;
(matcher: {
[match](string: string): null | RegExpMatchArray;
}): null | RegExpMatchArray;
}

normalize: {
(form:
| "NFC"
| "NFD"
| "NFKC"
| "NFKD"): string;
(form?: string): string;
}

replaceAll: {
(searchValue: string | RegExp, replaceValue: string): string;
(searchValue: string | RegExp, replacer: ((substring: string, ...args: any[]) => string)): string;
}

search: {
(regexp: string | RegExp): number;
(searcher: {
[search](string: string): number;
}): number;
}

split: {
(separator: string | RegExp, limit?: number): string[];
(splitter: {
[split](string: string, limit?: number): string[];
}, limit?: number): string[];
}