Class FieldSearchSort

Provides sorting for a search query by a specified field.

Hierarchy

SearchSort
- FieldSearchSort

Index

Properties

_data

Methods

Properties

Protected _data

_data: any

Methods

descending

descending(descending: boolean): FieldSearchSort

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

missing

missing(missing: boolean): FieldSearchSort

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

mode

mode(mode: string): FieldSearchSort

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

toJSON

toJSON(): any

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

type

type(type: string): FieldSearchSort

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

Static field

field(field: string): FieldSearchSort

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

Static geoDistance

geoDistance(field: string, lat: number, lon: number): GeoDistanceSearchSort

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

Static id

id(): IdSearchSort

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

Static score

score(): ScoreSearchSort

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

Generated using TypeDoc