Skip to content

Commit

Permalink
docs: Fix incorrect property description (#1429)
Browse files Browse the repository at this point in the history
This text is a mistake. `aroundRadius` is not for IP address searches
only.

Copied the text from [here](https://www.algolia.com/doc/api-reference/api-parameters/aroundRadius/).
  • Loading branch information
ccchapman authored Oct 13, 2022
1 parent b906cbf commit ba59b68
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion packages/client-search/src/types/SearchOptions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ export type SearchOptions = {
readonly aroundLatLngViaIP?: boolean;

/**
* Search for entries around a given location automatically computed from the requester’s IP address.
* Define the maximum radius for a geo search (in meters).
*/
readonly aroundRadius?: number | 'all';

Expand Down

0 comments on commit ba59b68

Please sign in to comment.