Support Menu

Interface IFieldOption

Interface IFieldOption

The IFieldOption interface declares 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 the @ character.

Index

Methods

charAt

  • charAt(pos: number): string

charCodeAt

  • charCodeAt(index: number): number

concat

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

indexOf

  • indexOf(searchString: string, position?: number): number

lastIndexOf

  • lastIndexOf(searchString: string, position?: number): number

localeCompare

  • localeCompare(that: string): number

match

  • match(regexp: string | RegExp): RegExpMatchArray | null

replace

  • replace(searchValue: string | RegExp, replaceValue: string): string
  • replace(searchValue: string | RegExp, replacer: function): string

search

  • search(regexp: string | 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 | RegExp, limit?: number): 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.

    • 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

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

trimLeft

  • trimLeft(): string

trimRight

  • trimRight(): 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

The IFieldOption interface declares 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 the @ character.