Support Menu

Interface IFieldOption

Interface IFieldOption

Declare a type for options that should contain a field to be used in a query.

The only constraint this type has over a basic string is that it should start with "@".

Index

Methods

charAt

  • charAt(pos: number): string

charCodeAt

  • charCodeAt(index: number): 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

concat

  • concat(...strings: string[]): string

indexOf

  • indexOf(searchString: string, position?: number): number
  • Returns the position of the first occurrence of a substring.

    Parameters

    • searchString: string

      The substring to search for in the string

    • Optional position: number

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

    Returns number

lastIndexOf

  • lastIndexOf(searchString: string, position?: number): number
  • Returns the last occurrence of a substring in the string.

    Parameters

    • searchString: string

      The substring to search for.

    • Optional position: number

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

    Returns number

localeCompare

  • localeCompare(that: string): number

match

  • match(regexp: string): RegExpMatchArray
  • match(regexp: RegExp): RegExpMatchArray
  • Matches a string with a regular expression, and returns an array containing the results of that search.

    Parameters

    • regexp: string

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

    Returns RegExpMatchArray

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

    Parameters

    • regexp: RegExp

      A regular expression object that contains the regular expression pattern and applicable flags.

    Returns RegExpMatchArray

replace

  • replace(searchValue: string, replaceValue: string): string
  • replace(searchValue: string, replacer: function): string
  • replace(searchValue: RegExp, replaceValue: string): string
  • replace(searchValue: RegExp, replacer: function): string
  • Replaces text in a string, using a regular expression or search string.

    Parameters

    • searchValue: string

      A string that represents the regular expression.

    • replaceValue: string

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

    Returns string

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

    Parameters

    • searchValue: string

      A string that represents the regular expression.

    • replacer: function

      A function that returns the replacement text.

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

          • substring: string
          • Rest ...args: any[]

          Returns string

    Returns string

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

    Parameters

    • searchValue: RegExp

      A Regular Expression object containing the regular expression pattern and applicable flags.

    • replaceValue: string

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

    Returns string

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

    Parameters

    • searchValue: RegExp

      A Regular Expression object containing the regular expression pattern and applicable flags

    • replacer: function

      A function that returns the replacement text.

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

          • substring: string
          • Rest ...args: any[]

          Returns string

    Returns string

search

  • search(regexp: string): number
  • search(regexp: RegExp): number

slice

  • slice(start?: number, end?: number): string
  • Returns a section of a string.

    Parameters

    • Optional start: number

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

    • Optional end: 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

split

  • split(separator: string, limit?: number): string[]
  • split(separator: RegExp, limit?: number): string[]
  • Split a string into substrings using the specified separator and return them as an array.

    Parameters

    • separator: string

      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: number

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

    Returns string[]

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

    Parameters

    • separator: RegExp

      A Regular Express 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: number

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

    Returns string[]

substr

  • substr(from: number, length?: number): 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.

    • Optional length: number

      The number of characters to include in the returned substring.

    Returns string

substring

  • substring(start: number, end?: number): 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.

    • Optional end: 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

toLocaleLowerCase

  • toLocaleLowerCase(): string

toLocaleUpperCase

  • toLocaleUpperCase(): string

toLowerCase

  • toLowerCase(): string

toString

  • toString(): string

toUpperCase

  • toUpperCase(): string

trim

  • trim(): string

valueOf

  • valueOf(): string

Properties

String

String: StringConstructor

Allows manipulation and formatting of text strings and determination and location of substrings within strings.

length

length: number

Returns the length of a String object.

Hierarchy

  • String

Indexable

[index: number]: string

Declare a type for options that should contain a field to be used in a query.

The only constraint this type has over a basic string is that it should start with "@".