habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

WIP better generated API reference docs

Browse Source
This commit is contained in:
Josh Mock
2025-05-27 15:30:21 -05:00
parent a1dc6f55ee
commit b627037af1
3745 changed files with 30211 additions and 15508 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/reference/api/QueryDslGeoDistanceQueryKeys.md Normal file
View File

@ -0,0 +1,8 @@
## Interface `QueryDslGeoDistanceQueryKeys`
| Name | Type | Description |
| - | - | - |
| `distance_type` | [GeoDistanceType](./GeoDistanceType.md) | How to compute the distance. Set to `plane` for a faster calculation that's inaccurate on long distances and close to the poles. |
| `distance` | [Distance](./Distance.md) | The radius of the circle centred on the specified location. Points which fall into this circle are considered to be matches. |
| `ignore_unmapped` | boolean | Set to `true` to ignore an unmapped field and not match any documents for this query. Set to `false` to throw an exception if the field is not mapped. |
| `validation_method` | [QueryDslGeoValidationMethod](./QueryDslGeoValidationMethod.md) | Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude. Set to `COERCE` to also try to infer correct latitude or longitude. |