Class SearchQuery

Provides the ability to specify the query for a search query.

Index

Constructors

Properties

Methods

toJSON boolean booleanField dateRange geoBoundingBox geoDistance geoPolygon match matchAll matchNone matchPhrase numericRange phrase prefix queryString regexp term wildcard

Constructors

constructor

new SearchQuery(data: any): SearchQuery
Parameters
- data: any
Returns SearchQuery
- Defined in lib/searchquery.ts:65

Properties

`Protected`_data

_data: any

Methods

toJSON

toJSON(): any
Returns any
- Defined in lib/searchquery.ts:73

`Static`boolean

boolean(): BooleanSearchQuery
Returns BooleanSearchQuery
- Defined in lib/searchquery.ts:163

`Static`booleanField

booleanField(val: boolean): BooleanFieldSearchQuery
Parameters
- val: boolean
Returns BooleanFieldSearchQuery
- Defined in lib/searchquery.ts:191

`Static`dateRange

dateRange(): DateRangeSearchQuery
Returns DateRangeSearchQuery
- Defined in lib/searchquery.ts:115

`Static`geoBoundingBox

geoBoundingBox(
    tl_lon: number,
    tl_lat: number,
    br_lon: number,
    br_lat: number,
): GeoBoundingBoxSearchQuery
Parameters
- tl_lon: number
- tl_lat: number
- br_lon: number
- br_lat: number
Returns GeoBoundingBoxSearchQuery
- Defined in lib/searchquery.ts:223

`Static`geoDistance

geoDistance(lon: number, lat: number, distance: number): GeoDistanceSearchQuery
Parameters
- lon: number
- lat: number
- distance: number
Returns GeoDistanceSearchQuery
- Defined in lib/searchquery.ts:215

`Static`geoPolygon

geoPolygon(points: GeoPoint[]): GeoPolygonSearchQuery
Parameters
- points: GeoPoint[]
Returns GeoPolygonSearchQuery
- Defined in lib/searchquery.ts:232

`Static`match

match(match: string): MatchSearchQuery
Parameters
- match: string
Returns MatchSearchQuery
- Defined in lib/searchquery.ts:95

`Static`matchAll

matchAll(): MatchAllSearchQuery
Returns MatchAllSearchQuery
- Defined in lib/searchquery.ts:207

`Static`matchNone

matchNone(): MatchNoneSearchQuery
Returns MatchNoneSearchQuery
- Defined in lib/searchquery.ts:211

`Static`matchPhrase

matchPhrase(phrase: string): MatchPhraseSearchQuery
Parameters
- phrase: string
Returns MatchPhraseSearchQuery
- Defined in lib/searchquery.ts:99

`Static`numericRange

numericRange(): NumericRangeSearchQuery
Returns NumericRangeSearchQuery
- Defined in lib/searchquery.ts:111

`Static`phrase

phrase(terms: string[]): PhraseSearchQuery
Parameters
- terms: string[]
Returns PhraseSearchQuery
- Defined in lib/searchquery.ts:199

`Static`prefix

prefix(prefix: string): PrefixSearchQuery
Parameters
- prefix: string
Returns PrefixSearchQuery
- Defined in lib/searchquery.ts:203

`Static`queryString

queryString(query: string): QueryStringSearchQuery
Parameters
- query: string
Returns QueryStringSearchQuery
- Defined in lib/searchquery.ts:107

`Static`regexp

regexp(regexp: string): RegexpSearchQuery
Parameters
- regexp: string
Returns RegexpSearchQuery
- Defined in lib/searchquery.ts:103

`Static`term

term(term: string): TermSearchQuery
Parameters
- term: string
Returns TermSearchQuery
- Defined in lib/searchquery.ts:195

`Static`wildcard

wildcard(wildcard: string): WildcardSearchQuery
Parameters
- wildcard: string
Returns WildcardSearchQuery
- Defined in lib/searchquery.ts:167