where
v1.0.2
Published
Geographical utilities for location-based Node.js applications
Maintainers
Readme
Geographical utilities for Node.js
This library provides some basic utilities for building location-based applications.
Some features
Start by importing where:
import { Point, Geocoder } from 'where';Given two points, the Helsinki-Malmi and Helsinki-Vantaa airports:
const malmi = new Point(60.254558, 25.042828);
const vantaa = new Point(60.317222, 24.963333);Calculating distances between points (in kilometers):
malmi.distanceTo(vantaa); // 8.2Calculating bearing and direction from a point to another:
malmi.bearingTo(vantaa); // 329
malmi.directionTo(vantaa); // NWPretty printing to human-readable coordinates:
malmi.toString(); // 60°15′16″N 25°2′34″EConverting human-readable addresses to coordinates (geocoding, powered by OpenStreetMap Nominatim):
const geocoder = new Geocoder();
geocoder.toPoint({
display_name: 'Helsinki',
country_code: 'fi'
})
.then((points) => {
points[0].lat; // 60.1666277
points[0].lon; // 24.9435079
});Converting coordinates to human-readable addresses (reverse geocoding, powered by OpenStreetMap Nominatim):
geocoder.fromPoint(malmi)
.then((location) => {
location.address.road; // Malminkaari
location.address.city; // Helsinki
});Creating bounding boxes for a given radius (coming soon):
// 20km bounding box
const bbox = malmi.getBBox(20);
malmi.directionTo(bbox.sw); // SWInstallation
$ npm install where --saveRequires Node.js 20 or later. The library is published as an ECMAScript module.
Running tests
$ npm install
$ npm testDevelopment
This library is provided under the MIT license. Contributions to the project are welcome on GitHub. Notable changes are described in the changelog.
Initially this has been a Node.js port of my earlier PHP library.
