Type Alias SearchSuggestionsParams

Type Declaration

• Optionalfilters?: {
      areaTypes?: NonNullable<PlaceFilters["geographyTypes"]>;
      boundingBox?: HasBBox;
      countries?: NonNullable<GeographicFilters["countries"]>;
      kinds?: SearchSuggestionKind[];
      poiTypes?: NonNullable<PlaceFilters["poiCategories"]>;
  }

  What the result set is restricted to.

  • OptionalareaTypes?: NonNullable<PlaceFilters["geographyTypes"]>

    Geography types to restrict area results to.

  • OptionalboundingBox?: HasBBox

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

  • Optionalcountries?: NonNullable<GeographicFilters["countries"]>

    Countries to restrict to, as ISO 3166-1 alpha-2 or alpha-3 codes.

  • Optionalkinds?: SearchSuggestionKind[]

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

  • OptionalpoiTypes?: NonNullable<PlaceFilters["poiCategories"]>

    POI categories to restrict place results to. A parent code also matches its sub-categories.

• 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. It is only a point. filters.boundingBox restricts the results.

• Optionallimit?: number

  Maximum results in the list.

  Default Value

  5
  Copy

  Remarks

  Capped at 10.

• query: string

  What the user typed, which can be a partial or a complete query.