digitransit-ui/digitransit-search-util/packages/digitransit-search-util-get-geocoding-results/README.md

@digitransit-search-util/digitransit-search-util-get-geocoding-results

getGeocodingResults

Parameters

• searchString String
• searchParams String (Optional) Parameters appended to url, basically box / polygon to restrict search area
• lang String (Optional) search language
• focusPoint Object (Optional) Own Position (PELIAS API)
• sources String (Optional) search sources (e.g OSM, GTFS..)
• minimalRegexp Object (Optional) Regexp for testing

Examples

digitransit-search-util.getGeocodingResults("result");
//= e.g. {text:"result"}

Returns String Results in JSON form

---

This module is part of the Digitransit-ui project. It is maintained in the HSLdevcom/digitransit-ui repository, where you can create PRs and issues.

Installation

Install this module individually:

$ npm install @digitransit-search-util/digitransit-search-util-get-geocoding-results

Or install the Digitransit-util module that includes it as a function:

$ npm install @digitransit-util/digitransit-util