Interface: ParsedSearchQuery<SearchCategory, SearchFilterType>

searchParser.ParsedSearchQuery

Type parameters #

Name Type
SearchCategory extends string = string
SearchFilterType extends string = string

Properties #

forceGlobalSearch #

forceGlobalSearch: boolean

If a global search box is used, this can reset back to full global search, instead of inferring a category from for example a currently shown datatable

Defined in #

searchParser/ParsedSearchQuery.ts:22


searchCategories #

searchCategories: SearchCategory[]

A list of categories to include items from

Defined in #

searchParser/ParsedSearchQuery.ts:12


searchFilters #

searchFilters: SearchFilter<SearchFilterType>[]

A list of filters, which each have a type and a value, to filter the resulting items with

Defined in #

searchParser/ParsedSearchQuery.ts:17


searchText #

searchText: string

Any text to search for in each item

Defined in #

searchParser/ParsedSearchQuery.ts:7