Interface AutocompleteSearchParam

class: AutocompleteSearchParam

  • Search-as-You-Type

Hierarchy

  • AutocompleteSearchParam

Properties

$filter? $highlight? $limit? $page? $query

Properties

Optional $filter

$filter?: { [field: string]: string }

additional filter object.

Type declaration

  • [field: string]: string

Optional $highlight

$highlight?: string | boolean

highlighting

  • if boolean is given, turn on/off highlighting (default: false)
  • if string is given, replace default highlighting tags (default: 'em')

Optional $limit

$limit?: number

maximum results in a page (default: 10)

Optional $page

$page?: number

0-indexed page number (default: 0)

$query

$query: { [field: string]: string }

query object. key as field to search and value as string to match

Type declaration

  • [field: string]: string

Settings

Member Visibility

Theme

Generated using TypeDoc