1.0.0 • Published 2 years ago

@diasfs/proximity-search v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

proximity-search

Install

npm install @diasfs/proximity-search

Usage

import ProximitySearch from "proximity-search"

let position = {
    latitude: -30.07866404815339,
    longitude: -51.03899232898299
}

let options: {
    neighbors: false,
    precision: 5
}

ProximitySearch.search(position, options)
    .then(results => {
        for(result of results) {
            let { id, name, tags, lat, lng } = result
            console.log({ id, name, tags, lat, lng })
        }
    })

Options

OptionDefaultDescription
endpointhttps://cdn.jsdelivr.net/gh/diasfs/osm-proximity@latest/poi-dataThe endpoint used to search the content. The final url will be the combination of endpoint, precision and the geohash of the position in the precision (https://[endpoint]/[precision]/[geohash].json). The default endpoint will only return results in brazil
precision5The geohash precision used to calculate the position geohash. Wikipedia
neighborsfalseIf true, search in the neighbors areas too