Skip to content

Commit ba59b68

Browse files
authored
docs: Fix incorrect property description (#1429)
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/).
1 parent b906cbf commit ba59b68

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

packages/client-search/src/types/SearchOptions.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ export type SearchOptions = {
273273
readonly aroundLatLngViaIP?: boolean;
274274

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

0 commit comments

Comments
 (0)