SearchQueryBuilder
Class
SearchQueryBuilder
can be used to construct the q
param for searchItems
or searchGroups
.
By chaining methods, it helps build complex search queries.
Will search for items matching
Implements
Constructors
constructor
Class Constructornew SearchQueryBuilder(q: string): SearchQueryBuilder
Parameters
Parameter | Type | Default | Notes |
---|---|---|---|
q | string | "" | An existing query string to start building from. |
Returns
SearchQueryBuilder
Methods
Method | Returns | Notes |
---|---|---|
and() | Joins two sets of queries with an | |
boost(num) | Boosts the previous term to increase its rank in the results. | |
clone() | Returns a new instance of | |
endGroup() | Ends a search group. | |
from(term) | Begins a new range query. | |
in(field?) | Defines fields to search in. You can pass | |
match(terms) | Defines strings to search for. | |
not() | Joins two sets of queries with a | |
or() | Joins two sets of queries with an | |
Starts a new search group. | ||
to(term) | Ends a range query. | |
toParam() | string | Returns the current query string. Called internally when the request is made. |
and
Class Methodand(): SearchQueryBuilder
Joins two sets of queries with an AND
clause.
Returns
SearchQueryBuilder
boost
Class Methodboost(num: number): SearchQueryBuilder
Boosts the previous term to increase its rank in the results.
Parameters
Parameter | Type |
---|---|
num | number |
Returns
SearchQueryBuilder
clone
Class Methodclone(): SearchQueryBuilder
Returns a new instance of SearchQueryBuilder
based on the current instance.
Returns
SearchQueryBuilder
endGroup
Class MethodendGroup(): SearchQueryBuilder
Ends a search group.
Returns
SearchQueryBuilder
from
Class Methodfrom(term: string | number | Date): SearchQueryBuilder
Begins a new range query.
Parameters
Parameter | Type |
---|---|
term | string | number | Date |
Returns
SearchQueryBuilder
in
Class Methodin(field?: string): SearchQueryBuilder
Defines fields to search in. You can pass "*"
or call this method without arguments to search a default set of fields
Parameters
Parameter | Type | Notes |
---|---|---|
field | string | The field to search for the previous match in. |
Returns
SearchQueryBuilder
match
Class Methodmatch(terms: string[]): SearchQueryBuilder
Defines strings to search for.
Parameters
Parameter | Type | Notes |
---|---|---|
terms | string[] | strings to search for. |
Returns
SearchQueryBuilder
not
Class Methodnot(): SearchQueryBuilder
Joins two sets of queries with a NOT
clause. Another option for filtering results is the prohibit operator '-'.
Returns
SearchQueryBuilder
or
Class Methodor(): SearchQueryBuilder
Joins two sets of queries with an OR
clause.
Returns
SearchQueryBuilder
startGroup
Class MethodstartGroup(): SearchQueryBuilder
Starts a new search group.
Returns
SearchQueryBuilder
to
Class Methodto(term: any): SearchQueryBuilder
Ends a range query.
Parameters
Parameter | Type |
---|---|
term | any |
Returns
SearchQueryBuilder