Type Alias SearchSuggestionsParams

Type Declaration

• Optionalfilters?: {
      areaTypes?: GeographyType[];
      boundingBox?: HasBBox;
      countries?: string[];
      kinds?: SearchSuggestionKind[];
      poiTypes?: POICategory[];
  }

  What the result set is restricted to.

  • OptionalareaTypes?: GeographyType[]

  • OptionalboundingBox?: HasBBox

    Restricts results to a box. How it combines with geoBias is on getSearchSuggestions.

  • Optionalcountries?: string[]

  • Optionalkinds?: SearchSuggestionKind[]

    Which kinds of result to return. Omit it for every kind.

  • OptionalpoiTypes?: POICategory[]

• OptionalgeoBias?: Pick<PointGeoBias, "position">

  The point to search around.

  Remarks

  position ranks nearer results higher without excluding anything, and is what distanceInMeters is measured from. A point only: filters.boundingBox is what restricts the results.

• Optionallimit?: number

  Maximum results in the list.

  Default Value

  5
  Copy

  Remarks

  Capped at 10.

• query: string

  What the user typed. A partial query is fine; so is a complete one.