mirror of
https://github.com/HSLdevcom/digitransit-ui
synced 2025-12-20 21:20:50 +01:00
| .. | ||
| index.js | ||
| LICENSE-AGPL.txt | ||
| LICENSE-EUPL.txt | ||
| package.json | ||
| README.md | ||
| test.js | ||
@digitransit-search-util/digitransit-search-util-get-geocoding-results
getGeocodingResults
Parameters
searchStringStringsearchParamsString (Optional) Parameters appended to url, basically box / polygon to restrict search arealangString (Optional) search languagefocusPointObject (Optional) Own Position (PELIAS API)sourcesString (Optional) search sources (e.g OSM, GTFS..)minimalRegexpObject (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