@unmap/routing 0.0.2 → 0.1.1

package/README.md

@@ -0,0 +1,30 @@
+# @unmap/routing
+
+Typed client for the [unmap](https://unmap.dev) routing API: point-to-point routes and
+travel-time isochrones over the Canadian road graph, for driving, cycling, and walking. No map
+dependency; works in Node and the browser.
+
+```bash
+npm i @unmap/routing
+```
+
+```ts
+import { Router } from '@unmap/routing'
+
+const router = new Router({ key: 'um_live_...' })
+
+const route = await router.route([-114.07, 51.05], [-113.99, 51.05], { mode: 'auto' })
+route.distanceMeters   // integer metres
+route.durationSeconds  // integer seconds
+route.geometry         // GeoJSON LineString, [lng, lat] coordinates
+
+const bands = await router.isochrone([-114.07, 51.05], { minutes: [10, 20], mode: 'pedestrian' })
+bands.features         // one GeoJSON polygon per minute value
+```
+
+Coordinates are always `[lng, lat]`. `mode` is `'auto' | 'bicycle' | 'pedestrian'` and defaults
+to `'auto'`; `minutes` is required and takes up to four values of at most 120 minutes. Both methods accept an
+`AbortSignal` as `signal`. A non-2xx response throws a `RouterError` carrying the HTTP `status`.
+
+Parameters, response shapes, and error bodies are documented at
+[unmap.dev/docs/routing-api](https://unmap.dev/docs/routing-api).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unmap/routing",
-  "version": "0.0.2",
+  "version": "0.1.1",
   "description": "Typed client for the unmap routing API (route + isochrone)",
   "type": "module",
   "main": "./dist/index.js",
@@ -20,7 +20,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@unmap/core": "0.0.1"
+    "@unmap/core": "0.1.1"
   },
   "devDependencies": {
     "tsup": "^8.3.0",