valhalla-ts

valhalla api client
Report Bug · Request Feature

About The Project

Easy to use, fully typed http client for valhalla routing service.

Installation

yarn install @iwpnd/valhalla-ts

# or

npm install @iwpnd/valhalla-ts

Usage

Either use your own valhalla instances url, pull an image of valhalla that includes Andorra routing tiles.

docker run --rm -p 8002:8002 ghcr.io/iwpnd/valhalla-andorra:latest

import { Valhalla } from '@iwpnd/valhalla-ts';

const valhalla = new Valhalla('https://localhost:8002');

/*
 * Request a route for a specific modality
 * traversing each of the provided `locations`
 * in order.
 */
const route = await valhalla.route({
    locations: [
        { lat: 42.505497, lon: 1.528883 },
        { lat: 42.51276, lon: 1.53527 },
    ],
    costing: 'bicycle',
});

/*
 * Request a route for a specific modality
 * traversing each of the provided `locations`
 * in an optimized order.
 */
const optimizedRoute = await valhalla.optimizedRoute({
    locations: [
        { lat: 42.505497, lon: 1.528883 },
        { lat: 42.505497, lon: 1.528884 },
        { lat: 42.51276, lon: 1.53527 },
    ],
    costing: 'auto',
});

/*
 * Request to match a set of input coordinates to
 * a corresponding node on the road network.
 */
const traceRoute = await valhalla.traceRoute({
    shape: [
        { lat: 42.505497, lon: 1.528883 },
        { lat: 42.51276, lon: 1.53527 },
    ],
    shape_match: 'map_snap',
    costing: 'taxi',
});

/*
 * Request to generate isochrones around a
 * request location.
 */
const isochrone = await valhalla.isochrone({
    locations: [{ lat: 42.505497, lon: 1.528883 }],
    costing: 'bicycle',
    contours: [
        { time: 5, color: '2596be' },
        { time: 10, color: 'be2596' },
        { time: 15, color: '96be25' },
    ],
    polygons: true,
});

Roadmap

• valhalla client
• fully typed
• add usage section to docs
• request helper
• load balancing

Contributing

Contributions are neither expected nor encouraged. If you for whatever reason you want to contribute here, create an issue describing your problem first. Unsolicited PRs are going to be deleted straight up.

If we evaluated that you're in the right repository, are of a clear state of mind and have cause to do what you wanna do, please follow the steps below.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feat/my-amazing-feature)
3. Commit your Changes (git commit -m 'feat: some amazing feature')
4. Push to the Branch (git push origin feat/my-amazing-feature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Benjamin Ramser - @iwpnd - [email protected]

Project Link: https://github.com/iwpnd/valhalla-ts

Acknowledgments

• valhalla
• gis-ops