Interface: ISearchParser<SearchCategory, SearchFilterType>

searchParser.ISearchParser

Type parameters #

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

Implemented by #

Methods #

parseSearchQuery #

parseSearchQuery(rawSearchQuery): undefined | ParsedSearchQuery<SearchCategory, SearchFilterType>

Parses the raw search query text into the search text and possibly search filters and categories

Parameters #

Name Type Description
rawSearchQuery string the raw search query text to parse

Returns #

undefined | ParsedSearchQuery<SearchCategory, SearchFilterType>

Defined in #

searchParser/ISearchParser.ts:8