Skip to content

Home / node / Commands / type-aliases / GeoSearchResultOptions @valkey/valkey-glide


@valkey/valkey-glide / Commands / GeoSearchResultOptions

Type Alias: GeoSearchResultOptions

GeoSearchResultOptions = GeoSearchCommonResultOptions & object

Optional parameters for geosearch command which defines what should be included in the search results and how results should be ordered and limited.

Type declaration

withCoord?

optional withCoord: boolean

Include the coordinate of the returned items.

withDist?

optional withDist: boolean

Include the distance of the returned items from the specified center point. The distance is returned in the same unit as specified for the searchBy argument.

withHash?

optional withHash: boolean

Include the geohash of the returned items.