Modules@robinpath/geo

@robinpath/geo

0.1.0Public

Geolocation utilities: distance, bearing, geocoding, bounding box, polygon containment, DMS conversion

@robinpath/geo

Geolocation utilities: distance, bearing, geocoding, bounding box, polygon containment, DMS conversion

Category Functions Auth License

Why use this module?

The geo module lets you:

  • Haversine distance between two points
  • Bearing between two points
  • Midpoint between two coordinates
  • Destination point given start, bearing, and distance
  • Bounding box around a point

All functions are callable directly from RobinPath scripts with a simple, consistent API.

Installation

npm install @robinpath/geo

Quick Start

No credentials needed — start using it right away:

geo.bearing 40.7128 -74.0060 51.5074 -0.1278

Available Functions

FunctionDescription
geo.distanceHaversine distance between two points
geo.bearingBearing between two points
geo.midpointMidpoint between two coordinates
geo.destinationDestination point given start, bearing, and distance
geo.boundingBoxBounding box around a point
geo.isInBoundingBoxCheck if point is inside bounding box
geo.toRadiansConvert degrees to radians
geo.toDegreesConvert radians to degrees
geo.toDMSConvert decimal degrees to DMS string
geo.fromDMSParse DMS string to decimal degrees
geo.geocodeForward geocode address to coordinates
geo.reverseGeocodeReverse geocode coordinates to address
geo.polygonCheck if point is inside polygon
geo.areaCalculate polygon area in sq km

Examples

Bearing between two points

geo.bearing 40.7128 -74.0060 51.5074 -0.1278

Midpoint between two coordinates

geo.midpoint 40.7128 -74.0060 51.5074 -0.1278

Destination point given start, bearing, and distance

geo.destination 40.7128 -74.0060 45 100

Integration with RobinPath

import { RobinPath } from "@wiredwp/robinpath";
import Module from "@robinpath/geo";

const rp = new RobinPath();
rp.registerModule(Module.name, Module.functions);
rp.registerModuleMeta(Module.name, Module.functionMetadata);

const result = await rp.executeScript(`
  geo.bearing 40.7128 -74.0060 51.5074 -0.1278
`);

Full API Reference

See MODULE.md for complete documentation including all parameters, return types, error handling, and advanced examples.

Related Modules

License

MIT

Versions (1)

VersionTagPublished
0.1.0latestyesterday
Install
$ robinpath install @robinpath/geo
Version0.1.0
LicenseMIT
Unpacked Size5.7 KB
Versions1
Weekly Downloads0
Total Downloads0
Stars0
Last Publishyesterday
Createdyesterday

Category

utilities