Class PhraseSearchQuery

Represents a phrase search query.

Hierarchy

SearchQuery
- PhraseSearchQuery

Index

Properties

`Protected` _data

_data: any

Methods

boost

boost(boost: number): PhraseSearchQuery
Parameters
- boost: number
Returns PhraseSearchQuery
- Defined in lib/searchquery.ts:788

field

field(field: string): PhraseSearchQuery
Parameters
- field: string
Returns PhraseSearchQuery
- Defined in lib/searchquery.ts:783

toJSON

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

`Static` boolean

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

`Static` booleanField

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

`Static` conjuncts

conjuncts(queries: SearchQuery[]): ConjunctionSearchQuery
Creates a ConjunctionSearchQuery from a set of other SearchQuery's.

Deprecated
Use the multi-argument overload instead.
Parameters
- queries: SearchQuery[]
Returns ConjunctionSearchQuery
Inherited from SearchQuery.conjuncts
- Defined in lib/searchquery.ts:124
conjuncts(...queries: SearchQuery[]): ConjunctionSearchQuery
Creates a ConjunctionSearchQuery from a set of other SearchQuery's.
Parameters
- Rest ...queries: SearchQuery[]
Returns ConjunctionSearchQuery
Inherited from SearchQuery.conjuncts
- Defined in lib/searchquery.ts:129

`Static` dateRange

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

`Static` disjuncts

disjuncts(queries: SearchQuery[]): DisjunctionSearchQuery
Creates a DisjunctionSearchQuery from a set of other SearchQuery's.

Deprecated
Use the multi-argument overload instead.
Parameters
- queries: SearchQuery[]
Returns DisjunctionSearchQuery
Inherited from SearchQuery.disjuncts
- Defined in lib/searchquery.ts:146
disjuncts(...queries: SearchQuery[]): DisjunctionSearchQuery
Creates a DisjunctionSearchQuery from a set of other SearchQuery's.
Parameters
- Rest ...queries: SearchQuery[]
Returns DisjunctionSearchQuery
Inherited from SearchQuery.disjuncts
- Defined in lib/searchquery.ts:151

`Static` docIds

docIds(queries: string[]): DocIdSearchQuery
Creates a DocIdSearchQuery from a set of document-ids.

Deprecated
Use the multi-argument overload instead.
Parameters
- queries: string[]
Returns DocIdSearchQuery
Inherited from SearchQuery.docIds
- Defined in lib/searchquery.ts:176
docIds(...queries: string[]): DocIdSearchQuery
Creates a DocIdSearchQuery from a set of document-ids.
Parameters
- Rest ...queries: string[]
Returns DocIdSearchQuery
Inherited from SearchQuery.docIds
- Defined in lib/searchquery.ts:181

`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
Inherited from SearchQuery.geoBoundingBox
- 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
Inherited from SearchQuery.geoDistance
- Defined in lib/searchquery.ts:215

`Static` geoPolygon

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

`Static` match

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

`Static` matchAll

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

`Static` matchNone

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

`Static` matchPhrase

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

`Static` numericRange

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

`Static` phrase

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

`Static` prefix

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

`Static` queryString

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

`Static` regexp

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

`Static` term

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

`Static` wildcard

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

Class PhraseSearchQuery

Hierarchy

Index

Properties

Methods

Properties

Protected _data

Methods

boost

Parameters

boost: number

Returns PhraseSearchQuery

field

Parameters

field: string

Returns PhraseSearchQuery

toJSON

Returns any

Static boolean

Returns BooleanSearchQuery

Static booleanField

Parameters

val: boolean

Returns BooleanFieldSearchQuery

Static conjuncts

Deprecated

Parameters

queries: SearchQuery[]

Returns ConjunctionSearchQuery

Parameters

Rest ...queries: SearchQuery[]

Returns ConjunctionSearchQuery

Static dateRange

Returns DateRangeSearchQuery

Static disjuncts

Deprecated

Parameters

queries: SearchQuery[]

Returns DisjunctionSearchQuery

Parameters

Rest ...queries: SearchQuery[]

Returns DisjunctionSearchQuery

Static docIds

Deprecated

Parameters

queries: string[]

Returns DocIdSearchQuery

Parameters

Rest ...queries: string[]

Returns DocIdSearchQuery

Static geoBoundingBox

Parameters

tl_lon: number

tl_lat: number

br_lon: number

br_lat: number

Returns GeoBoundingBoxSearchQuery

Static geoDistance

Parameters

lon: number

lat: number

distance: number

Returns GeoDistanceSearchQuery

Static geoPolygon

Parameters

points: GeoPoint[]

Returns GeoPolygonSearchQuery

Static match

Parameters

match: string

Returns MatchSearchQuery

Static matchAll

Returns MatchAllSearchQuery

Static matchNone

Returns MatchNoneSearchQuery

Static matchPhrase

Parameters

phrase: string

Returns MatchPhraseSearchQuery

Static numericRange

`Protected` _data

`Static` boolean

`Static` booleanField

`Static` conjuncts

`Rest` ...queries: SearchQuery[]

`Static` dateRange

`Static` disjuncts

`Rest` ...queries: SearchQuery[]

`Static` docIds

`Rest` ...queries: string[]

`Static` geoBoundingBox

`Static` geoDistance

`Static` geoPolygon

`Static` match

`Static` matchAll

`Static` matchNone

`Static` matchPhrase

`Static` numericRange

`Static` phrase

`Static` prefix

`Static` queryString

`Static` regexp

`Static` term

`Static` wildcard