Class FieldSearchSort

Provides sorting for a search query by a specified field.

Hierarchy

SearchSort
- FieldSearchSort

Index

Properties

Methods

descending missing mode toJSON type field geoDistance id score

Properties

`Protected` _data

_data: any

Methods

descending

descending(descending): FieldSearchSort
Parameters
- descending: boolean
Returns FieldSearchSort
- Defined in lib/searchsort.ts:117

missing

missing(missing): FieldSearchSort
Parameters
- missing: boolean
Returns FieldSearchSort
- Defined in lib/searchsort.ts:112

mode

mode(mode): FieldSearchSort
Parameters
- mode: string
Returns FieldSearchSort
- Defined in lib/searchsort.ts:107

toJSON

toJSON(): any
Returns any
Inherited from SearchSort.toJSON
- Defined in lib/searchsort.ts:19

type

type(type): FieldSearchSort
Parameters
- type: string
Returns FieldSearchSort
- Defined in lib/searchsort.ts:102

`Static` field

field(field): FieldSearchSort
Parameters
- field: string
Returns FieldSearchSort
Inherited from SearchSort.field
- Defined in lib/searchsort.ts:31

`Static` geoDistance

geoDistance(field, lat, lon): GeoDistanceSearchSort
Parameters
- field: string
- lat: number
- lon: number
Returns GeoDistanceSearchSort
Inherited from SearchSort.geoDistance
- Defined in lib/searchsort.ts:35

`Static` id

id(): IdSearchSort
Returns IdSearchSort
Inherited from SearchSort.id
- Defined in lib/searchsort.ts:27

`Static` score

score(): ScoreSearchSort
Returns ScoreSearchSort
Inherited from SearchSort.score
- Defined in lib/searchsort.ts:23

Generated using TypeDoc